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 },
540 * \var lyx::FuncCode lyx::SCREEN_DOWN
541 * \li Action: Moves the cursor one page in downward direction.
542 * \li Syntax: screen-down
545 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
547 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
548 * \li Action: Moves the cursor one page in upward direction.
549 * \li Syntax: screen-up
552 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
554 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
555 * \li Action: Moves the cursor one screen in downward direction adding the current
556 position to the selection.
557 * \li Syntax: screen-down-select
560 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
562 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
563 * \li Action: Moves the cursor one page in upward direction adding the current
564 position to the selection.
565 * \li Syntax: screen-up-select
568 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
570 * \var lyx::FuncCode lyx::LFUN_SCROLL
571 * \li Action: Scroll the buffer view.
572 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
573 * \li Syntax: scroll <TYPE> <QUANTITY>
574 * \li Params: <TYPE>: line|page\n
575 <QUANTITY>: up|down|<number>
576 * \li Origin: Abdelrazak Younes, Dec 27 2007
579 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
581 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
582 * \li Action: Recenters the screen on the current cursor position.
583 * \li Syntax: screen-recenter
586 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
588 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
590 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
591 * \li Action: Moves the cursor one position logically backwards.
592 * \li Notion: This is not the action which should be bound to the arrow keys,
593 because backwards may be left or right, depending on the
594 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
595 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
596 * \li Syntax: char-backward
599 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
601 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
602 * \li Action: Moves the cursor one position logically backwards, adding
603 traversed position to the selection.
604 * \li Notion: See also #LFUN_CHAR_BACKWARD.
605 * \li Syntax: char-backward-select
608 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
610 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
611 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
612 * \li Syntax: char-delete-backward
615 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
617 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
618 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
619 * \li Syntax: char-delete-forward
622 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
624 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
625 * \li Action: Moves the cursor one position logically forward.
626 * \li Notion: This is not the action which should be bound to the arrow keys,
627 because forward may be left or right, depending on the language.
628 The arrow keys should be bound to #LFUN_CHAR_LEFT or
629 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
630 * \li Syntax: char-forward
633 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
635 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
636 * \li Action: Moves the cursor one position logically forward, adding
637 traversed position to the selection.
638 * \li Notion: See also #LFUN_CHAR_FORWARD.
639 * \li Syntax: char-forward-select
642 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
644 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
645 * \li Action: Moves the cursor one position "to the left".
646 * \li Notion: This is the action which should be taken when the "left" key
647 is pressed. Generally, it moves the cursor one position to the
648 left. However, in Bidi text this become slightly more
649 complicated, and there are different modes of cursor movement.
650 In "visual mode", this moves left, plain and simple. In "logical
651 mode", movement is logically forward in RTL paragraphs, and
652 logically backwards in LTR paragraphs.
653 * \li Syntax: char-left
656 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
658 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
659 * \li Action: Moves the cursor one position "to the left", adding
660 traversed position to the selection.
661 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
662 * \li Syntax: char-left-select
665 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
667 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
668 * \li Action: Moves the cursor one position "to the right".
669 * \li Notion: This is the action which should be taken when the "right" key
670 is pressed. Generally, it moves the cursor one position to the
671 right. However, in Bidi text this become slightly more
672 complicated, and there are different modes of cursor movement.
673 In "visual mode", this moves right, plain and simple. In "logical
674 mode", movement is logically forward in LTR paragraphs, and
675 logically backwards in RTL paragraphs.
676 * \li Syntax: char-right
679 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
681 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
682 * \li Action: Moves the cursor one position "to the right", adding
683 traversed position to the selection.
684 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
685 * \li Syntax: char-right-select
688 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
691 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
692 * \li Action: Moves the cursor to the logically previous beginning of a word.
693 * \li Notion: This is not the action which should be bound to the arrow keys,
694 because backwards may be left or right, depending on the
695 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
696 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
697 * \li Syntax: word-backward
700 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
702 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
703 * \li Action: Moves the cursor to the logically previous beginning of a word,
704 adding the logically traversed text to the selection.
705 * \li Notion: See also #LFUN_WORD_BACKWARD.
706 * \li Syntax: word-backward-select
709 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
711 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
712 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
713 * \li Syntax: word-delete-backward
716 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
718 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
719 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
720 * \li Syntax: word-delete-forward
723 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
725 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
726 * \li Action: Search for a given string in forward direction.
727 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
728 * \li Syntax: word-find-forward [<STRING>]
729 * \li Origin: Etienne, 16 Feb 1998
732 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
734 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
735 * \li Action: Search for a given string in backward direction.
736 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
737 * \li Syntax: word-find-backward [<STRING>]
738 * \li Origin: Etienne, 20 Feb 1998
741 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
743 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
744 * \li Action: Search for next occurence of a string.
745 * \li Syntax: word-find [<DATA>]
746 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
747 If no parameter is given, search with last find-dialog
748 data is used for search (i.e. find-next).
749 * \li Origin: poenitz, Jan 7 2004
752 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
754 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
755 * \li Action: Replace a string in the document.
756 * \li Syntax: word-replace [<DATA>]
757 * \li Params: <DATA>: data is of the form
760 <casesensitive> <matchword> <all> <forward>"
761 * \li Origin: poenitz, Jan 7 2004
764 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
766 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
767 * \li Action: Moves the cursor to the logically next beginning of a word.
768 * \li Notion: This is not the action which should be bound to the arrow keys,
769 because forward may be left or right, depending on the language.
770 The arrow keys should be bound to #LFUN_WORD_LEFT or
771 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
772 * \li Syntax: word-forward
775 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
777 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
778 * \li Action: Moves the cursor to the logically next beginning of a word,
779 adding the logically traversed text to the selection.
780 * \li Notion: See also #LFUN_WORD_FORWARD.
781 * \li Syntax: word-forward-select
784 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
786 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
787 * \li Action: Moves the cursor to the next beginning of a word "on the left".
788 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
789 "left" key is pressed. Generally, it moves the cursor to the
790 next beginning of a word on the left. However, in Bidi text this
791 become slightly more complicated, and there are different modes
792 of cursor movement. In "visual mode", this moves left, plain and
793 simple. In "logical mode", movement is logically forward in RTL
794 paragraphs, and logically backwards in LTR paragraphs.
795 * \li Syntax: word-left
796 * \li Origin: dov, 28 Oct 2007
799 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
801 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
802 * \li Action: Moves the cursor to the next beginning of a word "on the left",
803 adding *logically* traversed text to the selection.
804 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
805 * \li Syntax: word-left-select
806 * \li Origin: dov, 28 Oct 2007
809 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
811 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
812 * \li Action: Moves the cursor to the next beginning of a word "on the right".
813 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
814 "right" key is pressed. Generally, it moves the cursor to the
815 next beginning of a word on the right. However, in Bidi text
816 this become slightly more complicated, and there are different
817 modes of cursor movement. In "visual mode", this moves right,
818 plain and simple. In "logical mode", movement is logically
819 forward in LTR paragraphs, and logically backwards in RTL
821 * \li Syntax: word-right
822 * \li Origin: dov, 28 Oct 2007
825 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
827 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
828 * \li Action: Moves the cursor to the next beginning of a word "on the right",
829 adding *logically* traversed text to the selection.
830 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
831 * \li Syntax: word-right-select
832 * \li Origin: dov, 28 Oct 2007
835 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
836 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
838 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
839 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
840 or the letter on the cursor position.
841 * \li Syntax: word-capitalize
844 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
846 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
847 * \li Action: Change the words in the selection or from the cursor position
848 to the end of word to the upper case.
849 * \li Syntax: word-upcase
852 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
854 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
855 * \li Action: Change the words in the selection or from the cursor position
856 to the end of word to the lower case.
857 * \li Syntax: word-lowcase
860 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
862 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
863 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
864 * \li Syntax: thesaurus-entry
865 * \li Origin: Levon, 20 Jul 2001
868 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
869 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
870 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
871 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
872 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
874 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
875 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
876 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
877 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
878 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
880 * \var lyx::FuncCode lyx::LFUN_COPY
881 * \li Action: Copies to the clipboard the last edit.
885 { LFUN_COPY, "copy", ReadOnly, Edit },
887 * \var lyx::FuncCode lyx::LFUN_CUT
888 * \li Action: Cuts to the clipboard.
892 { LFUN_CUT, "cut", Noop, Edit },
894 * \var lyx::FuncCode lyx::LFUN_PASTE
895 * \li Action: Pastes from the active clipboard.
899 { LFUN_PASTE, "paste", Noop, Edit },
900 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
902 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
903 * \li Action: Pastes the material currently selected.
904 * \li Syntax: primary-selection-paste
907 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
909 * \var lyx::FuncCode lyx::LFUN_UNDO
910 * \li Action: Undoes the last edit.
914 { LFUN_UNDO, "undo", Noop, Edit },
916 * \var lyx::FuncCode lyx::LFUN_REDO
917 * \li Action: Redoes the last thing undone.
921 { LFUN_REDO, "redo", Noop, Edit },
923 * \var lyx::FuncCode lyx::LFUN_REPEAT
924 * \li Action: Repeat the given command.
925 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
926 * \li Author: poenitz, 27 Oct 2003
929 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
931 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
932 * \li Action: Transposes the character at the cursor with the one before it.
933 * \li Syntax: chars-transpose
934 * \li Author: Lgb, 25 Apr 2001
937 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
939 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
940 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
941 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
944 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
945 * \li Action: Toggles the bold font (selection-wise).
946 * \li Syntax: font-bold
949 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
951 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
952 * \li Action: Toggles the typewriter family font (selection-wise).
953 * \li Syntax: font-typewriter
956 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
958 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
959 * \li Action: Toggles underline in the font (selection-wise).
960 * \li Syntax: font-underline
963 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
965 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
966 * \li Action: Toggles the emphasis font style (selection-wise).
967 * \li Syntax: font-emph
970 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
972 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
973 * \li Action: Toggles Noun text style font (selection-wise).
974 * \li Syntax: font-noun
977 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
979 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
980 * \li Action: Toggles Roman family font (selection-wise).
981 * \li Syntax: font-roman
984 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
986 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
987 * \li Action: Toggles Sans Serif family font (selection-wise).
988 * \li Syntax: font-sans
991 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
993 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
994 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
995 * \li Syntax: font-frak
996 * \li Origin: vermeer, 10 Jan 2002
999 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1001 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1002 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1003 * \li Syntax: font-ital
1004 * \li Origin: vermeer, 10 Jan 2002
1007 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1009 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1010 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1011 * \li Syntax: font-default
1014 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1015 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
1016 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
1017 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1018 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1020 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1021 * \li Action: Returns the info about the current font.
1022 * \li Syntax: font-state
1025 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1027 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
1028 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1029 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1030 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1033 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1034 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1035 * \li Syntax: layout <LAYOUT>
1036 * \li Params: <LAYOUT>: the layout to use
1039 { LFUN_LAYOUT, "layout", Noop, Layout },
1041 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1042 * \li Action: Launches the paragraph settings dialog.
1043 * \li Syntax: layout-paragraph
1046 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1048 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1049 * \li Action: Launches the tabular settings dialog.
1050 * \li Syntax: layout-tabular
1051 * \li Origin: Jug, 31 Jul 2000
1054 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1056 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1057 * \li Action: Displays list of layout choices.
1058 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1059 dropbox allowing for choice of layout.
1060 * \li Syntax: drop-layouts-choice
1063 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1065 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1066 * \li Action: Clears the module list.
1067 * \li Notion: Clears the list of included modules for the current buffer.
1068 * \li Syntax: layout-modules-clear
1069 * \li Origin: rgh, 25 August 2007
1072 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1074 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1075 * \li Action: Adds a module.
1076 * \li Notion: Adds a module to the list of included modules for the current buffer.
1077 * \li Syntax: layout-module-add <MODULE>
1078 * \li Params: <MODULE>: the module to be added
1079 * \li Origin: rgh, 25 August 2007
1082 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1084 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1085 * \li Action: Reloads layout information.
1086 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1087 recognizing any changes that have been made to layout files on the fly.
1088 This is intended to be used only by layout developers and should not be
1089 used when one is trying to do actual work.
1090 * \li Syntax: layout-reload
1091 * \li Origin: rgh, 3 September 2007
1094 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1096 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1097 * \li Action: Sets the text class for the current buffer.
1098 * \li Syntax: textclass-apply <TEXTCLASS>
1099 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1100 the filename, minus the ".layout" extension.
1103 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1105 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1106 * \li Action: Loads information for a textclass from disk.
1107 * \li Syntax: textclass-load <TEXTCLASS>
1108 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1109 the filename, minus the ".layout" extension.
1112 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1115 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1116 * \li Action: Disable selecting of text-region.
1117 * \li Syntax: mark-off
1120 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1122 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1123 * \li Action: Enable selecting of text-region.
1124 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1125 * \li Syntax: mark-on
1128 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1130 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1131 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1132 * \li Syntax: mark-toggle
1133 * \li Origin: poenitz, May 5 2006
1136 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1138 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1139 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1140 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1141 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1142 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1143 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1144 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1145 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1146 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1147 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1148 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1149 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1150 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1152 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1153 * \li Action: Toggles numbering of the current formula line.
1154 * \li Notion: Must be in display formula mode.
1155 * \li Syntax: math-number-line-toggle
1156 * \li Origin: Alejandro 18 Jun 1996
1159 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1161 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1162 * \li Action: Toggles numbering/labeling of the current formula.
1163 * \li Notion: Must be in display formula mode.
1164 * \li Syntax: math-number-toggle
1165 * \li Origin: Alejandro 4 Jun 1996
1168 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1169 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1170 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1172 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1173 * \li Action: Unfold a Math Macro.
1174 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1176 * \li Syntax: math-macro-unfold
1177 * \li Origin: sts, 06 January 2008
1180 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1182 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1183 * \li Action: Fold a Math Macro.
1184 * \li Notion: Fold the Math Macro the cursor is in if it was
1185 unfolded, i.e. displayed as \foo before.
1186 * \li Syntax: math-macro-fold
1187 * \li Origin: sts, 06 January 2008
1190 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1192 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1193 * \li Action: Add a parameter.
1194 * \li Notion: Add a parameter to a Math Macro.
1195 * \li Params: <NUM>: The number of the parameter behind which the new one
1196 will be added (1 for the first, i.e. use 0 for add a
1197 parameter at the left), defaults to the last one.
1198 * \li Syntax: math-macro-add-param <NUM>
1199 * \li Origin: sts, 06 January 2008
1202 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1204 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1205 * \li Action: Remove the last parameter.
1206 * \li Notion: Remove the last parameter of a Math Macro and
1207 remove its value in all instances of the macro
1209 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1210 the first), defaults to the last one.
1211 * \li Syntax: math-macro-remove-param <NUM>
1212 * \li Origin: sts, 06 January 2008
1215 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1217 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1218 * \li Action: Append a greedy parameter.
1219 * \li Notion: Append a greedy parameter to a Math Macro which
1220 eats the following mathed cell in every instance of
1221 the macro in the buffer.
1222 * \li Syntax: math-macro-append-greedy-param
1223 * \li Origin: sts, 06 January 2008
1226 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1228 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1229 * \li Action: Remove a greedy parameter.
1230 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1231 out the values of it in every instance of the macro
1232 in the buffer. If it is an optional parameter the [valud]
1234 * \li Syntax: math-macro-remove-greedy-param
1235 * \li Origin: sts, 06 January 2008
1238 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1240 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1241 * \li Action: Make a parameter optional.
1242 * \li Notion: Turn the first non-optional parameter of a Math Macro
1243 into an optional parameter with a default value.
1244 * \li Syntax: math-macro-make-optional
1245 * \li Origin: sts, 06 January 2008
1248 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1250 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1251 * \li Action: Make a parameter non-optional.
1252 * \li Notion: Turn the last optional parameter of a Math Macro
1253 into a non-optional parameter. The default value is
1254 remembered to be reused later if the user changes his mind.
1255 * \li Syntax: math-macro-make-nonoptional
1256 * \li Origin: sts, 06 January 2008
1259 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1261 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1262 * \li Action: Add an optional parameter.
1263 * \li Notion: Insert an optional parameter just behind the
1264 already existing optional parameters.
1265 * \li Syntax: math-macro-add-optional-param
1266 * \li Origin: sts, 06 January 2008
1269 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1271 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1272 * \li Action: Remove the last optional parameter.
1273 * \li Notion: Remove the last optional parameter of a Math Macro and
1274 remove it in all the instances of the macro in the buffer.
1275 * \li Syntax: math-macro-remove-optional-param
1276 * \li Origin: sts, 06 January 2008
1279 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1281 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1282 * \li Action: Add a greedy optional parameter.
1283 * \li Notion: Add a greedy optional parameter which eats the value
1284 from the following cells in mathed which are in the [value]
1286 * \li Syntax: math-macro-add-greedy-optional-param
1287 * \li Origin: sts, 06 January 2008
1290 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1292 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1293 * \li Action: Only active in Math Macro definition.
1294 * \li Notion: Dummy function which is only active in a Math Macro definition.
1295 It's used to toggle the Math Macro toolbar if the cursor moves
1296 into a Math Macro definition.
1297 * \li Syntax: in-mathmacrotemplate
1298 * \li Origin: sts, 06 January 2008
1301 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1304 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1305 * \li Action: Moves the current paragraph downwards in the document.
1306 * \li Syntax: paragraph-move-down
1307 * \li Origin: Edwin, 8 Apr 2006
1310 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1312 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1313 * \li Action: Moves the current paragraph upwards in the document.
1314 * \li Syntax: paragraph-move-up
1315 * \li Origin: Edwin, 8 Apr 2006
1318 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1321 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1322 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1323 in upward direction.
1324 * \li Syntax: paragraph-up
1325 * \li Origin: Asger, 1 Oct 1996
1328 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1330 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1331 * \li Action: Move the cursor and select the text to the next paragraph (or
1332 begining of the current one) in upward direction.
1333 * \li Syntax: paragraph-up-select
1334 * \li Origin: Asger, 1 Oct 1996
1337 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1339 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1340 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1341 in downward direction.
1342 * \li Syntax: paragraph-down
1343 * \li Origin: Asger, 1 Oct 1996
1346 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1348 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1349 * \li Action: Move the cursor and select the text to the next paragraph (or
1350 begining of the current one) in downward direction.
1351 * \li Syntax: paragraph-down-select
1352 * \li Origin: Asger, 1 Oct 1996
1355 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1357 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1358 * \li Action: Jump to a paragraph given by its id number and optionally the
1359 desired position within the paragraph.
1360 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1361 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1362 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1363 * \li Params: <PAR_ID_NUMBER>: paragraph id
1364 <POSITION_IN_PAR>: desired position within the paragraph
1365 * \li Origin: Dekel, 26 Aug 2000
1368 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1370 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1371 * \li Action: Breaks the current paragraph at the current location.
1372 * \li Syntax: break-paragraph
1375 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1377 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1378 * \li Action: Breaks the current paragraph at the current location.
1379 * \li Notion: Removes the selection.
1380 * \li Syntax: break-paragraph [<LAYOUT>]
1381 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1382 to default layout) when the cursor is at the end of
1386 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1388 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1389 * \li Action: Change paragraph settings.
1390 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1391 This function only modifies, and does not override, existing settings.
1392 Note that the "leftindent" indent setting is deprecated.
1393 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1394 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1395 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1396 <ALIGN>: \\align block|left|right|center|default\n
1397 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1398 * \li Origin: rgh, Aug 15 2007
1401 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1403 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1404 * \li Action: Change paragraph settings.
1405 * \li Notion: Overwrite all nonspecified settings to the default ones.
1406 Use paragraph-params lfun if you don't want to overwrite others settings.
1407 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1408 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1409 * \li Origin: leeming, 30 Mar 2004
1412 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1413 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1416 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1417 * \li Action: Move the current group in the upward direction in the
1418 structure of the document.
1419 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1420 the whole substructure of the group.
1421 * \li Syntax: outline-up
1422 * \li Origin: Vermeer, 23 Mar 2006
1425 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1427 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1428 * \li Action: Move the current group in the downward direction in the
1429 structure of the document.
1430 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1431 the whole substructure of the group.
1432 * \li Syntax: outline-down
1433 * \li Origin: Vermeer, 23 Mar 2006
1436 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1438 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1439 * \li Action: Moves the current group in the downward direction in the
1440 hierarchy of the document structure.
1441 * \li Notion: Part -> Chapter -> Section -> etc.
1442 * \li Syntax: outline-in
1443 * \li Origin: Vermeer, 23 Mar 2006
1446 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1448 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1449 * \li Action: Moves the current group in the upward direction in the
1450 hierarchy of the document structure.
1451 * \li Notion: Part <- Chapter <- Section <- etc.
1452 * \li Syntax: outline-out
1453 * \li Origin: Vermeer, 23 Mar 2006
1456 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1458 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1459 * \li Action: Edit the inset at cursor with an external application,
1460 * if one is attributed.
1461 * \li Syntax: inset-edit [<INSET_PARAMS>]
1462 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1463 Currently only the filename will be considered.
1464 * \li Origin: JSpitzm, 27 Apr 2006
1467 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1469 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1470 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1471 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1472 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1473 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1475 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1476 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1477 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1478 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1479 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1481 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1482 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1483 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1484 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1485 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1486 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1487 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1488 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1491 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1492 * \li Action: Apply data for an inset.
1493 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1494 be applied. This is either changed to #LFUN_INSET_MODIFY or
1495 #LFUN_INSET_INSERT depending on the context where it is called.
1496 * \li Syntax: inset-apply <ARGS>
1497 * \li Params: See #LFUN_INSET_INSERT .
1500 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1502 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1503 * \li Action: Dissolve the current inset into text.
1504 * \li Syntax: inset-dissolve [<INSET>]
1505 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1506 is dissolved. For example "dissolve" entry in the charstyles
1507 sub-menu should only dissolve the charstyle inset, even if the
1508 cursor is inside several nested insets of different type.\n
1509 For values see #lyx::InsetLayout::lyxtype_ .
1510 * \li Author: JSpitz, 7 Aug 2006
1513 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1515 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1516 * \li Action: Insert new inset (type given by the parameters).
1517 * \li Syntax: inset-insert <INSET> <ARGS>
1518 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1519 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1520 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1522 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1523 where <label name> is the name of the referenced label and
1524 <Format> is one of the following: \n
1525 ref -- <reference> \n
1526 eqref -- (<reference>) \n
1527 pageref -- <page> \n
1528 vpageref -- on <page> \n
1529 vref -- <reference> on <page> \n
1530 prettyref -- Formatted reference
1533 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1535 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1536 * \li Action: Modify existing inset.
1537 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1538 bibtex, ert, command, graphics, note, space, vspace, tabular,
1539 bibitem, inlude, ref insets.
1540 * \li Syntax: inset-modify <INSET> <ARGS>
1541 * \li Params: See #LFUN_INSET_INSERT for further details.
1544 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1546 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1547 * \li Action: Modify the inset at cursor position, if there is one.
1548 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1549 bibtex, ert, command, graphics, note, space, vspace, tabular,
1550 bibitem, inlude, ref insets.
1551 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1552 * \li Params: See #LFUN_INSET_INSERT for further details.
1553 * \li Origin: JSpitzm, 23 Mar 2008
1556 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1557 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1559 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1560 * \li Action: Open the inset's properties dialog.
1561 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1562 * \li Syntax: inset-settings <INSET>
1563 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1566 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1568 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1569 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1570 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1571 be entered. Also cf. #LFUN_INSET_SETTINGS.
1572 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1573 bibtex, ert, command, graphics, note, space, vspace, tabular,
1574 bibitem, inlude, ref insets.
1575 * \li Syntax: next-inset-toggle <ARG>
1576 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1577 * \li Origin: leeming, 30 Mar 2004
1580 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1582 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1583 * \li Action: Toggles the collapsable inset we are currently in.
1584 * \li Syntax: inset-toggle [<ARG>]
1585 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1586 open/close/toggle are for collapsable insets. close can be currently used
1587 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1588 assign is for branch inset.
1589 * \li Origin: lasgouttes, 19 Jul 2001
1592 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1594 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1595 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1596 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1597 * \li Syntax: all-insets-toggle <STATE> <INSET>
1598 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1599 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1600 * \li Origin: leeming, 30 Mar 2004
1603 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1605 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1606 * \li Action: Unify all graphics insets with the one given as an parameter.
1607 * \li Notion: This is internally used for synchronize certain group of graphics insets.
1608 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1609 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1610 (syntax can be seen in .lyx files).
1611 * \li Origin: sanda, 6 May 2008
1614 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1616 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1617 * \li Action: Set the group for the graphics inset on the cursor position.
1618 * \li Syntax: set-graphics-group [<GROUP>]
1619 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1620 the graphics inset is removed from the current group.
1621 * \li Origin: sanda, 6 May 2008
1624 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1627 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1628 * \li Action: Moves the cursor out of the current slice, going forward.
1629 * \li Notion: Cursor movement within an inset may be different than cursor
1630 movement in the surrounding text. This action should be called
1631 automatically by the cursor movement within the inset, when
1632 movement within the inset has ceased (reached the end of the
1633 last paragraph, for example), in order to move correctly
1634 back into the surrounding text.
1637 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1639 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1640 * \li Action: Moves the cursor out of the current slice, going backwards.
1641 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1644 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1646 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1647 * \li Action: Moves the cursor out of the current slice, going right.
1648 * \li Notion: See also #LFUN_FINISHED_FORWARD
1651 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1653 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1654 * \li Action: Moves the cursor out of the current slice, going left.
1655 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1658 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1660 { LFUN_LANGUAGE, "language", Noop, Edit },
1663 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1664 * \li Action: Goto a label.
1665 * \li Syntax: label-goto [<LABEL>]
1666 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1667 is on cursor position, Bookmark 0 is saved and
1668 cursor moves to the position of referenced label.
1669 * \li Origin: Ale, 6 Aug 1997
1672 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1674 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1675 * \li Action: Inserts label to text or displayed formula.
1676 * \li Syntax: label-insert [<LABEL>]
1677 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1678 name will be opened.
1681 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1683 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1684 * \li Action: Go to the next label or cross-reference.
1685 * \li Syntax: reference-next
1686 * \li Origin: Dekel, 14 Jan 2001
1689 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1692 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1693 * \li Action: Goto a bookmark.
1694 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1695 if necessary. Note that bookmarsk are saved per-session, not
1697 * \li Syntax: bookmark-goto <NUMBER>
1698 * \li Params: <NUMBER>: the number of the bookmark to restore.
1699 * \li Origin: Dekel, 27 January 2001
1702 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1704 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1705 * \li Action: Save a bookmark.
1706 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1707 must be between 1 and 9, inclusive. Note that bookmarks are
1708 saved per-session, not per file.
1709 * \li Syntax: bookmark-save <NUMBER>
1710 * \li Params: <NUMBER>: the number of the bookmark to save.
1711 * \li Origin: Dekel, 27 January 2001
1714 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1716 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1717 * \li Action: Clears the list of saved bookmarks.
1718 * \li Syntax: bookmark-clear
1719 * \li Origin: bpeng, 31 October 2006
1722 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1725 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1726 * \li Action: Open the given help file according to the language setting.
1727 * \li Syntax: help-open <FILE>[.lyx]
1728 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1729 * \li Author: Jug, 27 Jun 1999
1732 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1734 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1735 * \li Action: Terminates the current LyX instance.
1736 * \li Notion: Terminates the current LyX instance, asking whether to save
1737 modified documents, etc.
1738 * \li Syntax: lyx-quit
1741 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1743 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1744 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1745 * \li Notion: Skiping "auto" when allowauto is false.
1746 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1747 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1748 minibuffer|review|view/update|math_panels
1749 * \li Origin: Edwin, 21 May 2007
1752 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1754 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1755 * \li Action: Opens the menu given by its name.
1756 * \li Syntax: menu-open <NAME>
1757 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1760 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1762 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1763 * \li Action: Various UI visibility-toggling actions.
1764 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1765 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1766 menubar : Toggle visibility of the menubar.\n
1767 scrollbar : Toggle visibility of the scrollbar.\n
1768 frame : Toggle visibility of the frames around editing window.\n
1769 fullscreen : Toggle fullscreen mode. This also covers calling the
1770 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1771 custom tweaks of the toolbars should be used.
1772 * \li Origin: ps, 9 Feb 2007
1775 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1778 * \var lyx::FuncCode lyx::WINDOW_NEW
1779 * \li Action: Creates new empty LyX window.
1780 * \li Notion: Already opened documents from the previous window can be found under View menu.
1781 * \li Syntax: window-new [<GEOMETRY>]
1782 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1783 accepted only on Windows platform.
1784 * \li Origin: Abdel, 21 Oct 2006
1787 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1789 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1790 * \li Action: Closes the current LyX window.
1791 * \li Syntax: window-close
1792 * \li Origin: Abdel, 23 Oct 2006
1795 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1798 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1799 * \li Action: Creates another split view of current buffer.
1800 * \li Notion: All split views act in the same way indpendently.
1801 * \li Syntax: split-view <vertical|horizontal>
1802 * \li Params: horizontal : The work areas are laid out side by side.\n
1803 vertical : The work areas laid out vertically.\n
1804 * \li Origin: abdel, 20 Feb 2008
1807 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1810 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1811 * \li Action: Close the current tab group.
1812 * \li Notion: This only closes the work areas, not the buffer themselves.
1813 The still opened buffers can be visualized in another tab group.
1814 * \li Syntax: close-tab-group
1815 * \li Origin: abdel, 21 Feb 2008
1818 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1819 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1820 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1821 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1822 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1823 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1824 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1826 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1827 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1828 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1829 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1830 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1832 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1833 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1834 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1835 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1837 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1838 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1839 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1841 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1842 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1843 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1844 * \li Origin: Edmar, 23 Dec 1998
1847 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1848 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1850 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1851 * \li Action: Sets the cursor position based on the editing area coordinates
1852 (similar as clicking on that point with left mouse button).
1853 * \li Syntax: server-set-xy <X> <Y>
1856 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1858 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1859 * \li Action: Returns the coordinates of cursor position in the editing area.
1860 * \li Syntax: server-get-xy
1863 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1866 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1867 * \li Action: Generates the code (literate programming).
1868 * \li Notion: Latex file with extension \literate_extension is generated.
1869 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1870 \build_error_filter to process the compilation error messages. \n
1871 In case you want to process your literate file with a script, or some other program,
1872 just insert in your lyxrc file an entry with:\n
1873 \build_command "my_script my_arguments" \n
1874 The \build_error_filter differs from the \literate_error_filter only in that the
1875 former will identify error messages from your compiler.
1876 * \li Syntax: build-program
1879 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1882 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1883 * \li Action: Saves the current buffer to a temporary file.
1884 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1885 is called automatically by LyX, to "autosave" the current buffer.
1886 * \li Syntax: buffer-auto-save
1889 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1891 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1892 * \li Action: Loads the given child document.
1893 * \li Notion: The current document is treated as a parent.
1894 * \li Syntax: buffer-child-open <FILE>
1895 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1896 * \li Origin: Ale, 28 May 1997
1899 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1901 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1902 * \li Action: Runs chktex for the current document.
1903 * \li Syntax: buffer-chktex
1904 * \li Origin: Asger, 30 Oct 1997
1907 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1909 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1910 * \li Action: Toggles compression of the current document on/off.
1911 * \li Syntax: buffer-toggle-compression
1912 * \li Origin: bpeng, 27 Apr 2006
1915 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1917 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1918 * \li Action: Closes the current buffer.
1919 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1920 if the buffer has been modified.
1921 * \li Syntax: buffer-close
1924 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1926 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1927 * \li Action: Exports the current buffer (document) to the given format.
1928 * \li Syntax: buffer-export <FORMAT>
1929 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1930 can find in Tools->Preferences->File formats->Format.
1931 Usual format you will enter is "pdf2" (pdflatex),
1932 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1933 In case of "custom" you will be asked for a format you
1934 want to start from and for the command that you want to
1935 apply to this format. Internally the control is then passed
1936 to #LFUN_BUFFER_EXPORT_CUSTOM.
1937 * \li Origin: Lgb, 29 Jul 1997
1940 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1942 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1943 * \li Action: Exports the current buffer (document) from the given format using
1944 the given command on it.
1945 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1946 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1947 intermediate file).\n
1948 <COMMAND> this command will be launched on the file. Note that you can
1949 use "$$FName" string to qualify the intermediate file.
1950 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1951 * \li Origin: leeming, 27 Mar 2004
1954 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1956 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1957 * \li Action: Prints the current document.
1958 * \li Notion: Many settings can be given via the preferences dialog.
1959 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1960 * \li Params: <TARGET> is either "printer" or "file".\n
1961 <TARGER-NAME> is either "default" or file name or printer name.\n
1962 <COMMAND> command ensuring the printing job.
1963 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1964 * \li Origin: leeming, 28 Mar 2004
1967 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1969 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1970 * \li Action: Import a given file as a lyx document.
1971 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1972 defined convertors in preferences. Look into File->Import menu to get
1973 an idea of the currently active import formats.
1974 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1975 * \li Origin: Asger, 24 Jul 1998
1978 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1980 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1981 * \li Action: Creates a new buffer (that is, document).
1982 * \li Notion: Implicit path can be set in Preferences dialog.
1983 * \li Syntax: buffer-new [<FILE>]
1984 * \li Params: <FILE>: filename of created file with absolute path.
1987 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1989 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1990 * \li Action: Creates a new buffer (that is, document) from a template.
1991 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1992 Template will be asked for via Open-dialog.
1993 * \li Syntax: buffer-new-template [<FILE>]
1994 * \li Params: <FILE>: filename of created file with absolute path.
1997 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1999 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2000 * \li Action: Reverts opened document.
2001 * \li Syntax: buffer-reload
2002 * \li Origin: Asger, 2 Feb 1997
2005 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2007 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2008 * \li Action: Switch to the given buffer.
2009 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2010 document in different LyX windows.
2011 * \li Syntax: buffer-new-template <BUFFER>
2012 * \li Params: <BUFFER>: already opened document which is to be shown.
2015 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2017 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2018 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2019 * \li Syntax: buffer-toggle-read-only
2020 * \li Origin: Lgb, 27 May 1997
2023 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2025 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2026 * \li Action: Displays current buffer in chosen format.
2027 * \li Notion: Displays the contents of the current buffer in the chosen
2028 format, for example, PDF or DVI. This runs the necessary
2029 converter, calls the defined viewer, and so forth.
2030 * \li Syntax: buffer-view <FORMAT>
2031 * \li Params: <FORMAT>: The format to display, where this is one of the
2032 formats defined (in the current GUI) in the
2033 Tools>Preferences>File Formats dialog.
2036 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2038 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2039 * \li Action: Exports the current document and put the result into the
2040 temporary directory.
2041 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2042 the output will be rewriten - updated. This is useful in case your viewer
2043 is able to detect such changes (e.g. ghostview for postscript).
2044 * \li Syntax: buffer-update <FORMAT>
2045 * \li Params: <FORMAT>: The format to display, where this is one of the
2046 formats defined (in the current GUI) in the
2047 Tools>Preferences>File Formats dialog.
2048 * \li Origin: Dekel, 5 Aug 2000
2051 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2054 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2055 * \li Action: Saves the current buffer.
2056 * \li Notion: Saves the current buffer to disk, using the filename that
2057 is already associated with the buffer, asking for one if
2058 none is yet assigned.
2059 * \li Syntax: buffer-write
2062 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2064 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2065 * \li Action: Rename and save current buffer.
2066 * \li Syntax: buffer-write-as <FILENAME>
2067 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2068 is with respect to the original location of the buffer/file.
2071 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2073 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2074 * \li Action: Save all changed documents.
2075 * \li Syntax: buffer-write-all
2076 * \li Origin: rgh, gpothier 6 Aug 2007
2079 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2081 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2082 * \li Action: Switch to the next opened document.
2083 * \li Notion: Note that this does not necessarily mean next in tabbar
2084 (for full list see View menu).
2085 * \li Syntax: buffer-next
2088 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2090 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2091 * \li Action: Switch to the previous opened document.
2092 * \li Syntax: buffer-previous
2095 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2097 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2098 * \li Action: When run from a child document, this updates (exports) document built
2099 from the master buffer. If a master is not found, it updates the
2101 * \li Syntax: master-buffer-update
2102 * \li Author: Tommaso, 20 Sep 2007
2105 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2107 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2108 * \li Action: When run from a child document, this command shows a preview built
2109 from the master buffer. If a master is not found, it previews the
2111 * \li Syntax: master-buffer-view
2112 * \li Author: Tommaso, 20 Sep 2007
2115 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2117 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2118 * \li Action: Set language of the current document.
2119 * \li Syntax: buffer-language <LANG>
2120 * \li Params: <LANG>: language name. See lib/languages for list.
2121 * \li Author: leeming, 30 Mar 2004
2124 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2126 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2127 * \li Action: Save the current document settings as default.
2128 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2129 * \li Syntax: buffer-save-as-default [<ARGS>]
2130 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2131 you can find in document header of usual .lyx file.
2132 * \li Author: leeming, 30 Mar 2004
2135 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2137 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2138 * \li Action: Apply the given settings to the current document.
2139 * \li Syntax: buffer-params-apply [<ARGS>]
2140 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2141 you can find in document header of usual .lyx file.
2142 * \li Author: leeming, 30 Mar 2004
2145 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2148 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2149 * \li Action: Inserts another LyX file.
2150 * \li Syntax: file-insert [<FILE>]
2151 * \li Params: <FILE>: Filename to be inserted.
2154 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2156 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2157 * \li Action: Inserts plain text file.
2158 * \li Syntax: file-insert-plaintext [<FILE>]
2159 * \li Params: <FILE>: Filename to be inserted.
2160 * \li Origin: CFO-G, 19 Nov 1997
2163 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2165 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2166 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2167 * \li Syntax: file-insert-plaintext-para [<FILE>]
2168 * \li Params: <FILE>: Filename to be inserted.
2169 * \li Origin: Levon, 14 Feb 2001
2172 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2174 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2175 * \li Action: Open LyX document.
2176 * \li Syntax: file-open [<FILE>]
2177 * \li Params: <FILE>: Filename to be opened.
2180 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2183 * \var lyx::FuncCode lyx::LFUN_CALL
2184 * \li Action: Executes a command defined in a .def file.
2185 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2186 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2187 where <NAME> is the name of the new command and <LFUN> is the lfun code
2188 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2189 \\def_file "FileName" allows to include another .def file. \n
2190 This is particularly useful in connection with toolbar buttons:
2191 Since the name of the button image for this lfun is
2192 lib/images/commands/<NAME>.png this is the way to assign an image
2193 to a complex command-sequence.
2194 * \li Syntax: call <NAME>
2195 * \li Params: <NAME>: Name of the command that must be called.
2196 * \li Origin: broider, 2 Oct 2007
2199 { LFUN_CALL, "call", NoBuffer, System },
2201 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2202 * \li Action: Simulate halting Meta key (Alt key on PCs).
2203 * \li Notion: Used for buffer editation not for GUI control.
2204 * \li Syntax: meta-prefix
2207 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2209 * \var lyx::FuncCode lyx::LFUN_CANCEL
2210 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2211 * \li Syntax: cancel
2214 { LFUN_CANCEL, "cancel", NoBuffer, System },
2217 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2218 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2219 * \li Notion: Usually bound to M-x shortcut.
2220 * \li Syntax: command-execute
2223 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2224 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2226 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2227 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2228 * \li Syntax: command-sequence <CMDS>
2229 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2230 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2231 * \li Origin: Andre', 11 Nov 1999
2234 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2236 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2237 * \li Action: Shows message in statusbar (for script purposes).
2238 * \li Syntax: message <STRING>
2239 * \li Origin: Lgb, 8 Apr 2001
2242 { LFUN_MESSAGE, "message", NoBuffer, System },
2244 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2245 * \li Action: Save user preferences.
2246 * \li Syntax: preferences-save
2247 * \li Origin: Lgb, 27 Nov 1999
2250 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2252 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2253 * \li Action: Reconfigure the automatic settings.
2254 * \li Syntax: reconfigure
2255 * \li Origin: Asger, 14 Feb 1997
2258 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2260 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2261 * \li Action: Apply the given settings to user preferences.
2262 * \li Syntax: lyxrc-apply <SETTINGS>
2263 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2264 to get an idea which commands to use and their syntax.
2265 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2268 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2270 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2271 * \li Action: Determine whether keep cursor inside the editing window regardless
2272 the scrollbar movement.
2273 * \li Syntax: toggle-cursor-follows-scrollbar
2274 * \li Origin: ARRae, 2 Dec 1997
2277 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2279 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2280 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2281 * \li Notion: A new color entry is created if the color is unknown.
2282 Color names can be stored as a part of user settings.
2283 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2284 * \li Origin: SLior, 11 Jun 2000
2287 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2289 * \var lyx::FuncCode lyx::LFUN_STATISTICS
2290 * \li Action: Count the statistics (number of words and characters)
2291 in the document or in the given selection.
2292 * \li Notion: Note that this function gives the number of words/chars written,
2293 not the number of characters which will be typeset.
2294 * \li Syntax: statistics
2295 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2298 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2300 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2301 * \li Action: Show the inline completion at the cursor position.
2302 * \li Syntax: completion-inline
2303 * \li Origin: sts, Feb 19 2008
2306 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2308 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2309 * \li Action: Show the completion popup at the cursor position.
2310 * \li Syntax: completion-popup
2311 * \li Origin: sts, Feb 19 2008
2314 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2316 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2317 * \li Action: Try to complete the word or command at the cursor position.
2318 * \li Syntax: completion-complete
2319 * \li Origin: sts, Feb 19 2008
2322 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2324 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2325 * \li Action: Activate the branch
2326 * \li Syntax: branch-activate <BRANCH>
2327 * \li Params: <BRANCH>: The branch to activate
2328 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2329 could be used to export a pdf with the answers branch included
2330 without one's having to open LyX and activate the branch manually.
2331 * \li Origin: rgh, 27 May 2008
2334 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2336 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2337 * \li Action: De-activate the branch
2338 * \li Syntax: branch-deactivate <BRANCH>
2339 * \li Params: <BRANCH>: The branch to deactivate
2340 * \li Origin: rgh, 27 May 2008
2343 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2345 { LFUN_NOACTION, "", Noop, Hidden }
2346 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2349 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2350 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2357 LyXAction::LyXAction()
2363 // Returns an action tag from a string.
2364 FuncRequest LyXAction::lookupFunc(string const & func) const
2366 string const func2 = trim(func);
2368 if (func2.empty()) {
2369 return FuncRequest(LFUN_NOACTION);
2373 string const arg = split(func2, cmd, ' ');
2375 func_map::const_iterator fit = lyx_func_map.find(cmd);
2377 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2381 string const LyXAction::getActionName(FuncCode action) const
2383 info_map::const_iterator const it = lyx_info_map.find(action);
2384 return it != lyx_info_map.end() ? it->second.name : string();
2388 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2390 info_map::const_iterator const it = lyx_info_map.find(action);
2391 return it != lyx_info_map.end() ? it->second.type : Hidden;
2395 bool LyXAction::funcHasFlag(FuncCode action,
2396 LyXAction::func_attrib flag) const
2398 info_map::const_iterator ici = lyx_info_map.find(action);
2400 if (ici == lyx_info_map.end()) {
2401 LYXERR0("action: " << action << " is not known.");
2402 LASSERT(false, /**/);
2405 return ici->second.attrib & flag;
2409 LyXAction::const_func_iterator LyXAction::func_begin() const
2411 return lyx_func_map.begin();
2415 LyXAction::const_func_iterator LyXAction::func_end() const
2417 return lyx_func_map.end();