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 To make this command enabled the layout file for the document
413 class you're using has to load the character styles. There are
414 a few contained in the Logical Markup module. You can also of
415 course create some yourself. \n
416 For dissolving the element see #LFUN_INSET_DISSOLVE.
417 * \li Syntax: flex-insert <TYPE:Name>
418 * \li Params: TYPE: CharStyle|Custom|Element|Standard
419 Identifies whether this is a Character Style, a
420 Custom Inset or an XML Element, and which dynamical
421 sub-menu this flex inset is in on the LyX menu tree.
422 If Standard (currently unused): none of these.
423 Name: This name must be defined either in your layout file
424 or imported by some module. The definition is \n
425 InsetLayout <TYPE:Name>
426 * \li Sample: flex-insert CharStyle:Code
429 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
431 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
432 * \li Action: Inserts the given string (accordingly to the correct keymap).
433 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
434 settings "auto_region_delete".
435 * \li Syntax: self-insert <STRING>
438 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
440 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
441 * \li Action: Inserts one of horizontal space insets.
442 * \li Syntax: space-insert <NAME> [<LEN>]
443 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
444 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
446 <LEN>: length for custom spaces (hspace, hspace* for protected)
447 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
450 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
452 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
453 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
454 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
455 * \li Syntax: href-insert [<TARGET>]
456 * \li Origin: CFO-G, 21 Nov 1997
459 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
461 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
462 * \li Action: Inserts various characters into the document.
463 * \li Syntax: specialchar-insert <CHAR>
464 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
465 end-of-sentence, menu-separator.
466 * \li Origin: JSpitzm, 6 Dec 2007
469 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
471 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
472 * \li Action: Inserts table of contents.
473 * \li Syntax: toc-insert
474 * \li Origin: Lgb, 27 May 97
477 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
479 * \var lyx::FuncCode lyx::LFUN_APPENDIX
480 * \li Action: Start (or remove) Appendix on the given cursor position.
481 * \li Syntax: appendix
482 * \li Origin: ettrich, 5 May 1998
485 { LFUN_APPENDIX, "appendix", Noop, Edit },
488 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
489 * \li Action: Inserts Index entry.
490 * \li Notion: It automatically takes the word on the cursor position.
491 * \li Syntax: index-insert
492 * \li Origin: Angus, 3 Aug 2000
495 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
497 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
498 * \li Action: Inserts list of Index entries on a new page.
499 * \li Syntax: index-print
500 * \li Origin: Lgb, 27 Feb 1997
503 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
507 * \li Action: Inserts Nomenclature entry.
508 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
509 * \li Syntax: nomencl-insert [<SYMBOL>]
510 * \li Origin: Ugras, 4 Nov 2006
513 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
515 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
516 * \li Action: Inserts list of Nomenclature entries.
517 * \li Syntax: nomenclature-print
518 * \li Origin: Ugras, 4 Nov 2006
521 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
524 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
525 * \li Action: Inserts Note on the current cursor postion,
526 move selection inside the inset.
527 * \li Syntax: note-insert [<TYPE>]
528 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
531 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
533 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
534 * \li Action: Moves the cursor to the begining of next Note inset.
535 * \li Syntax: note-next
538 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
540 * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
541 * \li Action: Changes all Note insets of a particular type (source)
542 to a different type (target) fot the current document.
543 * \li Syntax: notes-mutate <SOURCE> <TARGET>
544 * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
545 * \li Origin: ps, 18 Jun 2008
548 { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
550 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
551 * \li Action: Inserts a line break or new line.
552 * \li Syntax: newline-insert [<ARG>]
553 * \li Params: <ARG>: <newline|linebreak> default: newline
554 * \li Origin: JSpitzm, 25 Mar 2008
557 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
560 * \var lyx::FuncCode lyx::LFUN_ESCAPE
561 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
563 * \li Origin: Lgb, 17 May 2001
566 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
568 * \var lyx::FuncCode lyx::LFUN_DOWN
569 * \li Action: Moves the cursor one line in downward direction.
573 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
575 * \var lyx::FuncCode lyx::LFUN_UP
576 * \li Action: Moves the cursor one line in upward direction.
580 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
582 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
583 * \li Action: Moves the cursor one line in downward direction adding the current
584 position to the selection.
585 * \li Syntax: down-select
588 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
590 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
591 * \li Action: Moves the cursor one line in upward direction adding the current
592 position to the selection.
593 * \li Syntax: up-select
596 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
598 * \var lyx::FuncCode lyx::SCREEN_DOWN
599 * \li Action: Moves the cursor one page in downward direction.
600 * \li Syntax: screen-down
603 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
605 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
606 * \li Action: Moves the cursor one page in upward direction.
607 * \li Syntax: screen-up
610 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
612 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
613 * \li Action: Moves the cursor one screen in downward direction adding the current
614 position to the selection.
615 * \li Syntax: screen-down-select
618 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
620 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
621 * \li Action: Moves the cursor one page in upward direction adding the current
622 position to the selection.
623 * \li Syntax: screen-up-select
626 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
628 * \var lyx::FuncCode lyx::LFUN_SCROLL
629 * \li Action: Scroll the buffer view.
630 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
631 * \li Syntax: scroll <TYPE> <QUANTITY>
632 * \li Params: <TYPE>: line|page\n
633 <QUANTITY>: up|down|<number>
634 * \li Origin: Abdelrazak Younes, Dec 27 2007
637 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
639 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
640 * \li Action: Recenters the screen on the current cursor position.
641 * \li Syntax: screen-recenter
644 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
647 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
648 * \li Action: Moves the cursor one position logically backwards.
649 * \li Notion: This is not the action which should be bound to the arrow keys,
650 because backwards may be left or right, depending on the
651 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
652 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
653 * \li Syntax: char-backward
656 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
658 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
659 * \li Action: Moves the cursor one position logically backwards, adding
660 traversed position to the selection.
661 * \li Notion: See also #LFUN_CHAR_BACKWARD.
662 * \li Syntax: char-backward-select
665 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
667 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
668 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
669 * \li Syntax: char-delete-backward
672 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
674 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
675 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
676 * \li Syntax: char-delete-forward
679 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
681 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
682 * \li Action: Moves the cursor one position logically forward.
683 * \li Notion: This is not the action which should be bound to the arrow keys,
684 because forward may be left or right, depending on the language.
685 The arrow keys should be bound to #LFUN_CHAR_LEFT or
686 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
687 * \li Syntax: char-forward
690 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
692 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
693 * \li Action: Moves the cursor one position logically forward, adding
694 traversed position to the selection.
695 * \li Notion: See also #LFUN_CHAR_FORWARD.
696 * \li Syntax: char-forward-select
699 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
701 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
702 * \li Action: Moves the cursor one position "to the left".
703 * \li Notion: This is the action which should be taken when the "left" key
704 is pressed. Generally, it moves the cursor one position to the
705 left. However, in Bidi text this become slightly more
706 complicated, and there are different modes of cursor movement.
707 In "visual mode", this moves left, plain and simple. In "logical
708 mode", movement is logically forward in RTL paragraphs, and
709 logically backwards in LTR paragraphs.
710 * \li Syntax: char-left
713 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
715 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
716 * \li Action: Moves the cursor one position "to the left", adding
717 traversed position to the selection.
718 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
719 * \li Syntax: char-left-select
722 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
724 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
725 * \li Action: Moves the cursor one position "to the right".
726 * \li Notion: This is the action which should be taken when the "right" key
727 is pressed. Generally, it moves the cursor one position to the
728 right. However, in Bidi text this become slightly more
729 complicated, and there are different modes of cursor movement.
730 In "visual mode", this moves right, plain and simple. In "logical
731 mode", movement is logically forward in LTR paragraphs, and
732 logically backwards in RTL paragraphs.
733 * \li Syntax: char-right
736 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
738 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
739 * \li Action: Moves the cursor one position "to the right", adding
740 traversed position to the selection.
741 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
742 * \li Syntax: char-right-select
745 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
748 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
749 * \li Action: Moves the cursor to the logically previous beginning of a word.
750 * \li Notion: This is not the action which should be bound to the arrow keys,
751 because backwards may be left or right, depending on the
752 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
753 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
754 * \li Syntax: word-backward
757 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
759 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
760 * \li Action: Moves the cursor to the logically previous beginning of a word,
761 adding the logically traversed text to the selection.
762 * \li Notion: See also #LFUN_WORD_BACKWARD.
763 * \li Syntax: word-backward-select
766 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
768 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
769 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
770 * \li Syntax: word-delete-backward
773 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
775 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
776 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
777 * \li Syntax: word-delete-forward
780 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
782 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
783 * \li Action: Search for a given string in forward direction.
784 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
785 * \li Syntax: word-find-forward [<STRING>]
786 * \li Origin: Etienne, 16 Feb 1998
789 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
791 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
792 * \li Action: Search for a given string in backward direction.
793 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
794 * \li Syntax: word-find-backward [<STRING>]
795 * \li Origin: Etienne, 20 Feb 1998
798 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
800 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
801 * \li Action: Search for next occurence of a string.
802 * \li Syntax: word-find [<DATA>]
803 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
804 If no parameter is given, search with last find-dialog
805 data is used for search (i.e. find-next).
806 * \li Origin: poenitz, Jan 7 2004
809 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
811 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
812 * \li Action: Replace a string in the document.
813 * \li Syntax: word-replace [<DATA>]
814 * \li Params: <DATA>: data is of the form
817 <casesensitive> <matchword> <all> <forward>"
818 * \li Origin: poenitz, Jan 7 2004
821 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
823 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
824 * \li Action: Moves the cursor to the logically next beginning of a word.
825 * \li Notion: This is not the action which should be bound to the arrow keys,
826 because forward may be left or right, depending on the language.
827 The arrow keys should be bound to #LFUN_WORD_LEFT or
828 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
829 * \li Syntax: word-forward
832 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
834 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
835 * \li Action: Moves the cursor to the logically next beginning of a word,
836 adding the logically traversed text to the selection.
837 * \li Notion: See also #LFUN_WORD_FORWARD.
838 * \li Syntax: word-forward-select
841 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
843 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
844 * \li Action: Moves the cursor to the next beginning of a word "on the left".
845 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
846 "left" key is pressed. Generally, it moves the cursor to the
847 next beginning of a word on the left. However, in Bidi text this
848 become slightly more complicated, and there are different modes
849 of cursor movement. In "visual mode", this moves left, plain and
850 simple. In "logical mode", movement is logically forward in RTL
851 paragraphs, and logically backwards in LTR paragraphs.
852 * \li Syntax: word-left
853 * \li Origin: dov, 28 Oct 2007
856 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
858 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
859 * \li Action: Moves the cursor to the next beginning of a word "on the left",
860 adding *logically* traversed text to the selection.
861 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
862 * \li Syntax: word-left-select
863 * \li Origin: dov, 28 Oct 2007
866 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
868 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
869 * \li Action: Moves the cursor to the next beginning of a word "on the right".
870 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
871 "right" key is pressed. Generally, it moves the cursor to the
872 next beginning of a word on the right. However, in Bidi text
873 this become slightly more complicated, and there are different
874 modes of cursor movement. In "visual mode", this moves right,
875 plain and simple. In "logical mode", movement is logically
876 forward in LTR paragraphs, and logically backwards in RTL
878 * \li Syntax: word-right
879 * \li Origin: dov, 28 Oct 2007
882 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
884 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
885 * \li Action: Moves the cursor to the next beginning of a word "on the right",
886 adding *logically* traversed text to the selection.
887 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
888 * \li Syntax: word-right-select
889 * \li Origin: dov, 28 Oct 2007
892 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
894 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
895 * \li Action: Puts the word where the cursor stands into the selection.
896 * \li Syntax: word-select
897 * \li Author: Andre, 11 Sep 2002
900 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
902 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
903 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
904 or the letter on the cursor position.
905 * \li Syntax: word-capitalize
908 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
910 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
911 * \li Action: Change the words in the selection or from the cursor position
912 to the end of word to the upper case.
913 * \li Syntax: word-upcase
916 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
918 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
919 * \li Action: Change the words in the selection or from the cursor position
920 to the end of word to the lower case.
921 * \li Syntax: word-lowcase
924 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
926 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
927 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
928 * \li Syntax: thesaurus-entry
929 * \li Origin: Levon, 20 Jul 2001
932 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
934 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
935 * \li Action: Move the cursor to the beginning of the document.
936 * \li Syntax: buffer-begin
939 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
941 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
942 * \li Action: Move the cursor to the beginning of the document adding the
943 traversed text to the selection.
944 * \li Syntax: buffer-begin-select
947 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
949 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
950 * \li Action: Move the cursor to the end of the document.
951 * \li Syntax: buffer-end
954 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
956 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
957 * \li Action: Move the cursor to the end of the document adding the
958 traversed text to the selection.
959 * \li Syntax: buffer-end-select
962 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
965 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
966 * \li Action: Move the cursor to the begining of the (screen) line.
967 * \li Syntax: line-begin
970 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
972 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
973 * \li Action: Move the cursor to the beginning of the (screen) line adding the
974 traversed text to the selection.
975 * \li Syntax: line-begin-select
978 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
980 * \var lyx::FuncCode lyx::LFUN_LINE_END
981 * \li Action: Move the cursor to the end of the (screen) line.
982 * \li Syntax: line-end
985 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
987 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
988 * \li Action: Move the cursor to the end of the (screen) line adding the
989 traversed text to the selection.
990 * \li Syntax: line-end-select
993 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
995 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
996 * \li Action: Deletes the letters to the end of the (screen) line or
997 deletes the selection.
998 * \li Syntax: line-delete-forward
1001 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1003 * \var lyx::FuncCode lyx::LFUN_COPY
1004 * \li Action: Copies to the clipboard the last edit.
1008 { LFUN_COPY, "copy", ReadOnly, Edit },
1010 * \var lyx::FuncCode lyx::LFUN_CUT
1011 * \li Action: Cuts to the clipboard.
1015 { LFUN_CUT, "cut", Noop, Edit },
1017 * \var lyx::FuncCode lyx::LFUN_PASTE
1018 * \li Action: Pastes from the active clipboard.
1022 { LFUN_PASTE, "paste", Noop, Edit },
1023 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1025 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1026 * \li Action: Pastes the material currently selected.
1027 * \li Syntax: primary-selection-paste
1030 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1032 * \var lyx::FuncCode lyx::LFUN_UNDO
1033 * \li Action: Undoes the last edit.
1037 { LFUN_UNDO, "undo", Noop, Edit },
1039 * \var lyx::FuncCode lyx::LFUN_REDO
1040 * \li Action: Redoes the last thing undone.
1044 { LFUN_REDO, "redo", Noop, Edit },
1046 * \var lyx::FuncCode lyx::LFUN_REPEAT
1047 * \li Action: Repeat the given command.
1048 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1049 * \li Author: poenitz, 27 Oct 2003
1052 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1054 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1055 * \li Action: Transposes the character at the cursor with the one before it.
1056 * \li Syntax: chars-transpose
1057 * \li Author: Lgb, 25 Apr 2001
1060 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1063 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1064 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1066 * \li Syntax: depth-decrement
1069 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1071 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1072 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1074 * \li Syntax: depth-increment
1077 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1080 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1081 * \li Action: Toggles the bold font (selection-wise).
1082 * \li Syntax: font-bold
1085 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1087 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1088 * \li Action: Toggles the typewriter family font (selection-wise).
1089 * \li Syntax: font-typewriter
1092 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1094 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1095 * \li Action: Toggles underline in the font (selection-wise).
1096 * \li Syntax: font-underline
1099 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1101 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1102 * \li Action: Toggles the emphasis font style (selection-wise).
1103 * \li Syntax: font-emph
1106 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1108 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1109 * \li Action: Toggles Noun text style font (selection-wise).
1110 * \li Syntax: font-noun
1113 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1115 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1116 * \li Action: Toggles Roman family font (selection-wise).
1117 * \li Syntax: font-roman
1120 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1122 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1123 * \li Action: Toggles Sans Serif family font (selection-wise).
1124 * \li Syntax: font-sans
1127 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1129 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1130 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1131 * \li Syntax: font-frak
1132 * \li Origin: vermeer, 10 Jan 2002
1135 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1137 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1138 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1139 * \li Syntax: font-ital
1140 * \li Origin: vermeer, 10 Jan 2002
1143 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1145 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1146 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1147 * \li Syntax: font-default
1150 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1152 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1153 * \li Action: Sets font size according to lyx format string.
1154 * \li Syntax: font-size <SIZE>
1155 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
1156 largest|huge|giant|increase|decrease|default
1159 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1161 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1162 * \li Action: Toggle user-defined (=last-time used) text style.
1163 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1164 automatically trigerred when using Text Style dialog.
1165 * \li Syntax: textstyle-apply
1166 * \li Origin: leeming, 12 Mar 2003
1169 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1171 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1172 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1173 * \li Syntax: textstyle-update <FONT_INFO>
1174 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1175 size, emph, noun, underbar, number, color, language,
1177 Use lyx -dbg action for exact syntax of text-style
1179 * \li Origin: leeming, 12 Mar 2003
1182 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1184 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1185 * \li Action: Update fonts and its metrics.
1186 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1187 * \li Syntax: screen-font-update
1188 * \li Origin: ARRae, 13 Aug 2000
1191 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1193 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1194 * \li Action: Returns the info about the current font.
1195 * \li Syntax: font-state
1198 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1200 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
1202 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1203 * \li Action: Inserts citation from loaded citation database.
1204 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1205 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1206 <TEXT_BEFORE>: text which should appear before citation.
1207 * \li Origin: AAS, 97-02-23
1210 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1212 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1213 * \li Action: Adds database, which will be used for bibtex citations.
1214 * \li Notion: Databases are added to the first BibTeX inset
1215 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1216 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1217 * \li Origin: Ale, 30 May 1997
1220 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1222 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1223 * \li Action: Adds database, which will be used for bibtex citations.
1224 * \li Notion: Databases are deleted from the first BibTeX inset
1225 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1226 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1227 * \li Origin: Ale, 30 May 1997
1230 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1233 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1234 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1235 * \li Syntax: layout <LAYOUT>
1236 * \li Params: <LAYOUT>: the layout to use
1239 { LFUN_LAYOUT, "layout", Noop, Layout },
1241 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1242 * \li Action: Launches the paragraph settings dialog.
1243 * \li Syntax: layout-paragraph
1246 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1248 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1249 * \li Action: Launches the tabular settings dialog.
1250 * \li Syntax: layout-tabular
1251 * \li Origin: Jug, 31 Jul 2000
1254 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1256 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1257 * \li Action: Displays list of layout choices.
1258 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1259 dropbox allowing for choice of layout.
1260 * \li Syntax: drop-layouts-choice
1263 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1265 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1266 * \li Action: Clears the module list.
1267 * \li Notion: Clears the list of included modules for the current buffer.
1268 * \li Syntax: layout-modules-clear
1269 * \li Origin: rgh, 25 August 2007
1272 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1274 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1275 * \li Action: Adds a module.
1276 * \li Notion: Adds a module to the list of included modules for the current buffer.
1277 * \li Syntax: layout-module-add <MODULE>
1278 * \li Params: <MODULE>: the module to be added
1279 * \li Origin: rgh, 25 August 2007
1282 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1284 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1285 * \li Action: Reloads layout information.
1286 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1287 recognizing any changes that have been made to layout files on the fly.
1288 This is intended to be used only by layout developers and should not be
1289 used when one is trying to do actual work.
1290 * \li Syntax: layout-reload
1291 * \li Origin: rgh, 3 September 2007
1294 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1296 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1297 * \li Action: Sets the text class for the current buffer.
1298 * \li Syntax: textclass-apply <TEXTCLASS>
1299 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1300 the filename, minus the ".layout" extension.
1303 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1305 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1306 * \li Action: Loads information for a textclass from disk.
1307 * \li Syntax: textclass-load <TEXTCLASS>
1308 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1309 the filename, minus the ".layout" extension.
1312 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1315 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1316 * \li Action: Disable selecting of text-region.
1317 * \li Syntax: mark-off
1320 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1322 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1323 * \li Action: Enable selecting of text-region.
1324 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1325 * \li Syntax: mark-on
1328 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1330 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1331 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1332 * \li Syntax: mark-toggle
1333 * \li Origin: poenitz, May 5 2006
1336 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1339 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1340 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1341 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1342 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1343 either a LaTeX name or a valid character.
1344 ( is the default letter.
1345 * \li Sample: math-delim { rangle
1346 * \li Origin: Alejandro, 18 Jun 1996
1349 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1351 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1352 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1353 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1354 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1355 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1356 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1357 * \li Origin: Enrico & Georg, 7 May 2006
1360 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1362 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1363 * \li Action: Creates a new displayed equation in text mode.
1364 Toggles inlined/display formula in math mode.
1365 * \li Syntax: math-display [<ARG>]
1366 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1367 new equation from the text mode.
1368 * \li Origin: Alejandro, 18 Jun 1996
1371 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1373 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1374 * \li Action: Inserts math objects and symbols.
1375 * \li Syntax: math-insert <ARG>
1376 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1379 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1381 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1382 * \li Action: Enters subscript expression in math expression.
1383 * \li Syntax: math-subscript
1384 * \li Origin: vermeer, 12 Dec 2001
1387 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1389 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1390 * \li Action: Enters subscript expression in math expression.
1391 * \li Syntax: math-superscript
1392 * \li Origin: vermeer, 12 Dec 2001
1395 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1397 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1398 * \li Action: Toggles the position of the limits from above/below to the right
1399 side an vice versa in integral symbol, a limit, a summation, etc.
1400 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1402 * \li Syntax: math-limits [<STATE>]
1403 * \li Params: <STATE>: limits|nolimits
1406 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1408 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1409 * \li Action: Inserts a math macro definition at the cursor position in the text.
1410 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1411 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".
1412 <NARGS>: The number of parameters of the macro. Default is 0.
1413 "def": Has no effect anymore, just for compatibility with former LyX versions.
1414 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1417 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1419 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1420 * \li Action: Mutates the type of math inset to the newly selected one.
1421 * \li Syntax: math-mutate <TYPE>
1422 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1423 multline|gather|flalign
1424 * \li Origin: Andre', 23 May 2001
1427 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1429 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1430 * \li Action: Inserts space into math expression.
1431 * \li Notion: Use spacebar after entering this space to change type of space.
1432 * \li Syntax: math-space [<TYPE>]
1433 * \li Params: <TYPE>: negative spaces: !|negmedspace|negthickspace \n
1434 positive spaces: ,|:|;|quad|qquad \n
1435 "," used by default.
1436 * \li Origin: Andre', 25 Jul 2001; ps, 16 Jun 2008
1439 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1441 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1442 * \li Action: Inserts a matrix.
1443 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1444 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1445 (b, c or t) (i.e. 1 char) and the horizontal alignments
1446 (l, c or r) (i.e. <COL> chars).
1447 * \li Sample: math-matrix 3 3 bccc
1450 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1452 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1453 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1454 cursor position), in math mode enters text mode inside math expression.
1455 * \li Notion: If there is some selected text, it puts the text inside created math box.
1456 * \li Syntax: math-mode [<ARG>]
1457 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
1458 * \li Origin: Alejandro, 4 Jun 1996
1461 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1463 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1464 * \li Action: Toggles numbering of the current formula line.
1465 * \li Notion: Must be in display formula mode.
1466 * \li Syntax: math-number-line-toggle
1467 * \li Origin: Alejandro, 18 Jun 1996
1470 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1472 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1473 * \li Action: Toggles numbering/labeling of the current formula.
1474 * \li Notion: Must be in display formula mode.
1475 * \li Syntax: math-number-toggle
1476 * \li Origin: Alejandro, 4 Jun 1996
1479 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1481 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1482 * \li Action: Calls external program and passes the current expression/equation
1483 as an argument for the calculation in the format appropriate to the
1485 * \li Notion: Selection can be used to determine the input for the external program.
1486 * \li Syntax: math-extern <LANG> [<COMMAND>]
1487 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1488 where "script" stands fot the external script (normalized
1489 expression will be passed)
1490 * \li Origin: Andre', 24 Apr 2001
1491 * \li Sample: math-extern maple simplify
1494 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1496 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1497 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1498 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1499 * \li Syntax: math-size <STYLE>
1500 *\ li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1501 * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
1504 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1506 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1507 * \li Action: Unfold a Math Macro.
1508 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1510 * \li Syntax: math-macro-unfold
1511 * \li Origin: sts, 06 January 2008
1514 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1516 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1517 * \li Action: Fold a Math Macro.
1518 * \li Notion: Fold the Math Macro the cursor is in if it was
1519 unfolded, i.e. displayed as \foo before.
1520 * \li Syntax: math-macro-fold
1521 * \li Origin: sts, 06 January 2008
1524 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1526 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1527 * \li Action: Add a parameter.
1528 * \li Notion: Add a parameter to a Math Macro.
1529 * \li Params: <NUM>: The number of the parameter behind which the new one
1530 will be added (1 for the first, i.e. use 0 for add a
1531 parameter at the left), defaults to the last one.
1532 * \li Syntax: math-macro-add-param <NUM>
1533 * \li Origin: sts, 06 January 2008
1536 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1538 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1539 * \li Action: Remove the last parameter.
1540 * \li Notion: Remove the last parameter of a Math Macro and
1541 remove its value in all instances of the macro
1543 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1544 the first), defaults to the last one.
1545 * \li Syntax: math-macro-remove-param <NUM>
1546 * \li Origin: sts, 06 January 2008
1549 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1551 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1552 * \li Action: Append a greedy parameter.
1553 * \li Notion: Append a greedy parameter to a Math Macro which
1554 eats the following mathed cell in every instance of
1555 the macro in the buffer.
1556 * \li Syntax: math-macro-append-greedy-param
1557 * \li Origin: sts, 06 January 2008
1560 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1562 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1563 * \li Action: Remove a greedy parameter.
1564 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1565 out the values of it in every instance of the macro
1566 in the buffer. If it is an optional parameter the [valud]
1568 * \li Syntax: math-macro-remove-greedy-param
1569 * \li Origin: sts, 06 January 2008
1572 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1574 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1575 * \li Action: Make a parameter optional.
1576 * \li Notion: Turn the first non-optional parameter of a Math Macro
1577 into an optional parameter with a default value.
1578 * \li Syntax: math-macro-make-optional
1579 * \li Origin: sts, 06 January 2008
1582 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1584 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1585 * \li Action: Make a parameter non-optional.
1586 * \li Notion: Turn the last optional parameter of a Math Macro
1587 into a non-optional parameter. The default value is
1588 remembered to be reused later if the user changes his mind.
1589 * \li Syntax: math-macro-make-nonoptional
1590 * \li Origin: sts, 06 January 2008
1593 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1595 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1596 * \li Action: Add an optional parameter.
1597 * \li Notion: Insert an optional parameter just behind the
1598 already existing optional parameters.
1599 * \li Syntax: math-macro-add-optional-param
1600 * \li Origin: sts, 06 January 2008
1603 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1605 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1606 * \li Action: Remove the last optional parameter.
1607 * \li Notion: Remove the last optional parameter of a Math Macro and
1608 remove it in all the instances of the macro in the buffer.
1609 * \li Syntax: math-macro-remove-optional-param
1610 * \li Origin: sts, 06 January 2008
1613 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1615 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1616 * \li Action: Add a greedy optional parameter.
1617 * \li Notion: Add a greedy optional parameter which eats the value
1618 from the following cells in mathed which are in the [value]
1620 * \li Syntax: math-macro-add-greedy-optional-param
1621 * \li Origin: sts, 06 January 2008
1624 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1626 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1627 * \li Action: Only active in Math Macro definition.
1628 * \li Notion: Dummy function which is only active in a Math Macro definition.
1629 It's used to toggle the Math Macro toolbar if the cursor moves
1630 into a Math Macro definition.
1631 * \li Syntax: in-mathmacrotemplate
1632 * \li Origin: sts, 06 January 2008
1635 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1638 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1639 * \li Action: Moves the current paragraph downwards in the document.
1640 * \li Syntax: paragraph-move-down
1641 * \li Origin: Edwin, 8 Apr 2006
1644 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1646 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1647 * \li Action: Moves the current paragraph upwards in the document.
1648 * \li Syntax: paragraph-move-up
1649 * \li Origin: Edwin, 8 Apr 2006
1652 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1655 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1656 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1657 in upward direction.
1658 * \li Syntax: paragraph-up
1659 * \li Origin: Asger, 1 Oct 1996
1662 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1664 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1665 * \li Action: Move the cursor and select the text to the next paragraph (or
1666 begining of the current one) in upward direction.
1667 * \li Syntax: paragraph-up-select
1668 * \li Origin: Asger, 1 Oct 1996
1671 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1673 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1674 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1675 in downward direction.
1676 * \li Syntax: paragraph-down
1677 * \li Origin: Asger, 1 Oct 1996
1680 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1682 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1683 * \li Action: Move the cursor and select the text to the next paragraph (or
1684 begining of the current one) in downward direction.
1685 * \li Syntax: paragraph-down-select
1686 * \li Origin: Asger, 1 Oct 1996
1689 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1691 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1692 * \li Action: Jump to a paragraph given by its id number and optionally the
1693 desired position within the paragraph.
1694 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1695 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1696 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1697 * \li Params: <PAR_ID_NUMBER>: paragraph id
1698 <POSITION_IN_PAR>: desired position within the paragraph
1699 * \li Origin: Dekel, 26 Aug 2000
1702 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1704 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1705 * \li Action: Breaks the current paragraph at the current location.
1706 * \li Syntax: break-paragraph
1709 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1711 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1712 * \li Action: Breaks the current paragraph at the current location.
1713 * \li Notion: Removes the selection.
1714 * \li Syntax: break-paragraph [<LAYOUT>]
1715 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1716 to default layout) when the cursor is at the end of
1720 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1722 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1723 * \li Action: Change paragraph settings.
1724 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1725 This function only modifies, and does not override, existing settings.
1726 Note that the "leftindent" indent setting is deprecated.
1727 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1728 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1729 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1730 <ALIGN>: \\align block|left|right|center|default\n
1731 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1732 * \li Origin: rgh, Aug 15 2007
1735 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1737 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1738 * \li Action: Change paragraph settings.
1739 * \li Notion: Overwrite all nonspecified settings to the default ones.
1740 Use paragraph-params lfun if you don't want to overwrite others settings.
1741 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1742 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1743 * \li Origin: leeming, 30 Mar 2004
1746 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1748 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1749 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1750 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1751 by #LFUN_DIALOG_UPDATE.
1752 * \li Origin: leeming, 13 Mar 2003
1755 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1758 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1759 * \li Action: Move the current group in the upward direction in the
1760 structure of the document.
1761 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1762 the whole substructure of the group.
1763 * \li Syntax: outline-up
1764 * \li Origin: Vermeer, 23 Mar 2006
1767 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1769 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1770 * \li Action: Move the current group in the downward direction in the
1771 structure of the document.
1772 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1773 the whole substructure of the group.
1774 * \li Syntax: outline-down
1775 * \li Origin: Vermeer, 23 Mar 2006
1778 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1780 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1781 * \li Action: Moves the current group in the downward direction in the
1782 hierarchy of the document structure.
1783 * \li Notion: Part -> Chapter -> Section -> etc.
1784 * \li Syntax: outline-in
1785 * \li Origin: Vermeer, 23 Mar 2006
1788 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1790 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1791 * \li Action: Moves the current group in the upward direction in the
1792 hierarchy of the document structure.
1793 * \li Notion: Part <- Chapter <- Section <- etc.
1794 * \li Syntax: outline-out
1795 * \li Origin: Vermeer, 23 Mar 2006
1798 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1800 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1801 * \li Action: Edit the inset at cursor with an external application,
1802 * if one is attributed.
1803 * \li Syntax: inset-edit [<INSET_PARAMS>]
1804 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1805 Currently only the filename will be considered.
1806 * \li Origin: JSpitzm, 27 Apr 2006
1809 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1812 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
1813 * \li Action: Inserts table into the document.
1814 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
1815 * \li Params: In case no arguments are given show insert dialog.
1816 * \li Origin: Jug, 12 Apr 2000
1819 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1821 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
1822 * \li Action: Sets various features to the table/cell on the current cursor position.
1823 * \li Notion: Various math-environment features are handled here as well, e.g.
1824 add-vline-left/right for Grid/Cases environment
1825 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
1826 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
1827 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
1828 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
1829 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top|
1830 m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines|
1831 set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
1832 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
1833 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
1834 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
1835 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
1836 set-special-column|set-special-multi|set-booktabs|unset-booktabs|
1837 set-top-space|set-bottom-space|set-interline-space|set-border-lines \n
1838 <ARG>: additional argument for some commands, use debug mode to explore its values.
1839 * \li Origin: Jug, 28 Jul 2000
1842 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1844 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1845 * \li Action: Moves the cursor to the previous cell inside the table.
1846 * \li Syntax: cell-backward
1847 * \li Origin: Jug, 22 May 2000
1850 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1852 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
1853 * \li Action: Moves the cursor to the next cell inside the table.
1854 * \li Syntax: cell-forward
1857 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1859 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
1860 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
1861 * \li Syntax: cell-split
1862 * \li Origin: Ale, 15 May 1997
1865 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1867 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1868 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1869 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1870 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1871 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1874 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
1875 * \li Action: Toggles change tracking to on/off.
1876 * \li Syntax: changes-track
1877 * \li Origin: levon, 1 Oct 2002
1880 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1882 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
1883 * \li Action: Toggles showing of change tracking in typesetted output.
1884 * \li Syntax: changes-output
1885 * \li Origin: jspitzm, 21 Jan 2005
1888 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1890 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
1891 * \li Action: Moves the cursor to the position of the next change
1892 of the change tracking records.
1893 * \li Syntax: change-next
1894 * \li Origin: schmitt, 4 Oct 2006
1897 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1899 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
1900 * \li Action: Open change tracking dialog for merging and moves the cursor
1901 to the position of the next change.
1902 * \li Syntax: changes-merge
1903 * \li Origin: Levon, 16 Oct 2002
1906 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1908 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
1909 * \li Action: Accepts tracked change inside the selection.
1910 * \li Syntax: change-accept
1911 * \li Origin: Levon, 16 Oct 2002
1914 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1916 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
1917 * \li Action: Rejects tracked change inside the selection.
1918 * \li Syntax: change-accept
1919 * \li Origin: Levon, 16 Oct 2002
1922 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1924 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
1925 * \li Action: Accepts all tracked changes in the document.
1926 * \li Syntax: all-changes-accept
1927 * \li Origin: Levon, 16 Oct 2002
1930 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1932 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
1933 * \li Action: Rejects all tracked changes in the document.
1934 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
1935 * \li Syntax: all-changes-reject
1936 * \li Origin: Levon, 16 Oct 2002
1939 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1942 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1943 * \li Action: Apply data for an inset.
1944 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1945 be applied. This is either changed to #LFUN_INSET_MODIFY or
1946 #LFUN_INSET_INSERT depending on the context where it is called.
1947 * \li Syntax: inset-apply <ARGS>
1948 * \li Params: See #LFUN_INSET_INSERT .
1951 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1953 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1954 * \li Action: Dissolve the current inset into text.
1955 * \li Syntax: inset-dissolve [<INSET>]
1956 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1957 is dissolved. For example "dissolve" entry in the charstyles
1958 sub-menu should only dissolve the charstyle inset, even if the
1959 cursor is inside several nested insets of different type.\n
1960 For values see #lyx::InsetLayout::lyxtype_ .
1961 * \li Author: JSpitz, 7 Aug 2006
1964 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1966 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1967 * \li Action: Insert new inset (type given by the parameters).
1968 * \li Syntax: inset-insert <INSET> <ARGS>
1969 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1970 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1971 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1973 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1974 where <label name> is the name of the referenced label and
1975 <Format> is one of the following: \n
1976 ref -- <reference> \n
1977 eqref -- (<reference>) \n
1978 pageref -- <page> \n
1979 vpageref -- on <page> \n
1980 vref -- <reference> on <page> \n
1981 prettyref -- Formatted reference
1984 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1986 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1987 * \li Action: Modify existing inset.
1988 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1989 bibtex, ert, command, graphics, note, space, vspace, tabular,
1990 bibitem, inlude, ref insets.
1991 * \li Syntax: inset-modify <INSET> <ARGS>
1992 * \li Params: See #LFUN_INSET_INSERT for further details.
1995 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1997 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1998 * \li Action: Modify the inset at cursor position, if there is one.
1999 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2000 bibtex, ert, command, graphics, note, space, vspace, tabular,
2001 bibitem, inlude, ref insets.
2002 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
2003 * \li Params: See #LFUN_INSET_INSERT for further details.
2004 * \li Origin: JSpitzm, 23 Mar 2008
2007 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
2009 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2010 * \li Action: Updates the values inside the dialog from the inset.
2011 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2012 by #LFUN_DIALOG_UPDATE
2013 * \li Params: <DIALOG-NAME>
2014 * \li Origin: leeming, 25 Feb 2003
2017 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2019 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2020 * \li Action: Open the inset's properties dialog.
2021 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2022 * \li Syntax: inset-settings <INSET>
2023 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
2026 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
2028 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
2029 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
2030 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
2031 be entered. Also cf. #LFUN_INSET_SETTINGS.
2032 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
2033 bibtex, ert, command, graphics, note, space, vspace, tabular,
2034 bibitem, inlude, ref insets.
2035 * \li Syntax: next-inset-toggle <ARG>
2036 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
2037 * \li Origin: leeming, 30 Mar 2004
2040 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
2042 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2043 * \li Action: Toggles the collapsable inset we are currently in.
2044 * \li Syntax: inset-toggle [<ARG>]
2045 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2046 open/close/toggle are for collapsable insets. close can be currently used
2047 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
2048 assign is for branch inset.
2049 * \li Origin: lasgouttes, 19 Jul 2001
2052 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
2054 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2055 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2056 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2057 * \li Syntax: all-insets-toggle <STATE> <INSET>
2058 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
2059 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
2060 * \li Origin: leeming, 30 Mar 2004
2063 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2065 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
2066 * \li Action: Unify all graphics insets with the one given as an parameter.
2067 * \li Notion: This is internally used for synchronize certain group of graphics insets.
2068 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
2069 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
2070 (syntax can be seen in .lyx files).
2071 * \li Origin: sanda, 6 May 2008
2074 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", Argument, Edit },
2076 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2077 * \li Action: Set the group for the graphics inset on the cursor position.
2078 * \li Syntax: set-graphics-group [<GROUP>]
2079 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
2080 the graphics inset is removed from the current group.
2081 * \li Origin: sanda, 6 May 2008
2084 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2087 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2088 * \li Action: Moves the cursor out of the current slice, going forward.
2089 * \li Notion: Cursor movement within an inset may be different than cursor
2090 movement in the surrounding text. This action should be called
2091 automatically by the cursor movement within the inset, when
2092 movement within the inset has ceased (reached the end of the
2093 last paragraph, for example), in order to move correctly
2094 back into the surrounding text.
2097 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2099 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2100 * \li Action: Moves the cursor out of the current slice, going backwards.
2101 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2104 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2106 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2107 * \li Action: Moves the cursor out of the current slice, going right.
2108 * \li Notion: See also #LFUN_FINISHED_FORWARD
2111 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2113 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2114 * \li Action: Moves the cursor out of the current slice, going left.
2115 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2118 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2121 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2122 * \li Action: Set language from the current cursor position.
2123 * \li Syntax: language <LANG>
2124 * \li Params: <LANG>: Requested language. Look in lib/languages for
2126 * \li Origin: Dekel, 2 Mar 2000
2129 { LFUN_LANGUAGE, "language", Noop, Edit },
2132 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2133 * \li Action: Goto a label.
2134 * \li Syntax: label-goto [<LABEL>]
2135 * \li Params: <LABEL>: Requested label. If no label is given and refernce
2136 is on cursor position, Bookmark 0 is saved and
2137 cursor moves to the position of referenced label.
2138 * \li Origin: Ale, 6 Aug 1997
2141 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2143 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2144 * \li Action: Inserts label to text or displayed formula.
2145 * \li Syntax: label-insert [<LABEL>]
2146 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2147 name will be opened.
2150 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2152 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2153 * \li Action: Go to the next label or cross-reference.
2154 * \li Syntax: reference-next
2155 * \li Origin: Dekel, 14 Jan 2001
2158 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2161 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2162 * \li Action: Goto a bookmark.
2163 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
2164 if necessary. Note that bookmarsk are saved per-session, not
2166 * \li Syntax: bookmark-goto <NUMBER>
2167 * \li Params: <NUMBER>: the number of the bookmark to restore.
2168 * \li Origin: Dekel, 27 January 2001
2171 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2173 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2174 * \li Action: Save a bookmark.
2175 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2176 must be between 1 and 9, inclusive. Note that bookmarks are
2177 saved per-session, not per file.
2178 * \li Syntax: bookmark-save <NUMBER>
2179 * \li Params: <NUMBER>: the number of the bookmark to save.
2180 * \li Origin: Dekel, 27 January 2001
2183 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2185 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2186 * \li Action: Clears the list of saved bookmarks.
2187 * \li Syntax: bookmark-clear
2188 * \li Origin: bpeng, 31 October 2006
2191 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2194 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2195 * \li Action: Open the given help file according to the language setting.
2196 * \li Syntax: help-open <FILE>[.lyx]
2197 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2198 * \li Author: Jug, 27 Jun 1999
2201 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2203 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2204 * \li Action: Terminates the current LyX instance.
2205 * \li Notion: Terminates the current LyX instance, asking whether to save
2206 modified documents, etc.
2207 * \li Syntax: lyx-quit
2210 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2212 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2213 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2214 * \li Notion: Skiping "auto" when allowauto is false.
2215 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2216 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2217 minibuffer|review|view/update|math_panels
2218 * \li Origin: Edwin, 21 May 2007
2221 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2223 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2224 * \li Action: Opens the menu given by its name.
2225 * \li Syntax: menu-open <NAME>
2226 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2229 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2231 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2232 * \li Action: Various UI visibility-toggling actions.
2233 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
2234 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2235 menubar : Toggle visibility of the menubar.\n
2236 scrollbar : Toggle visibility of the scrollbar.\n
2237 frame : Toggle visibility of the frames around editing window.\n
2238 fullscreen : Toggle fullscreen mode. This also covers calling the
2239 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2240 custom tweaks of the toolbars should be used.
2241 * \li Origin: ps, 9 Feb 2007
2244 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2247 * \var lyx::FuncCode lyx::WINDOW_NEW
2248 * \li Action: Creates new empty LyX window.
2249 * \li Notion: Already opened documents from the previous window can be found under View menu.
2250 * \li Syntax: window-new [<GEOMETRY>]
2251 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2252 accepted only on Windows platform.
2253 * \li Origin: Abdel, 21 Oct 2006
2256 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2258 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2259 * \li Action: Closes the current LyX window.
2260 * \li Syntax: window-close
2261 * \li Origin: Abdel, 23 Oct 2006
2264 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2267 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2268 * \li Action: Creates another split view of current buffer.
2269 * \li Notion: All split views act in the same way indpendently.
2270 * \li Syntax: split-view <vertical|horizontal>
2271 * \li Params: horizontal : The work areas are laid out side by side.\n
2272 vertical : The work areas laid out vertically.\n
2273 * \li Origin: abdel, 20 Feb 2008
2276 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2279 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2280 * \li Action: Close the current tab group.
2281 * \li Notion: This only closes the work areas, not the buffer themselves.
2282 The still opened buffers can be visualized in another tab group.
2283 * \li Syntax: close-tab-group
2284 * \li Origin: abdel, 21 Feb 2008
2287 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2289 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2290 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2291 * \li Syntax: dialog-show <NAME> [<DATA>]
2292 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
2293 document|errorlist|ert|external|file|findreplace|float|graphics|
2294 include|index|info|nomenclature|label|log|mathdelimiter|mathmatrix|
2295 note|paragraph|prefs|print|ref|sendto|space|spellchecker|symbols|
2296 tabular|tabularcreate|thesaurus|texinfo|toc|href|view-source|vspace|
2297 wrap|listings|<SPECIAL> \n
2298 <SPECIAL>: latexlog|vclog \n
2299 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2301 * \li Origin: leeming, 17 Jun 2003
2304 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2306 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2307 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2308 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2309 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2310 * \li Params: See #LFUN_DIALOG_SHOW .
2311 * \li Origin: leeming, 25 Feb 2003
2314 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2316 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2317 * \li Action: Updates the dialog values from the inset/paragraph/document.
2318 * \li Syntax: dialog-update <NAME>
2319 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2321 * \li Origin: leeming, 25 Feb 2003
2324 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2326 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2327 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2328 * \li Syntax: dialog-hide <NAME>
2329 * \li Params: See #LFUN_DIALOG_SHOW .
2330 * \li Origin: leeming, 25 Feb 2003
2333 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2335 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2336 * \li Action: Toggles dialog between showed/hidden state.
2337 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2338 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2339 * \li Params: See #LFUN_DIALOG_SHOW .
2340 * \li Origin: JSpitzm, 30 Apr 2007
2343 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2345 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2346 * \li Action: Closes opened connection to opened inset.
2347 * \li Notion: Connection is used for apply functions.
2348 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2349 * \li Origin: leeming, 25 Feb 2003
2352 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2355 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2356 * \li Action: This function is called when mouse button is pressed (inside workarea).
2357 Action depends on the context.
2358 * \li Notion: This is internal LFUN, not to be used by users.
2359 * \li Origin: André, 9 Aug 2002
2362 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2364 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2365 * \li Action: This function is called when double click on mouse button is
2366 pressed (inside workarea). Action depends on the context.
2367 * \li Notion: This is internal LFUN, not to be used by users.
2368 * \li Origin: André, 9 Aug 2002
2371 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2373 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2374 * \li Action: This function is called when triple click on mouse button is
2375 pressed (inside workarea). Action depends on the context.
2376 * \li Notion: This is internal LFUN, not to be used by users.
2377 * \li Origin: André, 9 Aug 2002
2380 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2382 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2383 * \li Action: This function is called when mouse cursor is moving over the text.
2384 Action depends on the context.
2385 * \li Notion: This is internal LFUN, not to be used by users.
2386 * \li Origin: André, 9 Aug 2002
2389 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2391 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2392 * \li Action: This function is called when mouse button is released (inside workarea).
2393 Action depends on the context.
2394 * \li Notion: This is internal LFUN, not to be used by users.
2395 * \li Origin: André, 9 Aug 2002
2398 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2400 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2401 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2402 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2403 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2406 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2407 * \li Action: Returns the current layout (that is environment) name
2408 on the cursor position.
2409 * \li Syntax: server-get-layout
2412 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2414 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2415 * \li Action: Returns path and file name of the currently edited document.
2416 * \li Syntax: server-get-filename
2419 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2421 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2422 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2423 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
2424 * \li Origin: Edmar, 23 Dec 1998
2427 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2429 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2430 * \li Action: Sends notify message about the last key-sequence to client.
2431 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2432 * \li Syntax: server-notify
2435 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2437 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2438 * \li Action: Sets the cursor position based on the editing area coordinates
2439 (similar as clicking on that point with left mouse button).
2440 * \li Syntax: server-set-xy <X> <Y>
2443 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2445 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2446 * \li Action: Returns the coordinates of cursor position in the editing area.
2447 * \li Syntax: server-get-xy
2450 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2453 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2454 * \li Action: Generates the code (literate programming).
2455 * \li Notion: Latex file with extension \literate_extension is generated.
2456 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2457 \build_error_filter to process the compilation error messages. \n
2458 In case you want to process your literate file with a script, or some other program,
2459 just insert in your lyxrc file an entry with:\n
2460 \build_command "my_script my_arguments" \n
2461 The \build_error_filter differs from the \literate_error_filter only in that the
2462 former will identify error messages from your compiler.
2463 * \li Syntax: build-program
2466 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2469 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2470 * \li Action: Saves the current buffer to a temporary file.
2471 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2472 is called automatically by LyX, to "autosave" the current buffer.
2473 * \li Syntax: buffer-auto-save
2476 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2478 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2479 * \li Action: Loads the given child document.
2480 * \li Notion: The current document is treated as a parent.
2481 * \li Syntax: buffer-child-open <FILE>
2482 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2483 * \li Origin: Ale, 28 May 1997
2486 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2488 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2489 * \li Action: Runs chktex for the current document.
2490 * \li Syntax: buffer-chktex
2491 * \li Origin: Asger, 30 Oct 1997
2494 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2496 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2497 * \li Action: Toggles compression of the current document on/off.
2498 * \li Syntax: buffer-toggle-compression
2499 * \li Origin: bpeng, 27 Apr 2006
2502 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2504 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2505 * \li Action: Closes the current buffer.
2506 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2507 if the buffer has been modified.
2508 * \li Syntax: buffer-close
2511 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2513 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2514 * \li Action: Exports the current buffer (document) to the given format.
2515 * \li Syntax: buffer-export <FORMAT>
2516 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2517 can find in Tools->Preferences->File formats->Format.
2518 Usual format you will enter is "pdf2" (pdflatex),
2519 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2520 In case of "custom" you will be asked for a format you
2521 want to start from and for the command that you want to
2522 apply to this format. Internally the control is then passed
2523 to #LFUN_BUFFER_EXPORT_CUSTOM.
2524 * \li Origin: Lgb, 29 Jul 1997
2527 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2529 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2530 * \li Action: Exports the current buffer (document) from the given format using
2531 the given command on it.
2532 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2533 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2534 intermediate file).\n
2535 <COMMAND> this command will be launched on the file. Note that you can
2536 use "$$FName" string to qualify the intermediate file.
2537 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2538 * \li Origin: leeming, 27 Mar 2004
2541 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2543 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2544 * \li Action: Prints the current document.
2545 * \li Notion: Many settings can be given via the preferences dialog.
2546 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2547 * \li Params: <TARGET> is either "printer" or "file".\n
2548 <TARGER-NAME> is either "default" or file name or printer name.\n
2549 <COMMAND> command ensuring the printing job.
2550 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2551 * \li Origin: leeming, 28 Mar 2004
2554 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2556 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2557 * \li Action: Import a given file as a lyx document.
2558 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2559 defined convertors in preferences. Look into File->Import menu to get
2560 an idea of the currently active import formats.
2561 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2562 * \li Origin: Asger, 24 Jul 1998
2565 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2567 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2568 * \li Action: Creates a new buffer (that is, document).
2569 * \li Notion: Implicit path can be set in Preferences dialog.
2570 * \li Syntax: buffer-new [<FILE>]
2571 * \li Params: <FILE>: filename of created file with absolute path.
2574 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2576 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2577 * \li Action: Creates a new buffer (that is, document) from a template.
2578 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2579 Template will be asked for via Open-dialog.
2580 * \li Syntax: buffer-new-template [<FILE>]
2581 * \li Params: <FILE>: filename of created file with absolute path.
2584 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2586 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2587 * \li Action: Reverts opened document.
2588 * \li Syntax: buffer-reload
2589 * \li Origin: Asger, 2 Feb 1997
2592 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2594 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2595 * \li Action: Switch to the given buffer.
2596 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2597 document in different LyX windows.
2598 * \li Syntax: buffer-new-template <BUFFER>
2599 * \li Params: <BUFFER>: already opened document which is to be shown.
2602 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2604 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2605 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2606 * \li Syntax: buffer-toggle-read-only
2607 * \li Origin: Lgb, 27 May 1997
2610 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2612 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2613 * \li Action: Displays current buffer in chosen format.
2614 * \li Notion: Displays the contents of the current buffer in the chosen
2615 format, for example, PDF or DVI. This runs the necessary
2616 converter, calls the defined viewer, and so forth.
2617 * \li Syntax: buffer-view <FORMAT>
2618 * \li Params: <FORMAT>: The format to display, where this is one of the
2619 formats defined (in the current GUI) in the
2620 Tools>Preferences>File Formats dialog.
2623 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2625 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2626 * \li Action: Exports the current document and put the result into the
2627 temporary directory.
2628 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2629 the output will be rewriten - updated. This is useful in case your viewer
2630 is able to detect such changes (e.g. ghostview for postscript).
2631 * \li Syntax: buffer-update <FORMAT>
2632 * \li Params: <FORMAT>: The format to display, where this is one of the
2633 formats defined (in the current GUI) in the
2634 Tools>Preferences>File Formats dialog.
2635 * \li Origin: Dekel, 5 Aug 2000
2638 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2641 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2642 * \li Action: Saves the current buffer.
2643 * \li Notion: Saves the current buffer to disk, using the filename that
2644 is already associated with the buffer, asking for one if
2645 none is yet assigned.
2646 * \li Syntax: buffer-write
2649 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2651 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2652 * \li Action: Rename and save current buffer.
2653 * \li Syntax: buffer-write-as <FILENAME>
2654 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2655 is with respect to the original location of the buffer/file.
2658 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2660 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2661 * \li Action: Save all changed documents.
2662 * \li Syntax: buffer-write-all
2663 * \li Origin: rgh, gpothier 6 Aug 2007
2666 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2668 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2669 * \li Action: Switch to the next opened document.
2670 * \li Notion: Note that this does not necessarily mean next in tabbar
2671 (for full list see View menu).
2672 * \li Syntax: buffer-next
2675 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2677 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2678 * \li Action: Switch to the previous opened document.
2679 * \li Syntax: buffer-previous
2682 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2684 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2685 * \li Action: When run from a child document, this updates (exports) document built
2686 from the master buffer. If a master is not found, it updates the
2688 * \li Syntax: master-buffer-update
2689 * \li Author: Tommaso, 20 Sep 2007
2692 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2694 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2695 * \li Action: When run from a child document, this command shows a preview built
2696 from the master buffer. If a master is not found, it previews the
2698 * \li Syntax: master-buffer-view
2699 * \li Author: Tommaso, 20 Sep 2007
2702 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2704 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2705 * \li Action: Set language of the current document.
2706 * \li Syntax: buffer-language <LANG>
2707 * \li Params: <LANG>: language name. See lib/languages for list.
2708 * \li Author: leeming, 30 Mar 2004
2711 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2713 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2714 * \li Action: Save the current document settings as default.
2715 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2716 * \li Syntax: buffer-save-as-default [<ARGS>]
2717 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2718 you can find in document header of usual .lyx file.
2719 * \li Author: leeming, 30 Mar 2004
2722 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2724 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2725 * \li Action: Apply the given settings to the current document.
2726 * \li Syntax: buffer-params-apply [<ARGS>]
2727 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2728 you can find in document header of usual .lyx file.
2729 * \li Author: leeming, 30 Mar 2004
2732 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2735 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2736 * \li Action: Inserts another LyX file.
2737 * \li Syntax: file-insert [<FILE>]
2738 * \li Params: <FILE>: Filename to be inserted.
2741 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2743 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2744 * \li Action: Inserts plain text file.
2745 * \li Syntax: file-insert-plaintext [<FILE>]
2746 * \li Params: <FILE>: Filename to be inserted.
2747 * \li Origin: CFO-G, 19 Nov 1997
2750 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2752 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2753 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2754 * \li Syntax: file-insert-plaintext-para [<FILE>]
2755 * \li Params: <FILE>: Filename to be inserted.
2756 * \li Origin: Levon, 14 Feb 2001
2759 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2761 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2762 * \li Action: Open LyX document.
2763 * \li Syntax: file-open [<FILE>]
2764 * \li Params: <FILE>: Filename to be opened.
2767 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2770 * \var lyx::FuncCode lyx::LFUN_CALL
2771 * \li Action: Executes a command defined in a .def file.
2772 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2773 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2774 where <NAME> is the name of the new command and <LFUN> is the lfun code
2775 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2776 \\def_file "FileName" allows to include another .def file. \n
2777 This is particularly useful in connection with toolbar buttons:
2778 Since the name of the button image for this lfun is
2779 lib/images/commands/<NAME>.png this is the way to assign an image
2780 to a complex command-sequence.
2781 * \li Syntax: call <NAME>
2782 * \li Params: <NAME>: Name of the command that must be called.
2783 * \li Origin: broider, 2 Oct 2007
2786 { LFUN_CALL, "call", NoBuffer, System },
2788 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2789 * \li Action: Simulate halting Meta key (Alt key on PCs).
2790 * \li Notion: Used for buffer editation not for GUI control.
2791 * \li Syntax: meta-prefix
2794 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2796 * \var lyx::FuncCode lyx::LFUN_CANCEL
2797 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2798 * \li Syntax: cancel
2801 { LFUN_CANCEL, "cancel", NoBuffer, System },
2804 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2805 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2806 * \li Notion: Usually bound to M-x shortcut.
2807 * \li Syntax: command-execute
2810 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2811 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2813 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2814 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2815 * \li Syntax: command-sequence <CMDS>
2816 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2817 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2818 * \li Origin: Andre', 11 Nov 1999
2821 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2823 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2824 * \li Action: Shows message in statusbar (for script purposes).
2825 * \li Syntax: message <STRING>
2826 * \li Origin: Lgb, 8 Apr 2001
2829 { LFUN_MESSAGE, "message", NoBuffer, System },
2831 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2832 * \li Action: Save user preferences.
2833 * \li Syntax: preferences-save
2834 * \li Origin: Lgb, 27 Nov 1999
2837 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2839 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2840 * \li Action: Reconfigure the automatic settings.
2841 * \li Syntax: reconfigure
2842 * \li Origin: Asger, 14 Feb 1997
2845 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2847 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2848 * \li Action: Apply the given settings to user preferences.
2849 * \li Syntax: lyxrc-apply <SETTINGS>
2850 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2851 to get an idea which commands to use and their syntax.
2852 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2855 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2857 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2858 * \li Action: Determine whether keep cursor inside the editing window regardless
2859 the scrollbar movement.
2860 * \li Syntax: toggle-cursor-follows-scrollbar
2861 * \li Origin: ARRae, 2 Dec 1997
2864 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2866 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2867 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2868 * \li Notion: A new color entry is created if the color is unknown.
2869 Color names can be stored as a part of user settings.
2870 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2871 * \li Origin: SLior, 11 Jun 2000
2874 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2876 * \var lyx::FuncCode lyx::LFUN_STATISTICS
2877 * \li Action: Count the statistics (number of words and characters)
2878 in the document or in the given selection.
2879 * \li Notion: Note that this function gives the number of words/chars written,
2880 not the number of characters which will be typeset.
2881 * \li Syntax: statistics
2882 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2885 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2887 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2888 * \li Action: Show the inline completion at the cursor position.
2889 * \li Syntax: completion-inline
2890 * \li Origin: sts, Feb 19 2008
2893 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2895 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2896 * \li Action: Show the completion popup at the cursor position.
2897 * \li Syntax: completion-popup
2898 * \li Origin: sts, Feb 19 2008
2901 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2903 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2904 * \li Action: Try to complete the word or command at the cursor position.
2905 * \li Syntax: completion-complete
2906 * \li Origin: sts, Feb 19 2008
2909 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2911 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2912 * \li Action: Activate the branch
2913 * \li Syntax: branch-activate <BRANCH>
2914 * \li Params: <BRANCH>: The branch to activate
2915 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2916 could be used to export a pdf with the answers branch included
2917 without one's having to open LyX and activate the branch manually.
2918 * \li Origin: rgh, 27 May 2008
2921 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2923 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2924 * \li Action: De-activate the branch
2925 * \li Syntax: branch-deactivate <BRANCH>
2926 * \li Params: <BRANCH>: The branch to deactivate
2927 * \li Origin: rgh, 27 May 2008
2930 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2932 { LFUN_NOACTION, "", Noop, Hidden }
2933 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2936 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2937 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2944 LyXAction::LyXAction()
2950 // Returns an action tag from a string.
2951 FuncRequest LyXAction::lookupFunc(string const & func) const
2953 string const func2 = trim(func);
2955 if (func2.empty()) {
2956 return FuncRequest(LFUN_NOACTION);
2960 string const arg = split(func2, cmd, ' ');
2962 func_map::const_iterator fit = lyx_func_map.find(cmd);
2964 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2968 string const LyXAction::getActionName(FuncCode action) const
2970 info_map::const_iterator const it = lyx_info_map.find(action);
2971 return it != lyx_info_map.end() ? it->second.name : string();
2975 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2977 info_map::const_iterator const it = lyx_info_map.find(action);
2978 return it != lyx_info_map.end() ? it->second.type : Hidden;
2982 bool LyXAction::funcHasFlag(FuncCode action,
2983 LyXAction::func_attrib flag) const
2985 info_map::const_iterator ici = lyx_info_map.find(action);
2987 if (ici == lyx_info_map.end()) {
2988 LYXERR0("action: " << action << " is not known.");
2989 LASSERT(false, /**/);
2992 return ici->second.attrib & flag;
2996 LyXAction::const_func_iterator LyXAction::func_begin() const
2998 return lyx_func_map.begin();
3002 LyXAction::const_func_iterator LyXAction::func_end() const
3004 return lyx_func_map.end();