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 },
484 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
485 * \li Action: Inserts Index entry.
486 * \li Notion: It automatically takes the word on the cursor position.
487 * \li Syntax: index-insert
488 * \li Origin: Angus, 3 Aug 2000
491 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
493 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
494 * \li Action: Inserts list of Index entries on a new page.
495 * \li Syntax: index-print
496 * \li Origin: Lgb, 27 Feb 1997
499 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
502 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
503 * \li Action: Inserts Nomenclature entry.
504 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
505 * \li Syntax: nomencl-insert [<SYMBOL>]
506 * \li Origin: Ugras, 4 Nov 2006
509 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
511 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
512 * \li Action: Inserts list of Nomenclature entries.
513 * \li Syntax: nomenclature-print
514 * \li Origin: Ugras, 4 Nov 2006
517 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
520 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
521 * \li Action: Inserts Note on the current cursor postion,
522 move selection inside the inset.
523 * \li Syntax: note-insert [<TYPE>]
524 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
527 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
529 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
530 * \li Action: Moves the cursor to the begining of next Note inset.
531 * \li Syntax: note-next
534 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
536 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
537 * \li Action: Inserts a line break or new line.
538 * \li Syntax: newline-insert [<ARG>]
539 * \li Params: <ARG>: <newline|linebreak> default: newline
540 * \li Origin: JSpitzm, 25 Mar 2008
543 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
546 * \var lyx::FuncCode lyx::LFUN_ESCAPE
547 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
549 * \li Origin: Lgb, 17 May 2001
552 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
554 * \var lyx::FuncCode lyx::LFUN_DOWN
555 * \li Action: Moves the cursor one line in downward direction.
559 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
561 * \var lyx::FuncCode lyx::LFUN_UP
562 * \li Action: Moves the cursor one line in upward direction.
566 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
568 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
569 * \li Action: Moves the cursor one line in downward direction adding the current
570 position to the selection.
571 * \li Syntax: down-select
574 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
576 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
577 * \li Action: Moves the cursor one line in upward direction adding the current
578 position to the selection.
579 * \li Syntax: up-select
582 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
584 * \var lyx::FuncCode lyx::SCREEN_DOWN
585 * \li Action: Moves the cursor one page in downward direction.
586 * \li Syntax: screen-down
589 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
591 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
592 * \li Action: Moves the cursor one page in upward direction.
593 * \li Syntax: screen-up
596 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
598 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
599 * \li Action: Moves the cursor one screen in downward direction adding the current
600 position to the selection.
601 * \li Syntax: screen-down-select
604 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
606 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
607 * \li Action: Moves the cursor one page in upward direction adding the current
608 position to the selection.
609 * \li Syntax: screen-up-select
612 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
614 * \var lyx::FuncCode lyx::LFUN_SCROLL
615 * \li Action: Scroll the buffer view.
616 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
617 * \li Syntax: scroll <TYPE> <QUANTITY>
618 * \li Params: <TYPE>: line|page\n
619 <QUANTITY>: up|down|<number>
620 * \li Origin: Abdelrazak Younes, Dec 27 2007
623 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
625 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
626 * \li Action: Recenters the screen on the current cursor position.
627 * \li Syntax: screen-recenter
630 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
633 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
634 * \li Action: Moves the cursor one position logically backwards.
635 * \li Notion: This is not the action which should be bound to the arrow keys,
636 because backwards may be left or right, depending on the
637 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
638 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
639 * \li Syntax: char-backward
642 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
644 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
645 * \li Action: Moves the cursor one position logically backwards, adding
646 traversed position to the selection.
647 * \li Notion: See also #LFUN_CHAR_BACKWARD.
648 * \li Syntax: char-backward-select
651 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
653 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
654 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
655 * \li Syntax: char-delete-backward
658 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
660 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
661 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
662 * \li Syntax: char-delete-forward
665 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
667 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
668 * \li Action: Moves the cursor one position logically forward.
669 * \li Notion: This is not the action which should be bound to the arrow keys,
670 because forward may be left or right, depending on the language.
671 The arrow keys should be bound to #LFUN_CHAR_LEFT or
672 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
673 * \li Syntax: char-forward
676 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
678 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
679 * \li Action: Moves the cursor one position logically forward, adding
680 traversed position to the selection.
681 * \li Notion: See also #LFUN_CHAR_FORWARD.
682 * \li Syntax: char-forward-select
685 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
687 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
688 * \li Action: Moves the cursor one position "to the left".
689 * \li Notion: This is the action which should be taken when the "left" key
690 is pressed. Generally, it moves the cursor one position to the
691 left. However, in Bidi text this become slightly more
692 complicated, and there are different modes of cursor movement.
693 In "visual mode", this moves left, plain and simple. In "logical
694 mode", movement is logically forward in RTL paragraphs, and
695 logically backwards in LTR paragraphs.
696 * \li Syntax: char-left
699 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
701 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
702 * \li Action: Moves the cursor one position "to the left", adding
703 traversed position to the selection.
704 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
705 * \li Syntax: char-left-select
708 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
710 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
711 * \li Action: Moves the cursor one position "to the right".
712 * \li Notion: This is the action which should be taken when the "right" key
713 is pressed. Generally, it moves the cursor one position to the
714 right. However, in Bidi text this become slightly more
715 complicated, and there are different modes of cursor movement.
716 In "visual mode", this moves right, plain and simple. In "logical
717 mode", movement is logically forward in LTR paragraphs, and
718 logically backwards in RTL paragraphs.
719 * \li Syntax: char-right
722 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
724 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
725 * \li Action: Moves the cursor one position "to the right", adding
726 traversed position to the selection.
727 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
728 * \li Syntax: char-right-select
731 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
734 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
735 * \li Action: Moves the cursor to the logically previous beginning of a word.
736 * \li Notion: This is not the action which should be bound to the arrow keys,
737 because backwards may be left or right, depending on the
738 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
739 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
740 * \li Syntax: word-backward
743 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
745 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
746 * \li Action: Moves the cursor to the logically previous beginning of a word,
747 adding the logically traversed text to the selection.
748 * \li Notion: See also #LFUN_WORD_BACKWARD.
749 * \li Syntax: word-backward-select
752 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
754 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
755 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
756 * \li Syntax: word-delete-backward
759 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
761 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
762 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
763 * \li Syntax: word-delete-forward
766 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
768 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
769 * \li Action: Search for a given string in forward direction.
770 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
771 * \li Syntax: word-find-forward [<STRING>]
772 * \li Origin: Etienne, 16 Feb 1998
775 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
777 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
778 * \li Action: Search for a given string in backward direction.
779 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
780 * \li Syntax: word-find-backward [<STRING>]
781 * \li Origin: Etienne, 20 Feb 1998
784 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
786 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
787 * \li Action: Search for next occurence of a string.
788 * \li Syntax: word-find [<DATA>]
789 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
790 If no parameter is given, search with last find-dialog
791 data is used for search (i.e. find-next).
792 * \li Origin: poenitz, Jan 7 2004
795 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
797 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
798 * \li Action: Replace a string in the document.
799 * \li Syntax: word-replace [<DATA>]
800 * \li Params: <DATA>: data is of the form
803 <casesensitive> <matchword> <all> <forward>"
804 * \li Origin: poenitz, Jan 7 2004
807 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
809 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
810 * \li Action: Moves the cursor to the logically next beginning of a word.
811 * \li Notion: This is not the action which should be bound to the arrow keys,
812 because forward may be left or right, depending on the language.
813 The arrow keys should be bound to #LFUN_WORD_LEFT or
814 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
815 * \li Syntax: word-forward
818 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
820 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
821 * \li Action: Moves the cursor to the logically next beginning of a word,
822 adding the logically traversed text to the selection.
823 * \li Notion: See also #LFUN_WORD_FORWARD.
824 * \li Syntax: word-forward-select
827 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
829 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
830 * \li Action: Moves the cursor to the next beginning of a word "on the left".
831 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
832 "left" key is pressed. Generally, it moves the cursor to the
833 next beginning of a word on the left. However, in Bidi text this
834 become slightly more complicated, and there are different modes
835 of cursor movement. In "visual mode", this moves left, plain and
836 simple. In "logical mode", movement is logically forward in RTL
837 paragraphs, and logically backwards in LTR paragraphs.
838 * \li Syntax: word-left
839 * \li Origin: dov, 28 Oct 2007
842 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
844 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
845 * \li Action: Moves the cursor to the next beginning of a word "on the left",
846 adding *logically* traversed text to the selection.
847 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
848 * \li Syntax: word-left-select
849 * \li Origin: dov, 28 Oct 2007
852 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
854 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
855 * \li Action: Moves the cursor to the next beginning of a word "on the right".
856 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
857 "right" key is pressed. Generally, it moves the cursor to the
858 next beginning of a word on the right. However, in Bidi text
859 this become slightly more complicated, and there are different
860 modes of cursor movement. In "visual mode", this moves right,
861 plain and simple. In "logical mode", movement is logically
862 forward in LTR paragraphs, and logically backwards in RTL
864 * \li Syntax: word-right
865 * \li Origin: dov, 28 Oct 2007
868 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
870 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
871 * \li Action: Moves the cursor to the next beginning of a word "on the right",
872 adding *logically* traversed text to the selection.
873 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
874 * \li Syntax: word-right-select
875 * \li Origin: dov, 28 Oct 2007
878 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
880 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
881 * \li Action: Puts the word where the cursor stands into the selection.
882 * \li Syntax: word-select
883 * \li Author: Andre, 11 Sep 2002
886 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
888 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
889 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
890 or the letter on the cursor position.
891 * \li Syntax: word-capitalize
894 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
896 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
897 * \li Action: Change the words in the selection or from the cursor position
898 to the end of word to the upper case.
899 * \li Syntax: word-upcase
902 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
904 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
905 * \li Action: Change the words in the selection or from the cursor position
906 to the end of word to the lower case.
907 * \li Syntax: word-lowcase
910 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
912 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
913 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
914 * \li Syntax: thesaurus-entry
915 * \li Origin: Levon, 20 Jul 2001
918 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
920 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
921 * \li Action: Move the cursor to the beginning of the document.
922 * \li Syntax: buffer-begin
925 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
927 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
928 * \li Action: Move the cursor to the beginning of the document adding the
929 traversed text to the selection.
930 * \li Syntax: buffer-begin-select
933 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
935 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
936 * \li Action: Move the cursor to the end of the document.
937 * \li Syntax: buffer-end
940 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
942 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
943 * \li Action: Move the cursor to the end of the document adding the
944 traversed text to the selection.
945 * \li Syntax: buffer-end-select
948 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
951 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
952 * \li Action: Move the cursor to the begining of the (screen) line.
953 * \li Syntax: line-begin
956 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
958 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
959 * \li Action: Move the cursor to the beginning of the (screen) line adding the
960 traversed text to the selection.
961 * \li Syntax: line-begin-select
964 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
966 * \var lyx::FuncCode lyx::LFUN_LINE_END
967 * \li Action: Move the cursor to the end of the (screen) line.
968 * \li Syntax: line-end
971 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
973 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
974 * \li Action: Move the cursor to the end of the (screen) line adding the
975 traversed text to the selection.
976 * \li Syntax: line-end-select
979 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
981 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
982 * \li Action: Deletes the letters to the end of the (screen) line or
983 deletes the selection.
984 * \li Syntax: line-delete-forward
987 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
989 * \var lyx::FuncCode lyx::LFUN_COPY
990 * \li Action: Copies to the clipboard the last edit.
994 { LFUN_COPY, "copy", ReadOnly, Edit },
996 * \var lyx::FuncCode lyx::LFUN_CUT
997 * \li Action: Cuts to the clipboard.
1001 { LFUN_CUT, "cut", Noop, Edit },
1003 * \var lyx::FuncCode lyx::LFUN_PASTE
1004 * \li Action: Pastes from the active clipboard.
1008 { LFUN_PASTE, "paste", Noop, Edit },
1009 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1011 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1012 * \li Action: Pastes the material currently selected.
1013 * \li Syntax: primary-selection-paste
1016 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1018 * \var lyx::FuncCode lyx::LFUN_UNDO
1019 * \li Action: Undoes the last edit.
1023 { LFUN_UNDO, "undo", Noop, Edit },
1025 * \var lyx::FuncCode lyx::LFUN_REDO
1026 * \li Action: Redoes the last thing undone.
1030 { LFUN_REDO, "redo", Noop, Edit },
1032 * \var lyx::FuncCode lyx::LFUN_REPEAT
1033 * \li Action: Repeat the given command.
1034 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1035 * \li Author: poenitz, 27 Oct 2003
1038 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1040 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1041 * \li Action: Transposes the character at the cursor with the one before it.
1042 * \li Syntax: chars-transpose
1043 * \li Author: Lgb, 25 Apr 2001
1046 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1048 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1049 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1050 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
1053 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1054 * \li Action: Toggles the bold font (selection-wise).
1055 * \li Syntax: font-bold
1058 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1060 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1061 * \li Action: Toggles the typewriter family font (selection-wise).
1062 * \li Syntax: font-typewriter
1065 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1067 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1068 * \li Action: Toggles underline in the font (selection-wise).
1069 * \li Syntax: font-underline
1072 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1074 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1075 * \li Action: Toggles the emphasis font style (selection-wise).
1076 * \li Syntax: font-emph
1079 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1081 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1082 * \li Action: Toggles Noun text style font (selection-wise).
1083 * \li Syntax: font-noun
1086 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1088 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1089 * \li Action: Toggles Roman family font (selection-wise).
1090 * \li Syntax: font-roman
1093 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1095 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1096 * \li Action: Toggles Sans Serif family font (selection-wise).
1097 * \li Syntax: font-sans
1100 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1102 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1103 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1104 * \li Syntax: font-frak
1105 * \li Origin: vermeer, 10 Jan 2002
1108 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1110 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1111 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1112 * \li Syntax: font-ital
1113 * \li Origin: vermeer, 10 Jan 2002
1116 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1118 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1119 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1120 * \li Syntax: font-default
1123 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1124 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
1125 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
1126 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1127 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1129 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1130 * \li Action: Returns the info about the current font.
1131 * \li Syntax: font-state
1134 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1136 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
1137 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1138 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1139 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1142 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1143 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1144 * \li Syntax: layout <LAYOUT>
1145 * \li Params: <LAYOUT>: the layout to use
1148 { LFUN_LAYOUT, "layout", Noop, Layout },
1150 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1151 * \li Action: Launches the paragraph settings dialog.
1152 * \li Syntax: layout-paragraph
1155 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1157 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1158 * \li Action: Launches the tabular settings dialog.
1159 * \li Syntax: layout-tabular
1160 * \li Origin: Jug, 31 Jul 2000
1163 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1165 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1166 * \li Action: Displays list of layout choices.
1167 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1168 dropbox allowing for choice of layout.
1169 * \li Syntax: drop-layouts-choice
1172 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1174 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1175 * \li Action: Clears the module list.
1176 * \li Notion: Clears the list of included modules for the current buffer.
1177 * \li Syntax: layout-modules-clear
1178 * \li Origin: rgh, 25 August 2007
1181 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1183 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1184 * \li Action: Adds a module.
1185 * \li Notion: Adds a module to the list of included modules for the current buffer.
1186 * \li Syntax: layout-module-add <MODULE>
1187 * \li Params: <MODULE>: the module to be added
1188 * \li Origin: rgh, 25 August 2007
1191 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1193 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1194 * \li Action: Reloads layout information.
1195 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1196 recognizing any changes that have been made to layout files on the fly.
1197 This is intended to be used only by layout developers and should not be
1198 used when one is trying to do actual work.
1199 * \li Syntax: layout-reload
1200 * \li Origin: rgh, 3 September 2007
1203 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1205 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1206 * \li Action: Sets the text class for the current buffer.
1207 * \li Syntax: textclass-apply <TEXTCLASS>
1208 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1209 the filename, minus the ".layout" extension.
1212 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1214 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1215 * \li Action: Loads information for a textclass from disk.
1216 * \li Syntax: textclass-load <TEXTCLASS>
1217 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1218 the filename, minus the ".layout" extension.
1221 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1224 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1225 * \li Action: Disable selecting of text-region.
1226 * \li Syntax: mark-off
1229 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1231 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1232 * \li Action: Enable selecting of text-region.
1233 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1234 * \li Syntax: mark-on
1237 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1239 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1240 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1241 * \li Syntax: mark-toggle
1242 * \li Origin: poenitz, May 5 2006
1245 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1247 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1248 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1249 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1250 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1251 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1252 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1253 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1254 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1255 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1256 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1257 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1258 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1259 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1261 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1262 * \li Action: Toggles numbering of the current formula line.
1263 * \li Notion: Must be in display formula mode.
1264 * \li Syntax: math-number-line-toggle
1265 * \li Origin: Alejandro 18 Jun 1996
1268 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1270 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1271 * \li Action: Toggles numbering/labeling of the current formula.
1272 * \li Notion: Must be in display formula mode.
1273 * \li Syntax: math-number-toggle
1274 * \li Origin: Alejandro 4 Jun 1996
1277 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1278 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1279 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1281 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1282 * \li Action: Unfold a Math Macro.
1283 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1285 * \li Syntax: math-macro-unfold
1286 * \li Origin: sts, 06 January 2008
1289 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1291 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1292 * \li Action: Fold a Math Macro.
1293 * \li Notion: Fold the Math Macro the cursor is in if it was
1294 unfolded, i.e. displayed as \foo before.
1295 * \li Syntax: math-macro-fold
1296 * \li Origin: sts, 06 January 2008
1299 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1301 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1302 * \li Action: Add a parameter.
1303 * \li Notion: Add a parameter to a Math Macro.
1304 * \li Params: <NUM>: The number of the parameter behind which the new one
1305 will be added (1 for the first, i.e. use 0 for add a
1306 parameter at the left), defaults to the last one.
1307 * \li Syntax: math-macro-add-param <NUM>
1308 * \li Origin: sts, 06 January 2008
1311 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1313 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1314 * \li Action: Remove the last parameter.
1315 * \li Notion: Remove the last parameter of a Math Macro and
1316 remove its value in all instances of the macro
1318 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1319 the first), defaults to the last one.
1320 * \li Syntax: math-macro-remove-param <NUM>
1321 * \li Origin: sts, 06 January 2008
1324 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1326 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1327 * \li Action: Append a greedy parameter.
1328 * \li Notion: Append a greedy parameter to a Math Macro which
1329 eats the following mathed cell in every instance of
1330 the macro in the buffer.
1331 * \li Syntax: math-macro-append-greedy-param
1332 * \li Origin: sts, 06 January 2008
1335 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1337 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1338 * \li Action: Remove a greedy parameter.
1339 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1340 out the values of it in every instance of the macro
1341 in the buffer. If it is an optional parameter the [valud]
1343 * \li Syntax: math-macro-remove-greedy-param
1344 * \li Origin: sts, 06 January 2008
1347 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1349 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1350 * \li Action: Make a parameter optional.
1351 * \li Notion: Turn the first non-optional parameter of a Math Macro
1352 into an optional parameter with a default value.
1353 * \li Syntax: math-macro-make-optional
1354 * \li Origin: sts, 06 January 2008
1357 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1359 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1360 * \li Action: Make a parameter non-optional.
1361 * \li Notion: Turn the last optional parameter of a Math Macro
1362 into a non-optional parameter. The default value is
1363 remembered to be reused later if the user changes his mind.
1364 * \li Syntax: math-macro-make-nonoptional
1365 * \li Origin: sts, 06 January 2008
1368 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1370 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1371 * \li Action: Add an optional parameter.
1372 * \li Notion: Insert an optional parameter just behind the
1373 already existing optional parameters.
1374 * \li Syntax: math-macro-add-optional-param
1375 * \li Origin: sts, 06 January 2008
1378 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1380 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1381 * \li Action: Remove the last optional parameter.
1382 * \li Notion: Remove the last optional parameter of a Math Macro and
1383 remove it in all the instances of the macro in the buffer.
1384 * \li Syntax: math-macro-remove-optional-param
1385 * \li Origin: sts, 06 January 2008
1388 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1390 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1391 * \li Action: Add a greedy optional parameter.
1392 * \li Notion: Add a greedy optional parameter which eats the value
1393 from the following cells in mathed which are in the [value]
1395 * \li Syntax: math-macro-add-greedy-optional-param
1396 * \li Origin: sts, 06 January 2008
1399 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1401 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1402 * \li Action: Only active in Math Macro definition.
1403 * \li Notion: Dummy function which is only active in a Math Macro definition.
1404 It's used to toggle the Math Macro toolbar if the cursor moves
1405 into a Math Macro definition.
1406 * \li Syntax: in-mathmacrotemplate
1407 * \li Origin: sts, 06 January 2008
1410 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1413 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1414 * \li Action: Moves the current paragraph downwards in the document.
1415 * \li Syntax: paragraph-move-down
1416 * \li Origin: Edwin, 8 Apr 2006
1419 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1421 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1422 * \li Action: Moves the current paragraph upwards in the document.
1423 * \li Syntax: paragraph-move-up
1424 * \li Origin: Edwin, 8 Apr 2006
1427 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1430 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1431 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1432 in upward direction.
1433 * \li Syntax: paragraph-up
1434 * \li Origin: Asger, 1 Oct 1996
1437 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1439 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1440 * \li Action: Move the cursor and select the text to the next paragraph (or
1441 begining of the current one) in upward direction.
1442 * \li Syntax: paragraph-up-select
1443 * \li Origin: Asger, 1 Oct 1996
1446 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1448 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1449 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1450 in downward direction.
1451 * \li Syntax: paragraph-down
1452 * \li Origin: Asger, 1 Oct 1996
1455 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1457 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1458 * \li Action: Move the cursor and select the text to the next paragraph (or
1459 begining of the current one) in downward direction.
1460 * \li Syntax: paragraph-down-select
1461 * \li Origin: Asger, 1 Oct 1996
1464 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1466 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1467 * \li Action: Jump to a paragraph given by its id number and optionally the
1468 desired position within the paragraph.
1469 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1470 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1471 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1472 * \li Params: <PAR_ID_NUMBER>: paragraph id
1473 <POSITION_IN_PAR>: desired position within the paragraph
1474 * \li Origin: Dekel, 26 Aug 2000
1477 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1479 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1480 * \li Action: Breaks the current paragraph at the current location.
1481 * \li Syntax: break-paragraph
1484 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1486 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1487 * \li Action: Breaks the current paragraph at the current location.
1488 * \li Notion: Removes the selection.
1489 * \li Syntax: break-paragraph [<LAYOUT>]
1490 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1491 to default layout) when the cursor is at the end of
1495 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1497 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1498 * \li Action: Change paragraph settings.
1499 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1500 This function only modifies, and does not override, existing settings.
1501 Note that the "leftindent" indent setting is deprecated.
1502 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1503 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1504 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1505 <ALIGN>: \\align block|left|right|center|default\n
1506 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1507 * \li Origin: rgh, Aug 15 2007
1510 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1512 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1513 * \li Action: Change paragraph settings.
1514 * \li Notion: Overwrite all nonspecified settings to the default ones.
1515 Use paragraph-params lfun if you don't want to overwrite others settings.
1516 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1517 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1518 * \li Origin: leeming, 30 Mar 2004
1521 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1522 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1525 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1526 * \li Action: Move the current group in the upward direction in the
1527 structure of the document.
1528 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1529 the whole substructure of the group.
1530 * \li Syntax: outline-up
1531 * \li Origin: Vermeer, 23 Mar 2006
1534 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1536 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1537 * \li Action: Move the current group in the downward direction in the
1538 structure of the document.
1539 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1540 the whole substructure of the group.
1541 * \li Syntax: outline-down
1542 * \li Origin: Vermeer, 23 Mar 2006
1545 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1547 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1548 * \li Action: Moves the current group in the downward direction in the
1549 hierarchy of the document structure.
1550 * \li Notion: Part -> Chapter -> Section -> etc.
1551 * \li Syntax: outline-in
1552 * \li Origin: Vermeer, 23 Mar 2006
1555 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1557 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1558 * \li Action: Moves the current group in the upward direction in the
1559 hierarchy of the document structure.
1560 * \li Notion: Part <- Chapter <- Section <- etc.
1561 * \li Syntax: outline-out
1562 * \li Origin: Vermeer, 23 Mar 2006
1565 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1567 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1568 * \li Action: Edit the inset at cursor with an external application,
1569 * if one is attributed.
1570 * \li Syntax: inset-edit [<INSET_PARAMS>]
1571 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1572 Currently only the filename will be considered.
1573 * \li Origin: JSpitzm, 27 Apr 2006
1576 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1578 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1579 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1580 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1581 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1582 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1584 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1585 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1586 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1587 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1588 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1590 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1591 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1592 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1593 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1594 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1595 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1596 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1597 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1600 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1601 * \li Action: Apply data for an inset.
1602 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1603 be applied. This is either changed to #LFUN_INSET_MODIFY or
1604 #LFUN_INSET_INSERT depending on the context where it is called.
1605 * \li Syntax: inset-apply <ARGS>
1606 * \li Params: See #LFUN_INSET_INSERT .
1609 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1611 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1612 * \li Action: Dissolve the current inset into text.
1613 * \li Syntax: inset-dissolve [<INSET>]
1614 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1615 is dissolved. For example "dissolve" entry in the charstyles
1616 sub-menu should only dissolve the charstyle inset, even if the
1617 cursor is inside several nested insets of different type.\n
1618 For values see #lyx::InsetLayout::lyxtype_ .
1619 * \li Author: JSpitz, 7 Aug 2006
1622 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1624 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1625 * \li Action: Insert new inset (type given by the parameters).
1626 * \li Syntax: inset-insert <INSET> <ARGS>
1627 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1628 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1629 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1631 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1632 where <label name> is the name of the referenced label and
1633 <Format> is one of the following: \n
1634 ref -- <reference> \n
1635 eqref -- (<reference>) \n
1636 pageref -- <page> \n
1637 vpageref -- on <page> \n
1638 vref -- <reference> on <page> \n
1639 prettyref -- Formatted reference
1642 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1644 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1645 * \li Action: Modify existing inset.
1646 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1647 bibtex, ert, command, graphics, note, space, vspace, tabular,
1648 bibitem, inlude, ref insets.
1649 * \li Syntax: inset-modify <INSET> <ARGS>
1650 * \li Params: See #LFUN_INSET_INSERT for further details.
1653 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1655 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1656 * \li Action: Modify the inset at cursor position, if there is one.
1657 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1658 bibtex, ert, command, graphics, note, space, vspace, tabular,
1659 bibitem, inlude, ref insets.
1660 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1661 * \li Params: See #LFUN_INSET_INSERT for further details.
1662 * \li Origin: JSpitzm, 23 Mar 2008
1665 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1666 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1668 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1669 * \li Action: Open the inset's properties dialog.
1670 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1671 * \li Syntax: inset-settings <INSET>
1672 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1675 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1677 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1678 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1679 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1680 be entered. Also cf. #LFUN_INSET_SETTINGS.
1681 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1682 bibtex, ert, command, graphics, note, space, vspace, tabular,
1683 bibitem, inlude, ref insets.
1684 * \li Syntax: next-inset-toggle <ARG>
1685 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1686 * \li Origin: leeming, 30 Mar 2004
1689 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1691 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1692 * \li Action: Toggles the collapsable inset we are currently in.
1693 * \li Syntax: inset-toggle [<ARG>]
1694 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1695 open/close/toggle are for collapsable insets. close can be currently used
1696 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1697 assign is for branch inset.
1698 * \li Origin: lasgouttes, 19 Jul 2001
1701 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1703 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1704 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1705 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1706 * \li Syntax: all-insets-toggle <STATE> <INSET>
1707 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1708 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1709 * \li Origin: leeming, 30 Mar 2004
1712 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1714 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1715 * \li Action: Unify all graphics insets with the one given as an parameter.
1716 * \li Notion: This is internally used for synchronize certain group of graphics insets.
1717 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1718 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1719 (syntax can be seen in .lyx files).
1720 * \li Origin: sanda, 6 May 2008
1723 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1725 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1726 * \li Action: Set the group for the graphics inset on the cursor position.
1727 * \li Syntax: set-graphics-group [<GROUP>]
1728 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1729 the graphics inset is removed from the current group.
1730 * \li Origin: sanda, 6 May 2008
1733 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1736 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1737 * \li Action: Moves the cursor out of the current slice, going forward.
1738 * \li Notion: Cursor movement within an inset may be different than cursor
1739 movement in the surrounding text. This action should be called
1740 automatically by the cursor movement within the inset, when
1741 movement within the inset has ceased (reached the end of the
1742 last paragraph, for example), in order to move correctly
1743 back into the surrounding text.
1746 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1748 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1749 * \li Action: Moves the cursor out of the current slice, going backwards.
1750 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1753 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1755 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1756 * \li Action: Moves the cursor out of the current slice, going right.
1757 * \li Notion: See also #LFUN_FINISHED_FORWARD
1760 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1762 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1763 * \li Action: Moves the cursor out of the current slice, going left.
1764 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1767 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1769 { LFUN_LANGUAGE, "language", Noop, Edit },
1772 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1773 * \li Action: Goto a label.
1774 * \li Syntax: label-goto [<LABEL>]
1775 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1776 is on cursor position, Bookmark 0 is saved and
1777 cursor moves to the position of referenced label.
1778 * \li Origin: Ale, 6 Aug 1997
1781 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1783 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1784 * \li Action: Inserts label to text or displayed formula.
1785 * \li Syntax: label-insert [<LABEL>]
1786 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1787 name will be opened.
1790 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1792 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1793 * \li Action: Go to the next label or cross-reference.
1794 * \li Syntax: reference-next
1795 * \li Origin: Dekel, 14 Jan 2001
1798 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1801 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1802 * \li Action: Goto a bookmark.
1803 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1804 if necessary. Note that bookmarsk are saved per-session, not
1806 * \li Syntax: bookmark-goto <NUMBER>
1807 * \li Params: <NUMBER>: the number of the bookmark to restore.
1808 * \li Origin: Dekel, 27 January 2001
1811 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1813 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1814 * \li Action: Save a bookmark.
1815 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1816 must be between 1 and 9, inclusive. Note that bookmarks are
1817 saved per-session, not per file.
1818 * \li Syntax: bookmark-save <NUMBER>
1819 * \li Params: <NUMBER>: the number of the bookmark to save.
1820 * \li Origin: Dekel, 27 January 2001
1823 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1825 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1826 * \li Action: Clears the list of saved bookmarks.
1827 * \li Syntax: bookmark-clear
1828 * \li Origin: bpeng, 31 October 2006
1831 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1834 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1835 * \li Action: Open the given help file according to the language setting.
1836 * \li Syntax: help-open <FILE>[.lyx]
1837 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1838 * \li Author: Jug, 27 Jun 1999
1841 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1843 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1844 * \li Action: Terminates the current LyX instance.
1845 * \li Notion: Terminates the current LyX instance, asking whether to save
1846 modified documents, etc.
1847 * \li Syntax: lyx-quit
1850 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1852 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1853 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1854 * \li Notion: Skiping "auto" when allowauto is false.
1855 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1856 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1857 minibuffer|review|view/update|math_panels
1858 * \li Origin: Edwin, 21 May 2007
1861 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1863 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1864 * \li Action: Opens the menu given by its name.
1865 * \li Syntax: menu-open <NAME>
1866 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1869 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1871 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1872 * \li Action: Various UI visibility-toggling actions.
1873 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1874 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1875 menubar : Toggle visibility of the menubar.\n
1876 scrollbar : Toggle visibility of the scrollbar.\n
1877 frame : Toggle visibility of the frames around editing window.\n
1878 fullscreen : Toggle fullscreen mode. This also covers calling the
1879 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1880 custom tweaks of the toolbars should be used.
1881 * \li Origin: ps, 9 Feb 2007
1884 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1887 * \var lyx::FuncCode lyx::WINDOW_NEW
1888 * \li Action: Creates new empty LyX window.
1889 * \li Notion: Already opened documents from the previous window can be found under View menu.
1890 * \li Syntax: window-new [<GEOMETRY>]
1891 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1892 accepted only on Windows platform.
1893 * \li Origin: Abdel, 21 Oct 2006
1896 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1898 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1899 * \li Action: Closes the current LyX window.
1900 * \li Syntax: window-close
1901 * \li Origin: Abdel, 23 Oct 2006
1904 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1907 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1908 * \li Action: Creates another split view of current buffer.
1909 * \li Notion: All split views act in the same way indpendently.
1910 * \li Syntax: split-view <vertical|horizontal>
1911 * \li Params: horizontal : The work areas are laid out side by side.\n
1912 vertical : The work areas laid out vertically.\n
1913 * \li Origin: abdel, 20 Feb 2008
1916 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1919 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1920 * \li Action: Close the current tab group.
1921 * \li Notion: This only closes the work areas, not the buffer themselves.
1922 The still opened buffers can be visualized in another tab group.
1923 * \li Syntax: close-tab-group
1924 * \li Origin: abdel, 21 Feb 2008
1927 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1928 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1929 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1930 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1931 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1932 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1933 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1935 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1936 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1937 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1938 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1939 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1941 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1942 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1943 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1944 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1946 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1947 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1948 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1950 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1951 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1952 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1953 * \li Origin: Edmar, 23 Dec 1998
1956 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1957 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1959 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1960 * \li Action: Sets the cursor position based on the editing area coordinates
1961 (similar as clicking on that point with left mouse button).
1962 * \li Syntax: server-set-xy <X> <Y>
1965 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1967 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1968 * \li Action: Returns the coordinates of cursor position in the editing area.
1969 * \li Syntax: server-get-xy
1972 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1975 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1976 * \li Action: Generates the code (literate programming).
1977 * \li Notion: Latex file with extension \literate_extension is generated.
1978 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1979 \build_error_filter to process the compilation error messages. \n
1980 In case you want to process your literate file with a script, or some other program,
1981 just insert in your lyxrc file an entry with:\n
1982 \build_command "my_script my_arguments" \n
1983 The \build_error_filter differs from the \literate_error_filter only in that the
1984 former will identify error messages from your compiler.
1985 * \li Syntax: build-program
1988 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1991 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1992 * \li Action: Saves the current buffer to a temporary file.
1993 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1994 is called automatically by LyX, to "autosave" the current buffer.
1995 * \li Syntax: buffer-auto-save
1998 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2000 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2001 * \li Action: Loads the given child document.
2002 * \li Notion: The current document is treated as a parent.
2003 * \li Syntax: buffer-child-open <FILE>
2004 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2005 * \li Origin: Ale, 28 May 1997
2008 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2010 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2011 * \li Action: Runs chktex for the current document.
2012 * \li Syntax: buffer-chktex
2013 * \li Origin: Asger, 30 Oct 1997
2016 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2018 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2019 * \li Action: Toggles compression of the current document on/off.
2020 * \li Syntax: buffer-toggle-compression
2021 * \li Origin: bpeng, 27 Apr 2006
2024 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2026 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2027 * \li Action: Closes the current buffer.
2028 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2029 if the buffer has been modified.
2030 * \li Syntax: buffer-close
2033 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2035 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2036 * \li Action: Exports the current buffer (document) to the given format.
2037 * \li Syntax: buffer-export <FORMAT>
2038 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2039 can find in Tools->Preferences->File formats->Format.
2040 Usual format you will enter is "pdf2" (pdflatex),
2041 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2042 In case of "custom" you will be asked for a format you
2043 want to start from and for the command that you want to
2044 apply to this format. Internally the control is then passed
2045 to #LFUN_BUFFER_EXPORT_CUSTOM.
2046 * \li Origin: Lgb, 29 Jul 1997
2049 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2051 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2052 * \li Action: Exports the current buffer (document) from the given format using
2053 the given command on it.
2054 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2055 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2056 intermediate file).\n
2057 <COMMAND> this command will be launched on the file. Note that you can
2058 use "$$FName" string to qualify the intermediate file.
2059 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2060 * \li Origin: leeming, 27 Mar 2004
2063 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2065 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2066 * \li Action: Prints the current document.
2067 * \li Notion: Many settings can be given via the preferences dialog.
2068 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2069 * \li Params: <TARGET> is either "printer" or "file".\n
2070 <TARGER-NAME> is either "default" or file name or printer name.\n
2071 <COMMAND> command ensuring the printing job.
2072 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2073 * \li Origin: leeming, 28 Mar 2004
2076 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2078 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2079 * \li Action: Import a given file as a lyx document.
2080 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2081 defined convertors in preferences. Look into File->Import menu to get
2082 an idea of the currently active import formats.
2083 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2084 * \li Origin: Asger, 24 Jul 1998
2087 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2089 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2090 * \li Action: Creates a new buffer (that is, document).
2091 * \li Notion: Implicit path can be set in Preferences dialog.
2092 * \li Syntax: buffer-new [<FILE>]
2093 * \li Params: <FILE>: filename of created file with absolute path.
2096 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2098 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2099 * \li Action: Creates a new buffer (that is, document) from a template.
2100 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2101 Template will be asked for via Open-dialog.
2102 * \li Syntax: buffer-new-template [<FILE>]
2103 * \li Params: <FILE>: filename of created file with absolute path.
2106 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2108 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2109 * \li Action: Reverts opened document.
2110 * \li Syntax: buffer-reload
2111 * \li Origin: Asger, 2 Feb 1997
2114 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2116 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2117 * \li Action: Switch to the given buffer.
2118 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2119 document in different LyX windows.
2120 * \li Syntax: buffer-new-template <BUFFER>
2121 * \li Params: <BUFFER>: already opened document which is to be shown.
2124 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2126 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2127 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2128 * \li Syntax: buffer-toggle-read-only
2129 * \li Origin: Lgb, 27 May 1997
2132 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2134 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2135 * \li Action: Displays current buffer in chosen format.
2136 * \li Notion: Displays the contents of the current buffer in the chosen
2137 format, for example, PDF or DVI. This runs the necessary
2138 converter, calls the defined viewer, and so forth.
2139 * \li Syntax: buffer-view <FORMAT>
2140 * \li Params: <FORMAT>: The format to display, where this is one of the
2141 formats defined (in the current GUI) in the
2142 Tools>Preferences>File Formats dialog.
2145 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2147 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2148 * \li Action: Exports the current document and put the result into the
2149 temporary directory.
2150 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2151 the output will be rewriten - updated. This is useful in case your viewer
2152 is able to detect such changes (e.g. ghostview for postscript).
2153 * \li Syntax: buffer-update <FORMAT>
2154 * \li Params: <FORMAT>: The format to display, where this is one of the
2155 formats defined (in the current GUI) in the
2156 Tools>Preferences>File Formats dialog.
2157 * \li Origin: Dekel, 5 Aug 2000
2160 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2163 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2164 * \li Action: Saves the current buffer.
2165 * \li Notion: Saves the current buffer to disk, using the filename that
2166 is already associated with the buffer, asking for one if
2167 none is yet assigned.
2168 * \li Syntax: buffer-write
2171 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2173 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2174 * \li Action: Rename and save current buffer.
2175 * \li Syntax: buffer-write-as <FILENAME>
2176 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2177 is with respect to the original location of the buffer/file.
2180 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2182 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2183 * \li Action: Save all changed documents.
2184 * \li Syntax: buffer-write-all
2185 * \li Origin: rgh, gpothier 6 Aug 2007
2188 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2190 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2191 * \li Action: Switch to the next opened document.
2192 * \li Notion: Note that this does not necessarily mean next in tabbar
2193 (for full list see View menu).
2194 * \li Syntax: buffer-next
2197 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2199 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2200 * \li Action: Switch to the previous opened document.
2201 * \li Syntax: buffer-previous
2204 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2206 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2207 * \li Action: When run from a child document, this updates (exports) document built
2208 from the master buffer. If a master is not found, it updates the
2210 * \li Syntax: master-buffer-update
2211 * \li Author: Tommaso, 20 Sep 2007
2214 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2216 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2217 * \li Action: When run from a child document, this command shows a preview built
2218 from the master buffer. If a master is not found, it previews the
2220 * \li Syntax: master-buffer-view
2221 * \li Author: Tommaso, 20 Sep 2007
2224 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2226 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2227 * \li Action: Set language of the current document.
2228 * \li Syntax: buffer-language <LANG>
2229 * \li Params: <LANG>: language name. See lib/languages for list.
2230 * \li Author: leeming, 30 Mar 2004
2233 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2235 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2236 * \li Action: Save the current document settings as default.
2237 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2238 * \li Syntax: buffer-save-as-default [<ARGS>]
2239 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2240 you can find in document header of usual .lyx file.
2241 * \li Author: leeming, 30 Mar 2004
2244 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2246 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2247 * \li Action: Apply the given settings to the current document.
2248 * \li Syntax: buffer-params-apply [<ARGS>]
2249 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2250 you can find in document header of usual .lyx file.
2251 * \li Author: leeming, 30 Mar 2004
2254 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2257 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2258 * \li Action: Inserts another LyX file.
2259 * \li Syntax: file-insert [<FILE>]
2260 * \li Params: <FILE>: Filename to be inserted.
2263 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2265 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2266 * \li Action: Inserts plain text file.
2267 * \li Syntax: file-insert-plaintext [<FILE>]
2268 * \li Params: <FILE>: Filename to be inserted.
2269 * \li Origin: CFO-G, 19 Nov 1997
2272 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2274 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2275 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2276 * \li Syntax: file-insert-plaintext-para [<FILE>]
2277 * \li Params: <FILE>: Filename to be inserted.
2278 * \li Origin: Levon, 14 Feb 2001
2281 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2283 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2284 * \li Action: Open LyX document.
2285 * \li Syntax: file-open [<FILE>]
2286 * \li Params: <FILE>: Filename to be opened.
2289 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2292 * \var lyx::FuncCode lyx::LFUN_CALL
2293 * \li Action: Executes a command defined in a .def file.
2294 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2295 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2296 where <NAME> is the name of the new command and <LFUN> is the lfun code
2297 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2298 \\def_file "FileName" allows to include another .def file. \n
2299 This is particularly useful in connection with toolbar buttons:
2300 Since the name of the button image for this lfun is
2301 lib/images/commands/<NAME>.png this is the way to assign an image
2302 to a complex command-sequence.
2303 * \li Syntax: call <NAME>
2304 * \li Params: <NAME>: Name of the command that must be called.
2305 * \li Origin: broider, 2 Oct 2007
2308 { LFUN_CALL, "call", NoBuffer, System },
2310 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2311 * \li Action: Simulate halting Meta key (Alt key on PCs).
2312 * \li Notion: Used for buffer editation not for GUI control.
2313 * \li Syntax: meta-prefix
2316 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2318 * \var lyx::FuncCode lyx::LFUN_CANCEL
2319 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2320 * \li Syntax: cancel
2323 { LFUN_CANCEL, "cancel", NoBuffer, System },
2326 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2327 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2328 * \li Notion: Usually bound to M-x shortcut.
2329 * \li Syntax: command-execute
2332 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2333 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2335 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2336 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2337 * \li Syntax: command-sequence <CMDS>
2338 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2339 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2340 * \li Origin: Andre', 11 Nov 1999
2343 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2345 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2346 * \li Action: Shows message in statusbar (for script purposes).
2347 * \li Syntax: message <STRING>
2348 * \li Origin: Lgb, 8 Apr 2001
2351 { LFUN_MESSAGE, "message", NoBuffer, System },
2353 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2354 * \li Action: Save user preferences.
2355 * \li Syntax: preferences-save
2356 * \li Origin: Lgb, 27 Nov 1999
2359 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2361 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2362 * \li Action: Reconfigure the automatic settings.
2363 * \li Syntax: reconfigure
2364 * \li Origin: Asger, 14 Feb 1997
2367 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2369 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2370 * \li Action: Apply the given settings to user preferences.
2371 * \li Syntax: lyxrc-apply <SETTINGS>
2372 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2373 to get an idea which commands to use and their syntax.
2374 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2377 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2379 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2380 * \li Action: Determine whether keep cursor inside the editing window regardless
2381 the scrollbar movement.
2382 * \li Syntax: toggle-cursor-follows-scrollbar
2383 * \li Origin: ARRae, 2 Dec 1997
2386 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2388 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2389 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2390 * \li Notion: A new color entry is created if the color is unknown.
2391 Color names can be stored as a part of user settings.
2392 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2393 * \li Origin: SLior, 11 Jun 2000
2396 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2398 * \var lyx::FuncCode lyx::LFUN_STATISTICS
2399 * \li Action: Count the statistics (number of words and characters)
2400 in the document or in the given selection.
2401 * \li Notion: Note that this function gives the number of words/chars written,
2402 not the number of characters which will be typeset.
2403 * \li Syntax: statistics
2404 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2407 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2409 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2410 * \li Action: Show the inline completion at the cursor position.
2411 * \li Syntax: completion-inline
2412 * \li Origin: sts, Feb 19 2008
2415 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2417 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2418 * \li Action: Show the completion popup at the cursor position.
2419 * \li Syntax: completion-popup
2420 * \li Origin: sts, Feb 19 2008
2423 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2425 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2426 * \li Action: Try to complete the word or command at the cursor position.
2427 * \li Syntax: completion-complete
2428 * \li Origin: sts, Feb 19 2008
2431 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2433 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2434 * \li Action: Activate the branch
2435 * \li Syntax: branch-activate <BRANCH>
2436 * \li Params: <BRANCH>: The branch to activate
2437 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2438 could be used to export a pdf with the answers branch included
2439 without one's having to open LyX and activate the branch manually.
2440 * \li Origin: rgh, 27 May 2008
2443 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2445 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2446 * \li Action: De-activate the branch
2447 * \li Syntax: branch-deactivate <BRANCH>
2448 * \li Params: <BRANCH>: The branch to deactivate
2449 * \li Origin: rgh, 27 May 2008
2452 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2454 { LFUN_NOACTION, "", Noop, Hidden }
2455 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2458 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2459 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2466 LyXAction::LyXAction()
2472 // Returns an action tag from a string.
2473 FuncRequest LyXAction::lookupFunc(string const & func) const
2475 string const func2 = trim(func);
2477 if (func2.empty()) {
2478 return FuncRequest(LFUN_NOACTION);
2482 string const arg = split(func2, cmd, ' ');
2484 func_map::const_iterator fit = lyx_func_map.find(cmd);
2486 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2490 string const LyXAction::getActionName(FuncCode action) const
2492 info_map::const_iterator const it = lyx_info_map.find(action);
2493 return it != lyx_info_map.end() ? it->second.name : string();
2497 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2499 info_map::const_iterator const it = lyx_info_map.find(action);
2500 return it != lyx_info_map.end() ? it->second.type : Hidden;
2504 bool LyXAction::funcHasFlag(FuncCode action,
2505 LyXAction::func_attrib flag) const
2507 info_map::const_iterator ici = lyx_info_map.find(action);
2509 if (ici == lyx_info_map.end()) {
2510 LYXERR0("action: " << action << " is not known.");
2511 LASSERT(false, /**/);
2514 return ici->second.attrib & flag;
2518 LyXAction::const_func_iterator LyXAction::func_begin() const
2520 return lyx_func_map.begin();
2524 LyXAction::const_func_iterator LyXAction::func_end() const
2526 return lyx_func_map.end();