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
12 * Full author contact details are available in file CREDITS.
17 #include "LyXAction.h"
19 #include "FuncRequest.h"
21 #include "support/debug.h"
22 #include "support/lstrings.h"
24 #include "support/lassert.h"
29 using namespace lyx::support;
34 NAMING RULES FOR USER-COMMANDS
35 Here's the set of rules to apply when a new command name is introduced:
37 1) Use the object.event order. That is, use `word-forward'
38 instead of `forward-word'.
39 2) Don't introduce an alias for an already named object. Same for events.
40 3) Forward movement or focus is called `forward' (not `right').
41 4) Backward movement or focus is called `backward' (not `left').
42 5) Upward movement of focus is called `up'.
43 6) Downward movement is called `down'.
44 7) The begin of an object is called `begin' (not `start').
45 8) The end of an object is called `end'.
47 (May 19 1996, 12:04, RvdK)
52 * The documentation below is primarily description of purpose and syntax
53 * relating to the different LFUNs.
55 * Try to find an appropriate (thematical) place when adding the new LFUN
56 * and don't forget to add doxygen commentary.
58 * Doxygen template below. Some notes: Parameters should be set in uppercase
59 * and put in <BRACKETS>, [<PARAM>] means optional one.
63 * \var lyx::FuncCode lyx::LFUN_
76 void LyXAction::newFunc(FuncCode action, string const & name,
77 unsigned int attrib, LyXAction::func_type type)
79 lyx_func_map[name] = action;
82 tmpinfo.attrib = attrib;
84 lyx_info_map[action] = tmpinfo;
88 // Needed for LFUNs documentation to be accepted, since doxygen won't take
89 // \var inside functions.
90 #ifndef DOXYGEN_SHOULD_SKIP_THIS
91 void LyXAction::init()
93 // This function was changed to use the array below in initalization
94 // instead of calling newFunc numerous times because of compilation
95 // times. Since the array is not static we get back the memory it
96 // occupies after the init is completed. It compiles several
109 ev_item const items[] = {
112 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
113 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
114 to the next character typed.
115 * \li Syntax: accent-acute
118 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
120 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
121 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
122 to the next character typed.
123 * \li Syntax: accent-breve
126 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
128 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
129 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
130 to the next character typed.
131 * \li Syntax: accent-caron
134 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
136 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
137 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
138 to the next character typed.
139 * \li Syntax: accent-cedilla
142 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
144 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
145 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
146 to the next character typed.
147 * \li Syntax: accent-circle
150 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
152 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
153 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
154 to the next character typed.
155 * \li Syntax: accent-circumflex
158 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
160 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
161 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
162 to the next character typed.
163 * \li Syntax: accent-dot
166 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
168 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
169 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
170 to the next character typed.
171 * \li Syntax: accent-grave
174 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
176 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
177 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
178 to the next character typed.
179 * \li Syntax: accent-grave
182 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
184 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
185 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
186 to the next character typed.
187 * \li Syntax: accent-macron
190 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
192 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
193 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
194 to the next character typed.
195 * \li Syntax: accent-ogonek
198 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
200 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
201 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
202 over the next two character typed.
203 * \li Notion: The following char will finish the tie.
204 * \li Syntax: accent-tie
207 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
209 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
210 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
211 over the next character typed.
212 * \li Syntax: accent-tilde
215 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
217 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
218 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
219 over the next character typed.
220 * \li Syntax: accent-umlaut
223 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
225 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
226 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
227 under the next character typed.
228 * \li Syntax: accent-underbar
231 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
233 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
234 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
235 under the next character typed.
236 * \li Syntax: accent-underdot
239 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
242 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
243 * \li Action: Inserts a caption inset.
244 * \li Syntax: caption-insert
245 * \li Origin: Lgb, 18 Jul 2000
248 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
250 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
251 * \li Action: Inserts the current date.
252 * \li Syntax: date-insert [<ARG>]
253 * \li Params: <ARG>: Format of date. The default value (%x) can be set
254 in Preferences->Date format. For possible formats
255 see manual page of strftime function.
256 * \li Origin: jdblair, 31 Jan 2000
259 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
261 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
262 * \li Action: Inserts a footnote inset.
263 * \li Syntax: footnote-insert
264 * \li Origin: Jug, 7 Mar 2000
267 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
269 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
270 * \li Action: Inserts an ERT inset.
271 * \li Syntax: ert-insert
272 * \li Origin: Jug, 18 Feb 2000
275 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
277 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
278 * \li Action: Inserts a float inset.
279 * \li Syntax: float-insert <TYPE>
280 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
281 "algorithm", "table", "figure" parameters can be given.
282 * \li Origin: Lgb, 27 Jun 2000
285 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
287 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
288 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
289 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
290 * \li Syntax: float-wide-insert <TYPE>
291 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
292 "algorithm", "table", "figure" parameters can be given.
293 * \li Origin: Lgb, 31 Oct 2001
296 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
298 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
299 * \li Action: Inserts the list of floats in the document.
300 * \li Syntax: float-list-insert <TYPE>
301 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
302 "algorithm", "table", "figure" parameters can be given.
303 * \li Origin: Lgb, 3 May 2001
306 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
308 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
309 * \li Action: Inserts floats wrapped by the text around.
310 * \li Syntax: wrap-insert <TYPE>
311 * \li Params: <TYPE>: table|figure
312 * \li Origin: Dekel, 7 Apr 2002
315 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
317 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
318 * \li Action: Inserts an optional-argument (short title) inset.
319 * \li Syntax: optional-insert
320 * \li Origin: vermeer, 12 Aug 2002
323 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
325 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
326 * \li Action: Inserts a horizontal line.
327 * \li Syntax: line-insert
328 * \li Origin: Andre, Oct 27 2003
331 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
333 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
334 * \li Action: Inserts a new page.
335 * \li Syntax: newpage-insert <ARG>
336 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
337 * \li Origin: uwestoehr, 24 Nov 2007
340 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
342 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
343 * \li Action: Inserts a marginal note.
344 * \li Syntax: marginalnote-insert
345 * \li Origin: Lgb, 26 Jun 2000
348 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
350 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
351 * \li Action: Inserts a single unicode character.
352 * \li Syntax: unicode-insert <CHAR>
353 * \li Params: <CHAR>: The character to insert, given as its code
354 point, in hexadecimal.
355 * \li Sample: unicode-insert 0x0100
356 * \li Origin: Lgb, 22 Oct 2006
359 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
361 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
362 * \li Action: Inserts a new listings inset.
363 * \li Syntax: listing-insert
364 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
367 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
369 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
370 * \li Action: Insert a tab into a listings inset.
371 * \li Notion: It also works on a selection.
372 * \li Syntax: tab-insert
373 * \li Origin: vfvanravesteijn, Sep 30 2008
376 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
378 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
379 * \li Action: Delete a tab or up to an equivalent amount of spaces from
381 * \li Notion: It also works on a selection - it removes a tab or spaces from the
382 beginning of each line spanned by the selection. This is useful if
383 you want to indent/unindent multiple lines in one action.
384 * \li Syntax: tab-delete
385 * \li Origin: vfvanravesteijn, Sep 30 2008
388 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
390 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
391 * \li Action: Inserts quotes according to the type and quote-language preference.
392 * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
394 * \li Syntax: quote-insert [<TYPE>]
395 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
398 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
400 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
401 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
402 information in a non-editable boxed InsetText.
403 * \li Notion: Apart from lfun arguments you can use the following method: \n
404 1. input the type and argument of this inset, e.g. "menu paste", in
406 2. select the text and run info-insert lfun.
407 * \li Syntax: info-insert <TYPE> <ARG>
408 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
409 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
411 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
412 * \li Origin: bpeng, 7 Oct 2007
415 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
417 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
418 * \li Action: Inserts branch inset.
419 * \li Syntax: branch-insert <BRANCH-NAME>
420 * \li Origin: vermeer, 17 Aug 2003
423 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
425 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
426 * \li Action: Inserts Box inset.
427 * \li Syntax: box-insert [<TYPE>]
428 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
429 Framed is the default one.
430 * \li Origin: vermeer, 7 Oct 2003
433 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
435 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
436 * \li Action: Inserts CharStyle, Custom inset or XML short element.
437 * \li Notion: Look into the Customization manual for more information about
439 To make this command enabled the layout file for the document
440 class you're using has to load the character styles. There are
441 a few contained in the Logical Markup module. You can also of
442 course create some yourself. \n
443 For dissolving the element see #LFUN_INSET_DISSOLVE.
444 * \li Syntax: flex-insert <TYPE:Name>
445 * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
446 Identifies whether this is a Character Style, a
447 Custom Inset or an XML Element, and which dynamical
448 sub-menu this flex inset is in on the LyX menu tree.
449 If Standard (currently unused): none of these.
450 Name: This name must be defined either in your layout file
451 or imported by some module. The definition is \n
452 InsetLayout <TYPE:Name>
453 * \li Sample: flex-insert CharStyle:Code
456 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
458 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
459 * \li Action: Inserts the given string (accordingly to the correct keymap).
460 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
461 settings "auto_region_delete".
462 * \li Syntax: self-insert <STRING>
465 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
467 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
468 * \li Action: Inserts one of horizontal space insets.
469 * \li Syntax: space-insert <NAME> [<LEN>]
470 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
471 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
473 <LEN>: length for custom spaces (hspace, hspace* for protected)
474 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
477 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
479 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
480 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
481 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
482 * \li Syntax: href-insert [<TARGET>]
483 * \li Origin: CFO-G, 21 Nov 1997
486 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
488 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
489 * \li Action: Inserts various characters into the document.
490 * \li Syntax: specialchar-insert <CHAR>
491 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
492 end-of-sentence, menu-separator.
493 * \li Origin: JSpitzm, 6 Dec 2007
496 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
498 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
499 * \li Action: Inserts table of contents.
500 * \li Syntax: toc-insert
501 * \li Origin: Lgb, 27 May 97
504 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_APPENDIX
507 * \li Action: Start (or remove) Appendix on the given cursor position.
508 * \li Syntax: appendix
509 * \li Origin: ettrich, 5 May 1998
512 { LFUN_APPENDIX, "appendix", Noop, Edit },
515 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
516 * \li Action: Inserts Index entry.
517 * \li Notion: It automatically takes the word on the cursor position.
518 * \li Syntax: index-insert
519 * \li Origin: leeming, 3 Aug 2000
522 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
524 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
525 * \li Action: Inserts list of Index entries on a new page.
526 * \li Syntax: index-print
527 * \li Origin: Lgb, 27 Feb 1997
530 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
533 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
534 * \li Action: Inserts Nomenclature entry.
535 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
536 * \li Syntax: nomencl-insert [<SYMBOL>]
537 * \li Origin: Ugras, 4 Nov 2006
540 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
542 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
543 * \li Action: Inserts list of Nomenclature entries.
544 * \li Syntax: nomenclature-print
545 * \li Origin: Ugras, 4 Nov 2006
548 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
551 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
552 * \li Action: Inserts Note on the current cursor postion,
553 move selection inside the inset.
554 * \li Syntax: note-insert [<TYPE>]
555 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
558 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
560 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
561 * \li Action: Moves the cursor to the begining of next Note inset.
562 * \li Syntax: note-next
565 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
567 * \var lyx::FuncCode lyx::LFUN_NOTES_MUTATE
568 * \li Action: Changes all Note insets of a particular type (source)
569 to a different type (target) fot the current document.
570 * \li Syntax: notes-mutate <SOURCE> <TARGET>
571 * \li Params: <SOURCE/TARGET>: Note|Comment|Greyedout
572 * \li Origin: sanda, 18 Jun 2008
575 { LFUN_NOTES_MUTATE, "notes-mutate", Argument, Edit },
577 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
578 * \li Action: Inserts phantom on the current cursor postion,
579 move selection inside the inset.
580 * \li Syntax: phantom-insert [<TYPE>]
581 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
582 * \li Origin: uwestoehr, 30 Jan 2009
585 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
587 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
588 * \li Action: Inserts a line break or new line.
589 * \li Syntax: newline-insert [<ARG>]
590 * \li Params: <ARG>: <newline|linebreak> default: newline
591 * \li Origin: JSpitzm, 25 Mar 2008
594 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
596 * \var lyx::FuncCode lyx::LFUN_ESCAPE
597 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
599 * \li Origin: Lgb, 17 May 2001
602 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
604 * \var lyx::FuncCode lyx::LFUN_DOWN
605 * \li Action: Moves the cursor one line in downward direction.
609 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
611 * \var lyx::FuncCode lyx::LFUN_UP
612 * \li Action: Moves the cursor one line in upward direction.
616 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
618 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
619 * \li Action: Moves the cursor one line in downward direction adding the current
620 position to the selection.
621 * \li Syntax: down-select
624 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
626 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
627 * \li Action: Moves the cursor one line in upward direction adding the current
628 position to the selection.
629 * \li Syntax: up-select
632 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
634 * \var lyx::FuncCode lyx::SCREEN_DOWN
635 * \li Action: Moves the cursor one page in downward direction.
636 * \li Syntax: screen-down
639 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
641 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
642 * \li Action: Moves the cursor one page in upward direction.
643 * \li Syntax: screen-up
646 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
648 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
649 * \li Action: Moves the cursor one screen in downward direction adding the current
650 position to the selection.
651 * \li Syntax: screen-down-select
654 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
656 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
657 * \li Action: Moves the cursor one page in upward direction adding the current
658 position to the selection.
659 * \li Syntax: screen-up-select
662 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
664 * \var lyx::FuncCode lyx::LFUN_SCROLL
665 * \li Action: Scroll the buffer view.
666 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
667 * \li Syntax: scroll <TYPE> <QUANTITY>
668 * \li Params: <TYPE>: line|page\n
669 <QUANTITY>: up|down|<number>
670 * \li Origin: Abdel, Dec 27 2007
673 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
675 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
676 * \li Action: Recenters the screen on the current cursor position.
677 * \li Syntax: screen-recenter
680 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
683 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
684 * \li Action: Repositions the screen such that the cursor is visible.
685 * \li Syntax: screen-show-cursor
686 * \li Origin: vfr, 25 Mar 2009
689 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
692 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
693 * \li Action: Moves the cursor one position logically backwards.
694 * \li Notion: This is not the action which should be bound to the arrow keys,
695 because backwards may be left or right, depending on the
696 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
697 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
698 * \li Syntax: char-backward
701 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
703 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
704 * \li Action: Moves the cursor one position logically backwards, adding
705 traversed position to the selection.
706 * \li Notion: See also #LFUN_CHAR_BACKWARD.
707 * \li Syntax: char-backward-select
710 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
712 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
713 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
714 * \li Syntax: char-delete-backward
717 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
719 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
720 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
721 * \li Syntax: char-delete-forward
724 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
726 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
727 * \li Action: Moves the cursor one position logically forward.
728 * \li Notion: This is not the action which should be bound to the arrow keys,
729 because forward may be left or right, depending on the language.
730 The arrow keys should be bound to #LFUN_CHAR_LEFT or
731 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
732 * \li Syntax: char-forward
735 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
737 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
738 * \li Action: Moves the cursor one position logically forward, adding
739 traversed position to the selection.
740 * \li Notion: See also #LFUN_CHAR_FORWARD.
741 * \li Syntax: char-forward-select
744 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
746 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
747 * \li Action: Moves the cursor one position "to the left".
748 * \li Notion: This is the action which should be taken when the "left" key
749 is pressed. Generally, it moves the cursor one position to the
750 left. However, in Bidi text this become slightly more
751 complicated, and there are different modes of cursor movement.
752 In "visual mode", this moves left, plain and simple. In "logical
753 mode", movement is logically forward in RTL paragraphs, and
754 logically backwards in LTR paragraphs.
755 * \li Syntax: char-left
758 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
760 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
761 * \li Action: Moves the cursor one position "to the left", adding
762 traversed position to the selection.
763 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
764 * \li Syntax: char-left-select
767 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
769 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
770 * \li Action: Moves the cursor one position "to the right".
771 * \li Notion: This is the action which should be taken when the "right" key
772 is pressed. Generally, it moves the cursor one position to the
773 right. However, in Bidi text this become slightly more
774 complicated, and there are different modes of cursor movement.
775 In "visual mode", this moves right, plain and simple. In "logical
776 mode", movement is logically forward in LTR paragraphs, and
777 logically backwards in RTL paragraphs.
778 * \li Syntax: char-right
781 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
783 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
784 * \li Action: Moves the cursor one position "to the right", adding
785 traversed position to the selection.
786 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
787 * \li Syntax: char-right-select
790 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
793 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
794 * \li Action: Moves the cursor to the logically previous beginning of a word.
795 * \li Notion: This is not the action which should be bound to the arrow keys,
796 because backwards may be left or right, depending on the
797 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
798 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
799 * \li Syntax: word-backward
802 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
804 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
805 * \li Action: Moves the cursor to the logically previous beginning of a word,
806 adding the logically traversed text to the selection.
807 * \li Notion: See also #LFUN_WORD_BACKWARD.
808 * \li Syntax: word-backward-select
811 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
813 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
814 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
815 * \li Syntax: word-delete-backward
818 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
820 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
821 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
822 * \li Syntax: word-delete-forward
825 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
827 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
828 * \li Action: Search for a given string in forward direction.
829 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
830 * \li Syntax: word-find-forward [<STRING>]
831 * \li Origin: Etienne, 16 Feb 1998
834 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
836 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
837 * \li Action: Search for a given string in backward direction.
838 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
839 * \li Syntax: word-find-backward [<STRING>]
840 * \li Origin: Etienne, 20 Feb 1998
843 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
845 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
846 * \li Action: Search for next occurence of a string.
847 * \li Syntax: word-find [<DATA>]
848 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
849 If no parameter is given, search with last find-dialog
850 data is used for search (i.e. find-next).
851 * \li Origin: Andre, Jan 7 2004
854 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
856 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
857 * \li Action: Replace a string in the document.
858 * \li Syntax: word-replace [<DATA>]
859 * \li Params: <DATA>: data is of the form
862 <casesensitive> <matchword> <all> <forward>"
863 * \li Origin: Andre, Jan 7 2004
866 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
868 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
869 * \li Action: Search for next occurence of a pattern.
870 * \li Syntax: word-findadv [<DATA>]
871 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
872 If no parameter is given, search with last find-dialog
873 data is used for search (i.e. find-next).
874 * \li Origin: Tommaso, Nov 15 2007
877 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly, Edit },
878 /*! \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
879 * \li Action: Moves the cursor to the logically next beginning of a word.
880 * \li Notion: This is not the action which should be bound to the arrow keys,
881 because forward may be left or right, depending on the language.
882 The arrow keys should be bound to #LFUN_WORD_LEFT or
883 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
884 * \li Syntax: word-forward
887 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
889 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
890 * \li Action: Moves the cursor to the logically next beginning of a word,
891 adding the logically traversed text to the selection.
892 * \li Notion: See also #LFUN_WORD_FORWARD.
893 * \li Syntax: word-forward-select
896 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
898 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
899 * \li Action: Moves the cursor to the next beginning of a word "on the left".
900 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
901 "left" key is pressed. Generally, it moves the cursor to the
902 next beginning of a word on the left. However, in Bidi text this
903 become slightly more complicated, and there are different modes
904 of cursor movement. In "visual mode", this moves left, plain and
905 simple. In "logical mode", movement is logically forward in RTL
906 paragraphs, and logically backwards in LTR paragraphs.
907 * \li Syntax: word-left
908 * \li Origin: dov, 28 Oct 2007
911 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
913 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
914 * \li Action: Moves the cursor to the next beginning of a word "on the left",
915 adding *logically* traversed text to the selection.
916 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
917 * \li Syntax: word-left-select
918 * \li Origin: dov, 28 Oct 2007
921 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
923 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
924 * \li Action: Moves the cursor to the next beginning of a word "on the right".
925 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
926 "right" key is pressed. Generally, it moves the cursor to the
927 next beginning of a word on the right. However, in Bidi text
928 this become slightly more complicated, and there are different
929 modes of cursor movement. In "visual mode", this moves right,
930 plain and simple. In "logical mode", movement is logically
931 forward in LTR paragraphs, and logically backwards in RTL
933 * \li Syntax: word-right
934 * \li Origin: dov, 28 Oct 2007
937 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
939 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
940 * \li Action: Moves the cursor to the next beginning of a word "on the right",
941 adding *logically* traversed text to the selection.
942 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
943 * \li Syntax: word-right-select
944 * \li Origin: dov, 28 Oct 2007
947 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
949 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
950 * \li Action: Puts the word where the cursor stands into the selection.
951 * \li Syntax: word-select
952 * \li Origin: Andre, 11 Sep 2002
955 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
957 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
958 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
959 or the letter on the cursor position.
960 * \li Syntax: word-capitalize
963 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
965 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
966 * \li Action: Change the words in the selection or from the cursor position
967 to the end of word to the upper case.
968 * \li Syntax: word-upcase
971 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
973 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
974 * \li Action: Change the words in the selection or from the cursor position
975 to the end of word to the lower case.
976 * \li Syntax: word-lowcase
979 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
981 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
982 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
983 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
984 * \li Params: <STRING>: word to look up
985 <LANG>: language (see file languages)
986 * \li Origin: Levon, 20 Jul 2001
989 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
991 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
992 * \li Action: Move the cursor to the beginning of the document.
993 * \li Syntax: buffer-begin
996 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
998 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
999 * \li Action: Move the cursor to the beginning of the document adding the
1000 traversed text to the selection.
1001 * \li Syntax: buffer-begin-select
1004 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1006 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1007 * \li Action: Move the cursor to the end of the document.
1008 * \li Syntax: buffer-end
1011 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1013 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1014 * \li Action: Move the cursor to the end of the document adding the
1015 traversed text to the selection.
1016 * \li Syntax: buffer-end-select
1019 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1022 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1023 * \li Action: Move the cursor to the beginning of the current inset
1024 if it is not already there, or at the beginning of the
1025 enclosing inset otherwise
1026 * \li Syntax: inset-begin
1027 * \li Origin: JMarc, 2009/03/16
1030 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1032 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1033 * \li Action: Move the cursor to the beginning of the current inset
1034 if it is not already there, or at the beginning of the
1035 enclosing inset otherwise (adding the
1036 traversed text to the selection).
1037 * \li Syntax: inset-begin-select
1038 * \li Origin: JMarc, 2009/03/16
1041 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1043 * \var lyx::FuncCode lyx::LFUN_INSET_END
1044 * \li Action: Move the cursor to the end of the current inset
1045 if it is not already there, or at the end of the
1046 enclosing inset otherwise
1047 * \li Syntax: inset-end
1048 * \li Origin: JMarc, 2009/03/16
1051 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1053 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1054 * \li Action: Move the cursor to the end of the current inset
1055 if it is not already there, or at the end of the
1056 enclosing inset otherwise (adding the
1057 traversed text to the selection).
1058 * \li Syntax: inset-end-select
1059 * \li Origin: JMarc, 2009/03/16
1062 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1065 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1066 * \li Action: Move the cursor to the begining of the (screen) line.
1067 * \li Syntax: line-begin
1070 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1072 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1073 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1074 traversed text to the selection.
1075 * \li Syntax: line-begin-select
1078 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1080 * \var lyx::FuncCode lyx::LFUN_LINE_END
1081 * \li Action: Move the cursor to the end of the (screen) line.
1082 * \li Syntax: line-end
1085 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1087 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1088 * \li Action: Move the cursor to the end of the (screen) line adding the
1089 traversed text to the selection.
1090 * \li Syntax: line-end-select
1093 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1095 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1096 * \li Action: Deletes the letters to the end of the (screen) line or
1097 deletes the selection.
1098 * \li Syntax: line-delete-forward
1101 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1103 * \var lyx::FuncCode lyx::LFUN_COPY
1104 * \li Action: Copies to the clipboard the last edit.
1108 { LFUN_COPY, "copy", ReadOnly, Edit },
1110 * \var lyx::FuncCode lyx::LFUN_CUT
1111 * \li Action: Cuts to the clipboard.
1115 { LFUN_CUT, "cut", Noop, Edit },
1117 * \var lyx::FuncCode lyx::LFUN_PASTE
1118 * \li Action: Pastes material from the active clipboard.
1119 * \li Syntax: paste [<TYPE>]
1120 * \li Params: <TYPE>: pdf|png|jpeg|linkback
1123 { LFUN_PASTE, "paste", Noop, Edit },
1125 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1126 * \li Action: Pastes text from the active clipboard.
1127 * \li Syntax: clipboard-paste [<ARG>]
1128 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1129 * \li Origin: baum, 10 Jul 2006
1132 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1134 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1135 * \li Action: Pastes the currently text selected text.
1136 * \li Notion: Primary selection mechanism is linux-only thing.
1137 * \li Syntax: primary-selection-paste [<ARG>]
1138 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1141 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1143 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1144 * \li Action: Pastes the text in permanent selection.
1145 * \li Syntax: selection-paste
1148 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1150 * \var lyx::FuncCode lyx::LFUN_UNDO
1151 * \li Action: Undoes the last edit.
1155 { LFUN_UNDO, "undo", Noop, Edit },
1157 * \var lyx::FuncCode lyx::LFUN_REDO
1158 * \li Action: Redoes the last thing undone.
1162 { LFUN_REDO, "redo", Noop, Edit },
1164 * \var lyx::FuncCode lyx::LFUN_REPEAT
1165 * \li Action: Repeat the given command.
1166 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1167 * \li Origin: Andre, 27 Oct 2003
1170 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1172 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1173 * \li Action: Transposes the character at the cursor with the one before it.
1174 * \li Syntax: chars-transpose
1175 * \li Origin: Lgb, 25 Apr 2001
1178 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1181 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1182 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1184 * \li Syntax: depth-decrement
1187 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1189 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1190 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1192 * \li Syntax: depth-increment
1195 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1198 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1199 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1200 * \li Syntax: font-bold
1203 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1206 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1207 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1208 * \li Syntax: font-boldsymbol
1211 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1213 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1214 * \li Action: Toggles the typewriter family font (selection-wise).
1215 * \li Syntax: font-typewriter
1218 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1220 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1221 * \li Action: Toggles underline in the font (selection-wise).
1222 * \li Syntax: font-underline
1225 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1227 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1228 * \li Action: Toggles the emphasis font style (selection-wise).
1229 * \li Syntax: font-emph
1232 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1234 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1235 * \li Action: Toggles Noun text style font (selection-wise).
1236 * \li Syntax: font-noun
1239 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1241 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1242 * \li Action: Toggles Roman family font (selection-wise).
1243 * \li Syntax: font-roman
1246 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1248 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1249 * \li Action: Toggles Sans Serif family font (selection-wise).
1250 * \li Syntax: font-sans
1253 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1255 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1256 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1257 * \li Syntax: font-frak
1258 * \li Origin: vermeer, 10 Jan 2002
1261 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1263 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1264 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1265 * \li Syntax: font-ital
1266 * \li Origin: vermeer, 10 Jan 2002
1269 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1271 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1272 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1273 * \li Syntax: font-default
1276 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1278 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1279 * \li Action: Sets font size according to lyx format string.
1280 * \li Syntax: font-size <SIZE>
1281 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1282 largest|huge|giant|increase|decrease|default
1285 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1287 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1288 * \li Action: Toggle user-defined (=last-time used) text style.
1289 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1290 automatically trigerred when using Text Style dialog.
1291 * \li Syntax: textstyle-apply
1292 * \li Origin: leeming, 12 Mar 2003
1295 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1297 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1298 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1299 * \li Syntax: textstyle-update <FONT_INFO>
1300 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1301 size, emph, noun, underbar, number, color, language,
1303 Use lyx -dbg action for exact syntax of text-style
1305 * \li Origin: leeming, 12 Mar 2003
1308 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1310 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1311 * \li Action: Update fonts and its metrics.
1312 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1313 * \li Syntax: screen-font-update
1314 * \li Origin: ARRae, 13 Aug 2000
1317 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1319 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1320 * \li Action: Returns the info about the current font.
1321 * \li Syntax: font-state
1324 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1327 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1328 * \li Action: Inserts citation from loaded citation database.
1329 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1330 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1331 <TEXT_BEFORE>: text which should appear before citation.
1332 * \li Origin: AAS, 97-02-23
1335 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1337 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1338 * \li Action: Adds database, which will be used for bibtex citations.
1339 * \li Notion: Databases are added to the first BibTeX inset
1340 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1341 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1342 * \li Origin: Ale, 30 May 1997
1345 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1347 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1348 * \li Action: Adds database, which will be used for bibtex citations.
1349 * \li Notion: Databases are deleted from the first BibTeX inset
1350 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1351 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1352 * \li Origin: Ale, 30 May 1997
1355 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1358 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1359 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1360 * \li Syntax: layout <LAYOUT>
1361 * \li Params: <LAYOUT>: the layout to use
1364 { LFUN_LAYOUT, "layout", Noop, Layout },
1366 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1367 * \li Action: Launches the paragraph settings dialog.
1368 * \li Syntax: layout-paragraph
1371 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1373 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1374 * \li Action: Launches the tabular settings dialog.
1375 * \li Syntax: layout-tabular
1376 * \li Origin: Jug, 31 Jul 2000
1379 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1381 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1382 * \li Action: Displays list of layout choices.
1383 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1384 dropbox allowing for choice of layout.
1385 * \li Syntax: drop-layouts-choice
1388 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1390 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1391 * \li Action: Clears the module list.
1392 * \li Notion: Clears the list of included modules for the current buffer.
1393 * \li Syntax: layout-modules-clear
1394 * \li Origin: rgh, 25 August 2007
1397 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1399 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1400 * \li Action: Adds a module.
1401 * \li Notion: Adds a module to the list of included modules for the current buffer.
1402 * \li Syntax: layout-module-add <MODULE>
1403 * \li Params: <MODULE>: the module to be added
1404 * \li Origin: rgh, 25 August 2007
1407 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1409 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1410 * \li Action: Reloads layout information.
1411 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1412 recognizing any changes that have been made to layout files on the fly.
1413 This is intended to be used only by layout developers and should not be
1414 used when one is trying to do actual work.
1415 * \li Syntax: layout-reload
1416 * \li Origin: rgh, 3 September 2007
1419 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1421 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1422 * \li Action: Sets the text class for the current buffer.
1423 * \li Syntax: textclass-apply <TEXTCLASS>
1424 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1425 the filename, minus the ".layout" extension.
1428 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1430 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1431 * \li Action: Loads information for a textclass from disk.
1432 * \li Syntax: textclass-load <TEXTCLASS>
1433 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1434 the filename, minus the ".layout" extension.
1437 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1440 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1441 * \li Action: Disable selecting of text-region.
1442 * \li Syntax: mark-off
1445 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1447 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1448 * \li Action: Enable selecting of text-region.
1449 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1450 * \li Syntax: mark-on
1453 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1455 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1456 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1457 * \li Syntax: mark-toggle
1458 * \li Origin: Andre, May 5 2006
1461 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1464 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1465 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1466 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1467 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1468 either a LaTeX name or a valid character.
1469 ( is the default letter.
1470 * \li Sample: math-delim { rangle
1471 * \li Origin: Alejandro, 18 Jun 1996
1474 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1476 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1477 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1478 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1479 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1480 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1481 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1482 * \li Origin: Enrico & Georg, 7 May 2006
1485 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1487 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1488 * \li Action: Creates a new displayed equation in text mode.
1489 Toggles inlined/display formula in math mode.
1490 * \li Syntax: math-display [<ARG>]
1491 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1492 new equation from the text mode.
1493 * \li Origin: Alejandro, 18 Jun 1996
1496 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1498 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1499 * \li Action: Inserts math objects and symbols.
1500 * \li Syntax: math-insert <ARG>
1501 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1504 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1506 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1507 * \li Action: Enters subscript expression in math expression.
1508 * \li Syntax: math-subscript
1509 * \li Origin: vermeer, 12 Dec 2001
1512 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1514 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1515 * \li Action: Enters subscript expression in math expression.
1516 * \li Syntax: math-superscript
1517 * \li Origin: vermeer, 12 Dec 2001
1520 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1522 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1523 * \li Action: Toggles the position of the limits from above/below to the right
1524 side an vice versa in integral symbol, a limit, a summation, etc.
1525 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1527 * \li Syntax: math-limits [<STATE>]
1528 * \li Params: <STATE>: limits|nolimits
1531 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1533 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1534 * \li Action: Inserts a math macro definition at the cursor position in the text.
1535 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1536 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".
1537 <NARGS>: The number of parameters of the macro. Default is 0.
1538 "def": Has no effect anymore, just for compatibility with former LyX versions.
1539 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1542 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1544 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1545 * \li Action: Mutates the type of math inset to the newly selected one.
1546 * \li Syntax: math-mutate <TYPE>
1547 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1548 multline|gather|flalign
1549 * \li Origin: Andre, 23 May 2001
1552 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1554 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1555 * \li Action: Inserts space into math expression.
1556 * \li Notion: Use spacebar after entering this space to change type of space.
1557 * \li Syntax: math-space [<TYPE>] [<LEN>]
1558 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1559 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1560 custom space: hspace \n
1561 "," used by default.
1562 Note that ! is equivalent to negthinspace, , = thinspace,
1563 : = medspace, and ; = thickspace.
1564 <LEN>: length for custom spaces (hspace)
1565 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1568 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1570 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1571 * \li Action: Inserts a matrix.
1572 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1573 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1574 (b, c or t) (i.e. 1 char) and the horizontal alignments
1575 (l, c or r) (i.e. <COL> chars).
1576 * \li Sample: math-matrix 3 3 bccc
1579 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1581 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1582 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1583 cursor position), in math mode enters text mode inside math expression.
1584 * \li Notion: If there is some selected text, it puts the text inside created math box.
1585 * \li Syntax: math-mode [<ARG>]
1586 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
1587 * \li Origin: Alejandro, 4 Jun 1996
1590 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1592 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1593 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1594 cursor position). Used by the advanced search dialog.
1595 * \li Notion: If there is any selected text, then it is moved inside the created
1597 * \li Syntax: regexp-mode [<ARG>]
1598 * \li Params: <ARG>: eventual argument (regular expression).
1599 * \li Origin: Tommaso, 4 Oct 2008
1602 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1604 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1605 * \li Action: Toggles numbering of the current formula line.
1606 * \li Notion: Must be in display formula mode.
1607 * \li Syntax: math-number-line-toggle
1608 * \li Origin: Alejandro, 18 Jun 1996
1611 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1613 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1614 * \li Action: Toggles numbering/labeling of the current formula.
1615 * \li Notion: Must be in display formula mode.
1616 * \li Syntax: math-number-toggle
1617 * \li Origin: Alejandro, 4 Jun 1996
1620 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1622 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1623 * \li Action: Calls external program and passes the current expression/equation
1624 as an argument for the calculation in the format appropriate to the
1626 * \li Notion: Selection can be used to determine the input for the external program.
1627 * \li Syntax: math-extern <LANG> [<COMMAND>]
1628 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1629 where "script" stands fot the external script (normalized
1630 expression will be passed)
1631 * \li Origin: Andre, 24 Apr 2001
1632 * \li Sample: math-extern maple simplify
1635 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1637 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1638 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1639 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1640 * \li Syntax: math-size <STYLE>
1641 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1642 * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
1645 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1647 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1648 * \li Action: Changes the text style used in math.
1649 * \li Syntax: math-font-style <STYLE>
1650 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1651 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1652 |textsc|textsl|textup
1653 * \li Origin: vfr, 9 jan 2009
1656 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1658 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1659 * \li Action: Unfold a Math Macro.
1660 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1662 * \li Syntax: math-macro-unfold
1663 * \li Origin: sts, 06 January 2008
1666 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1668 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1669 * \li Action: Fold a Math Macro.
1670 * \li Notion: Fold the Math Macro the cursor is in if it was
1671 unfolded, i.e. displayed as \foo before.
1672 * \li Syntax: math-macro-fold
1673 * \li Origin: sts, 06 January 2008
1676 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1678 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1679 * \li Action: Add a parameter.
1680 * \li Notion: Add a parameter to a Math Macro.
1681 * \li Params: <NUM>: The number of the parameter behind which the new one
1682 will be added (1 for the first, i.e. use 0 for add a
1683 parameter at the left), defaults to the last one.
1684 * \li Syntax: math-macro-add-param <NUM>
1685 * \li Origin: sts, 06 January 2008
1688 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1690 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1691 * \li Action: Remove the last parameter.
1692 * \li Notion: Remove the last parameter of a Math Macro and
1693 remove its value in all instances of the macro
1695 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1696 the first), defaults to the last one.
1697 * \li Syntax: math-macro-remove-param <NUM>
1698 * \li Origin: sts, 06 January 2008
1701 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1703 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1704 * \li Action: Append a greedy parameter.
1705 * \li Notion: Append a greedy parameter to a Math Macro which
1706 eats the following mathed cell in every instance of
1707 the macro in the buffer.
1708 * \li Syntax: math-macro-append-greedy-param
1709 * \li Origin: sts, 06 January 2008
1712 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1714 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1715 * \li Action: Remove a greedy parameter.
1716 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1717 out the values of it in every instance of the macro
1718 in the buffer. If it is an optional parameter the [valud]
1720 * \li Syntax: math-macro-remove-greedy-param
1721 * \li Origin: sts, 06 January 2008
1724 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1726 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1727 * \li Action: Make a parameter optional.
1728 * \li Notion: Turn the first non-optional parameter of a Math Macro
1729 into an optional parameter with a default value.
1730 * \li Syntax: math-macro-make-optional
1731 * \li Origin: sts, 06 January 2008
1734 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1736 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1737 * \li Action: Make a parameter non-optional.
1738 * \li Notion: Turn the last optional parameter of a Math Macro
1739 into a non-optional parameter. The default value is
1740 remembered to be reused later if the user changes his mind.
1741 * \li Syntax: math-macro-make-nonoptional
1742 * \li Origin: sts, 06 January 2008
1745 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1747 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1748 * \li Action: Add an optional parameter.
1749 * \li Notion: Insert an optional parameter just behind the
1750 already existing optional parameters.
1751 * \li Syntax: math-macro-add-optional-param
1752 * \li Origin: sts, 06 January 2008
1755 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1757 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1758 * \li Action: Remove the last optional parameter.
1759 * \li Notion: Remove the last optional parameter of a Math Macro and
1760 remove it in all the instances of the macro in the buffer.
1761 * \li Syntax: math-macro-remove-optional-param
1762 * \li Origin: sts, 06 January 2008
1765 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1767 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1768 * \li Action: Add a greedy optional parameter.
1769 * \li Notion: Add a greedy optional parameter which eats the value
1770 from the following cells in mathed which are in the [value]
1772 * \li Syntax: math-macro-add-greedy-optional-param
1773 * \li Origin: sts, 06 January 2008
1776 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1778 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1779 * \li Action: Only active in Math Macro definition.
1780 * \li Notion: Dummy function which is only active in a Math Macro definition.
1781 It's used to toggle the Math Macro toolbar if the cursor moves
1782 into a Math Macro definition.
1783 * \li Syntax: in-mathmacrotemplate
1784 * \li Origin: sts, 06 January 2008
1787 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1790 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1791 * \li Action: Moves the current paragraph downwards in the document.
1792 * \li Syntax: paragraph-move-down
1793 * \li Origin: Edwin, 8 Apr 2006
1796 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1798 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1799 * \li Action: Moves the current paragraph upwards in the document.
1800 * \li Syntax: paragraph-move-up
1801 * \li Origin: Edwin, 8 Apr 2006
1804 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1807 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1808 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1809 in upward direction.
1810 * \li Syntax: paragraph-up
1811 * \li Origin: Asger, 1 Oct 1996
1814 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1816 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1817 * \li Action: Move the cursor and select the text to the next paragraph (or
1818 begining of the current one) in upward direction.
1819 * \li Syntax: paragraph-up-select
1820 * \li Origin: Asger, 1 Oct 1996
1823 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1825 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1826 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1827 in downward direction.
1828 * \li Syntax: paragraph-down
1829 * \li Origin: Asger, 1 Oct 1996
1832 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1834 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1835 * \li Action: Move the cursor and select the text to the next paragraph (or
1836 begining of the current one) in downward direction.
1837 * \li Syntax: paragraph-down-select
1838 * \li Origin: Asger, 1 Oct 1996
1841 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1843 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1844 * \li Action: Jump to a paragraph given by its id number and optionally the
1845 desired position within the paragraph.
1846 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1847 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1848 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1849 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1850 <POSITION_IN_PAR>: desired position within the paragraph
1851 * \li Origin: Dekel, 26 Aug 2000
1854 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1856 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1857 * \li Action: Breaks the current paragraph at the current location.
1858 * \li Syntax: break-paragraph
1861 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1863 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1864 * \li Action: Breaks the current paragraph at the current location.
1865 * \li Notion: Removes the selection.
1866 * \li Syntax: break-paragraph [<LAYOUT>]
1867 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1868 to default layout) when the cursor is at the end of
1872 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1874 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1875 * \li Action: Change paragraph settings.
1876 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1877 This function only modifies, and does not override, existing settings.
1878 Note that the "leftindent" indent setting is deprecated.
1879 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1880 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1881 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1882 <ALIGN>: \\align block|left|right|center|default\n
1883 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1884 * \li Origin: rgh, Aug 15 2007
1887 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1889 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1890 * \li Action: Change paragraph settings.
1891 * \li Notion: Overwrite all nonspecified settings to the default ones.
1892 Use paragraph-params lfun if you don't want to overwrite others settings.
1893 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1894 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1895 * \li Origin: leeming, 30 Mar 2004
1898 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1900 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1901 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1902 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1903 by #LFUN_DIALOG_UPDATE.
1904 * \li Origin: leeming, 13 Mar 2003
1907 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1910 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1911 * \li Action: Move the current group in the upward direction in the
1912 structure of the document.
1913 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1914 the whole substructure of the group.
1915 * \li Syntax: outline-up
1916 * \li Origin: Vermeer, 23 Mar 2006
1919 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1921 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1922 * \li Action: Move the current group in the downward direction in the
1923 structure of the document.
1924 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1925 the whole substructure of the group.
1926 * \li Syntax: outline-down
1927 * \li Origin: Vermeer, 23 Mar 2006
1930 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1932 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1933 * \li Action: Moves the current group in the downward direction in the
1934 hierarchy of the document structure.
1935 * \li Notion: Part -> Chapter -> Section -> etc.
1936 * \li Syntax: outline-in
1937 * \li Origin: Vermeer, 23 Mar 2006
1940 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1942 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1943 * \li Action: Moves the current group in the upward direction in the
1944 hierarchy of the document structure.
1945 * \li Notion: Part <- Chapter <- Section <- etc.
1946 * \li Syntax: outline-out
1947 * \li Origin: Vermeer, 23 Mar 2006
1950 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1952 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1953 * \li Action: Edit the inset at cursor with an external application,
1954 * if one is attributed.
1955 * \li Syntax: inset-edit [<INSET_PARAMS>]
1956 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
1957 Currently only the filename will be considered.
1958 * \li Origin: JSpitzm, 27 Apr 2006
1961 { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
1964 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
1965 * \li Action: Inserts table into the document.
1966 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
1967 * \li Params: In case no arguments are given show insert dialog.
1968 * \li Origin: Jug, 12 Apr 2000
1971 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1973 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
1974 * \li Action: Sets various features to the table/cell on the current cursor position.
1975 * \li Notion: Various math-environment features are handled here as well, e.g.
1976 add-vline-left/right for the Grid/Array environment
1977 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
1978 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
1979 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
1980 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
1981 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top|
1982 m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines|
1983 set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
1984 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
1985 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
1986 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
1987 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
1988 set-special-column|set-special-multi|set-booktabs|unset-booktabs|
1989 set-top-space|set-bottom-space|set-interline-space|set-border-lines|
1990 tabular-valign-top|tabular-valign-middle|tabular-valign-bottom \n
1991 <ARG>: additional argument for some commands, use debug mode to explore its values.
1992 * \li Origin: Jug, 28 Jul 2000
1995 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1997 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1998 * \li Action: Moves the cursor to the previous cell inside the table.
1999 * \li Syntax: cell-backward
2000 * \li Origin: Jug, 22 May 2000
2003 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
2005 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2006 * \li Action: Moves the cursor to the next cell inside the table.
2007 * \li Syntax: cell-forward
2010 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
2012 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2013 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2014 * \li Syntax: cell-split
2015 * \li Origin: Ale, 15 May 1997
2018 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2021 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2022 * \li Action: Register the document as an file inside version control system (RCS, CVS).
2023 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2024 of cvs/svn/rcs entries in the document's directory. \n
2025 See LyX Additional Features Manual (Version Control Chapter) for additional
2027 * \li Syntax: vc-register
2028 * \li Origin: Lgb, 1 Jul 1997
2031 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2033 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2034 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2035 * \li Notion: In RCS case this also unlocks the file.
2036 * \li Syntax: vc-check-in
2037 * \li Origin: Lgb, 1 Jul 1997
2040 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2042 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2043 * \li Action: Checks-out the document for edit (and locks it for RCS).
2044 * \li Notion: This is implemented only for RCS and SVN, not CVS.
2045 * \li Syntax: vc-check-out
2046 * \li Origin: Lgb, 1 Jul 1997
2049 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2051 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2052 * \li Action: Reverts the document to the last check-in/commit in VCS.
2053 * \li Syntax: vc-revert
2054 * \li Origin: Lgb, 1 Jul 1997
2057 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2059 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2060 * \li Action: Undo last check-in.
2061 * \li Notion: This is currently implemented only for RCS.
2062 * \li Syntax: vc-check-out
2063 * \li Origin: Lgb, 1 Jul 1997
2066 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2068 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2069 * \li Action: Executes external command. This command is intended to support
2070 additional VCS commands.
2071 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2072 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2073 U - dUmmy - no flags \n
2074 D - Doc - need document loaded to proceed \n
2075 I - dIrty - mark document dirty \n
2076 R - Reload - ensure that the document is saved and reload it after command execution \n
2077 M - Message - ask for input string (commit message)\n
2078 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2079 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
2080 * \li Sample: vc-command DR $$p "svn up"
2081 * \li Origin: sanda, 13 Jan 2009
2084 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2087 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2088 * \li Action: Toggles change tracking to on/off.
2089 * \li Syntax: changes-track
2090 * \li Origin: levon, 1 Oct 2002
2093 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2095 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2096 * \li Action: Toggles showing of change tracking in typesetted output.
2097 * \li Syntax: changes-output
2098 * \li Origin: jspitzm, 21 Jan 2005
2101 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2103 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2104 * \li Action: Moves the cursor to the position of the next change
2105 of the change tracking records.
2106 * \li Syntax: change-next
2107 * \li Origin: schmitt, 4 Oct 2006
2110 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2112 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2113 * \li Action: Open change tracking dialog for merging and moves the cursor
2114 to the position of the next change.
2115 * \li Syntax: changes-merge
2116 * \li Origin: Levon, 16 Oct 2002
2119 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2121 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2122 * \li Action: Accepts tracked change inside the selection.
2123 * \li Syntax: change-accept
2124 * \li Origin: Levon, 16 Oct 2002
2127 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2129 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2130 * \li Action: Rejects tracked change inside the selection.
2131 * \li Syntax: change-accept
2132 * \li Origin: Levon, 16 Oct 2002
2135 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2137 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2138 * \li Action: Accepts all tracked changes in the document.
2139 * \li Syntax: all-changes-accept
2140 * \li Origin: Levon, 16 Oct 2002
2143 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2145 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2146 * \li Action: Rejects all tracked changes in the document.
2147 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2148 * \li Syntax: all-changes-reject
2149 * \li Origin: Levon, 16 Oct 2002
2152 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2155 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2156 * \li Action: Apply data for an inset.
2157 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2158 be applied. This is either changed to #LFUN_INSET_MODIFY or
2159 #LFUN_INSET_INSERT depending on the context where it is called.
2160 * \li Syntax: inset-apply <ARGS>
2161 * \li Params: See #LFUN_INSET_INSERT .
2164 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2166 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2167 * \li Action: Dissolve the current inset into text.
2168 * \li Syntax: inset-dissolve [<INSET>]
2169 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2170 is dissolved. For example "dissolve" entry in the charstyles
2171 sub-menu should only dissolve the charstyle inset, even if the
2172 cursor is inside several nested insets of different type.\n
2173 For values see #lyx::InsetLayout::lyxtype_ .
2174 * \li Origin: JSpitz, 7 Aug 2006
2177 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
2179 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2180 * \li Action: Insert new inset (type given by the parameters).
2181 * \li Syntax: inset-insert <INSET> <ARGS>
2182 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2183 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2184 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
2186 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2187 where <label name> is the name of the referenced label and
2188 <Format> is one of the following: \n
2189 ref -- <reference> \n
2190 eqref -- (<reference>) \n
2191 pageref -- <page> \n
2192 vpageref -- on <page> \n
2193 vref -- <reference> on <page> \n
2194 prettyref -- Formatted reference
2197 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2199 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2200 * \li Action: Modify existing inset.
2201 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2202 floats, graphics, include, label, listings, note,
2203 phantom, ref, space, tabular, vspace, wrap insets.
2204 * \li Syntax: inset-modify <INSET> <ARGS>
2205 * \li Params: See #LFUN_INSET_INSERT for further details.
2208 { LFUN_INSET_MODIFY, "", Noop, Hidden },
2210 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
2211 * \li Action: Modify the inset at cursor position, if there is one.
2212 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2213 floats, graphics, include, label, listings, note,
2214 phantom, ref, space, tabular, vspace, wrap insets.
2215 * \li Syntax: next-inset-modify <INSET> <ARGS>
2216 * \li Syntax: next-inset-modify changetype <TYPE>
2217 * \li Params: See #LFUN_INSET_INSERT for further details.
2218 * \li Origin: JSpitzm, 23 Mar 2008
2221 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", Noop, Edit },
2223 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2224 * \li Action: Updates the values inside the dialog from the inset.
2225 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2226 by #LFUN_DIALOG_UPDATE
2227 * \li Params: <DIALOG-NAME>
2228 * \li Origin: leeming, 25 Feb 2003
2231 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2233 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2234 * \li Action: Open the inset's properties dialog.
2235 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2236 * \li Syntax: inset-settings <INSET>
2237 * \li Params: <INSET>: <box|branch|ert|float|listings|note|phantom|tabular|wrap>
2240 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
2242 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2243 * \li Action: Toggles the collapsable inset we are currently in.
2244 * \li Syntax: inset-toggle [<ARG>]
2245 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2246 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2247 assign synchronize the branch-inset with activation status of the branch.
2248 Used for global toggling when changed activation.
2249 * \li Origin: lasgouttes, 19 Jul 2001
2252 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Hidden },
2254 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2255 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2256 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2257 * \li Syntax: all-insets-toggle <STATE> <INSET>
2258 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
2259 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2260 * \li Origin: leeming, 30 Mar 2004
2263 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2265 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2266 * \li Action: Set the group for the graphics inset on the cursor position.
2267 * \li Syntax: set-graphics-group [<GROUP>]
2268 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2269 the graphics inset is removed from the current group.
2270 * \li Origin: sanda, 6 May 2008
2273 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2276 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2277 * \li Action: Moves the cursor out of the current slice, going forward.
2278 * \li Notion: Cursor movement within an inset may be different than cursor
2279 movement in the surrounding text. This action should be called
2280 automatically by the cursor movement within the inset, when
2281 movement within the inset has ceased (reached the end of the
2282 last paragraph, for example), in order to move correctly
2283 back into the surrounding text.
2286 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2288 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2289 * \li Action: Moves the cursor out of the current slice, going backwards.
2290 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2293 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2295 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2296 * \li Action: Moves the cursor out of the current slice, going right.
2297 * \li Notion: See also #LFUN_FINISHED_FORWARD
2300 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2302 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2303 * \li Action: Moves the cursor out of the current slice, going left.
2304 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2307 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2310 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2311 * \li Action: Set language from the current cursor position.
2312 * \li Syntax: language <LANG>
2313 * \li Params: <LANG>: Requested language. Look in lib/languages for
2315 * \li Origin: Dekel, 2 Mar 2000
2318 { LFUN_LANGUAGE, "language", Noop, Edit },
2321 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2322 * \li Action: Goto a label.
2323 * \li Syntax: label-goto [<LABEL>]
2324 * \li Params: <LABEL>: Requested label. If no label is given and reference
2325 is on cursor position, Bookmark 0 is saved and
2326 cursor moves to the position of referenced label.
2327 * \li Origin: Ale, 6 Aug 1997
2330 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2332 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2333 * \li Action: Inserts label to text or displayed formula.
2334 * \li Syntax: label-insert [<LABEL>]
2335 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2336 name will be opened.
2339 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2341 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2342 * \li Action: Go to the next label or cross-reference.
2343 * \li Syntax: reference-next
2344 * \li Origin: Dekel, 14 Jan 2001
2347 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2350 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2351 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2352 if necessary. Note that bookmarsk are saved per-session, not
2354 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2355 1. to the paragraph you are currently editing \n
2356 2. to the paragraph from where you are jumping to the last-edited
2357 position (jump-back feature) \n
2358 3. when jumping from crossreference to the requested label by
2360 * \li Syntax: bookmark-goto <NUMBER>
2361 * \li Params: <NUMBER>: the number of the bookmark to restore.
2362 * \li Origin: Dekel, 27 January 2001
2365 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2367 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2368 * \li Action: Save a bookmark.
2369 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2370 must be between 1 and 9, inclusive. Note that bookmarks are
2371 saved per-session, not per file.
2372 * \li Syntax: bookmark-save <NUMBER>
2373 * \li Params: <NUMBER>: the number of the bookmark to save.
2374 * \li Origin: Dekel, 27 January 2001
2377 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2379 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2380 * \li Action: Clears the list of saved bookmarks.
2381 * \li Syntax: bookmark-clear
2382 * \li Origin: bpeng, 31 October 2006
2385 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2388 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2389 * \li Action: Open the given help file according to the language setting.
2390 * \li Syntax: help-open <FILE>[.lyx]
2391 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2392 * \li Origin: Jug, 27 Jun 1999
2395 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2397 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2398 * \li Action: Terminates the current LyX instance.
2399 * \li Notion: Terminates the current LyX instance, asking whether to save
2400 modified documents, etc.
2401 * \li Syntax: lyx-quit
2404 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2406 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2407 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2408 * \li Notion: Skiping "auto" when allowauto is false.
2409 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2410 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2411 minibuffer|review|view/update|math_panels|vcs
2412 * \li Origin: Edwin, 21 May 2007
2415 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2417 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2418 * \li Action: Opens the menu given by its name.
2419 * \li Syntax: menu-open <NAME>
2420 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2423 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2425 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2426 * \li Action: Various UI visibility-toggling actions.
2427 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2428 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2429 menubar : Toggle visibility of the menubar.\n
2430 scrollbar : Toggle visibility of the scrollbar.\n
2431 frame : Toggle visibility of the frames around editing window.\n
2432 fullscreen : Toggle fullscreen mode. This also covers calling the
2433 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2434 custom tweaks of the toolbars should be used.
2435 * \li Origin: sanda, 9 Feb 2007
2438 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2441 * \var lyx::FuncCode lyx::WINDOW_NEW
2442 * \li Action: Creates new empty LyX window.
2443 * \li Notion: Already opened documents from the previous window can be found under View menu.
2444 * \li Syntax: window-new [<GEOMETRY>]
2445 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2446 accepted only on Windows platform.
2447 * \li Origin: Abdel, 21 Oct 2006
2450 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2452 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2453 * \li Action: Closes the current LyX window.
2454 * \li Syntax: window-close
2455 * \li Origin: Abdel, 23 Oct 2006
2458 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2461 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2462 * \li Action: Creates another split view of current buffer.
2463 * \li Notion: All split views act in the same way indpendently.
2464 * \li Syntax: split-view <vertical|horizontal>
2465 * \li Params: horizontal : The work areas are laid out side by side.\n
2466 vertical : The work areas laid out vertically.
2467 * \li Origin: Abdel, 20 Feb 2008
2470 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2473 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2474 * \li Action: Close the current tab group.
2475 * \li Notion: This only closes the work areas, not the buffer themselves.
2476 The still opened buffers can be visualized in another tab group.
2477 * \li Syntax: close-tab-group
2478 * \li Origin: Abdel, 21 Feb 2008
2481 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2483 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2484 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2485 * \li Syntax: dialog-show <NAME> [<DATA>]
2486 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2487 document|errorlist|ert|external|file|findreplace|float|graphics|\n
2488 include|index|info|nomenclature|label|listings|log|mathdelimiter|\n
2489 mathmatrix|note|paragraph|phantom|prefs|print|ref|sendto|space|\n
2490 spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|href|\n
2491 view-source|vspace|wrap|<SPECIAL> \n
2492 <SPECIAL>: latexlog|vclog \n
2493 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2495 * \li Origin: leeming, 17 Jun 2003
2498 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2500 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2501 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2502 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2503 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2504 * \li Params: See #LFUN_DIALOG_SHOW .
2505 * \li Origin: leeming, 25 Feb 2003
2508 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2510 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2511 * \li Action: Updates the dialog values from the inset/paragraph/document.
2512 * \li Syntax: dialog-update <NAME>
2513 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2515 * \li Origin: leeming, 25 Feb 2003
2518 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2520 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2521 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2522 * \li Syntax: dialog-hide <NAME>
2523 * \li Params: See #LFUN_DIALOG_SHOW .
2524 * \li Origin: leeming, 25 Feb 2003
2527 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2529 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2530 * \li Action: Toggles dialog between showed/hidden state.
2531 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2532 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2533 * \li Params: See #LFUN_DIALOG_SHOW .
2534 * \li Origin: JSpitzm, 30 Apr 2007
2537 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2539 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2540 * \li Action: Closes opened connection to opened inset.
2541 * \li Notion: Connection is used for apply functions.
2542 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2543 * \li Origin: leeming, 25 Feb 2003
2546 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2549 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2550 * \li Action: This function is called when mouse button is pressed (inside workarea).
2551 Action depends on the context.
2552 * \li Notion: This is internal LFUN, not to be used by users.
2553 * \li Origin: Andre, 9 Aug 2002
2556 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2558 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2559 * \li Action: This function is called when double click on mouse button is
2560 pressed (inside workarea). Action depends on the context.
2561 * \li Notion: This is internal LFUN, not to be used by users.
2562 * \li Origin: Andre, 9 Aug 2002
2565 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2567 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2568 * \li Action: This function is called when triple click on mouse button is
2569 pressed (inside workarea). Action depends on the context.
2570 * \li Notion: This is internal LFUN, not to be used by users.
2571 * \li Origin: Andre, 9 Aug 2002
2574 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2576 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2577 * \li Action: This function is called when mouse cursor is moving over the text.
2578 Action depends on the context.
2579 * \li Notion: This is internal LFUN, not to be used by users.
2580 * \li Origin: Andre, 9 Aug 2002
2583 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2585 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2586 * \li Action: This function is called when mouse button is released (inside workarea).
2587 Action depends on the context.
2588 * \li Notion: This is internal LFUN, not to be used by users.
2589 * \li Origin: Andre, 9 Aug 2002
2592 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2595 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2596 * \li Action: Turn off the loaded keyboard map.
2597 * \li Syntax: keymap-off
2600 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2602 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2603 * \li Action: Turn on the primary keyboard map.
2604 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2605 keyboard support. They can be still used to maintain uniform keyboard
2606 layout across the various plaforms.\n
2607 The language is to be set in the Preferences dialog.
2608 * \li Syntax: keymap-primary
2611 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2613 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2614 * \li Action: Turn on the secondary keyboard map.
2615 * \li Syntax: keymap-secondary
2618 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2620 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2621 * \li Action: Toggles keyboard maps (first/second/off).
2622 * \li Syntax: keymap-toggle
2623 * \li Origin: leeming, 30 Mar 2004
2626 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2629 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2630 * \li Action: Returns the current layout (that is environment) name
2631 on the cursor position.
2632 * \li Syntax: server-get-layout
2635 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2637 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2638 * \li Action: Returns path and file name of the currently edited document.
2639 * \li Syntax: server-get-filename
2642 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2644 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2645 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2646 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
2647 * \li Origin: Edmar, 23 Dec 1998
2650 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2652 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2653 * \li Action: Sends notify message about the last key-sequence to client.
2654 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2655 See also Debug extensions section in Additional features manual.
2656 * \li Syntax: server-notify
2659 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2661 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2662 * \li Action: Sets the cursor position based on the editing area coordinates
2663 (similar as clicking on that point with left mouse button).
2664 * \li Syntax: server-set-xy <X> <Y>
2667 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2669 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2670 * \li Action: Returns the coordinates of cursor position in the editing area.
2671 * \li Syntax: server-get-xy
2674 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2677 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2678 * \li Action: Generates the code (literate programming).
2679 * \li Notion: Latex file with extension \literate_extension is generated.
2680 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2681 \build_error_filter to process the compilation error messages. \n
2682 In case you want to process your literate file with a script, or some other program,
2683 just insert in your lyxrc file an entry with:\n
2684 \build_command "my_script my_arguments" \n
2685 The \build_error_filter differs from the \literate_error_filter only in that the
2686 former will identify error messages from your compiler.
2687 * \li Syntax: build-program
2690 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2693 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2694 * \li Action: Saves the current buffer to a temporary file.
2695 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2696 is called automatically by LyX, to "autosave" the current buffer.
2697 * \li Syntax: buffer-auto-save
2700 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2702 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2703 * \li Action: Loads the given child document.
2704 * \li Notion: The current document is treated as a parent.
2705 * \li Syntax: buffer-child-open <FILE>
2706 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2707 * \li Origin: Ale, 28 May 1997
2710 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2712 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2713 * \li Action: Runs chktex for the current document.
2714 * \li Syntax: buffer-chktex
2715 * \li Origin: Asger, 30 Oct 1997
2718 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2720 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2721 * \li Action: Toggles compression of the current document on/off.
2722 * \li Syntax: buffer-toggle-compression
2723 * \li Origin: bpeng, 27 Apr 2006
2726 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2728 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2729 * \li Action: Closes the current buffer.
2730 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2731 if the buffer has been modified.
2732 * \li Syntax: buffer-close
2735 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2737 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2738 * \li Action: Exports the current buffer (document) to the given format.
2739 * \li Syntax: buffer-export <FORMAT>
2740 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2741 can find in Tools->Preferences->File formats->Format.
2742 Usual format you will enter is "pdf2" (pdflatex),
2743 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2744 In case of "custom" you will be asked for a format you
2745 want to start from and for the command that you want to
2746 apply to this format. Internally the control is then passed
2747 to #LFUN_BUFFER_EXPORT_CUSTOM.
2748 * \li Origin: Lgb, 29 Jul 1997
2751 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2753 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2754 * \li Action: Exports the current buffer (document) from the given format using
2755 the given command on it.
2756 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2757 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2758 intermediate file).\n
2759 <COMMAND> this command will be launched on the file. Note that you can
2760 use "$$FName" string to qualify the intermediate file.
2761 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2762 * \li Origin: leeming, 27 Mar 2004
2765 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2767 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2768 * \li Action: Prints the current document.
2769 * \li Notion: Many settings can be given via the preferences dialog.
2770 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2771 * \li Params: <TARGET> is either "printer" or "file".\n
2772 <TARGER-NAME> is either "default" or file name or printer name.\n
2773 <COMMAND> command ensuring the printing job.
2774 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2775 * \li Origin: leeming, 28 Mar 2004
2778 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2780 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2781 * \li Action: Import a given file as a lyx document.
2782 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2783 defined convertors in preferences. Look into File->Import menu to get
2784 an idea of the currently active import formats.
2785 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2786 * \li Origin: Asger, 24 Jul 1998
2789 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2791 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2792 * \li Action: Creates a new buffer (that is, document).
2793 * \li Notion: Implicit path can be set in Preferences dialog.
2794 * \li Syntax: buffer-new [<FILE>]
2795 * \li Params: <FILE>: filename of created file with absolute path.
2798 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2800 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2801 * \li Action: Creates a new buffer (that is, document) from a template.
2802 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2803 Template will be asked for via Open-dialog.
2804 * \li Syntax: buffer-new-template [<FILE>]
2805 * \li Params: <FILE>: filename of created file with absolute path.
2808 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2810 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2811 * \li Action: Reverts opened document.
2812 * \li Syntax: buffer-reload
2813 * \li Origin: Asger, 2 Feb 1997
2816 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2818 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2819 * \li Action: Switch to the given buffer.
2820 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2821 document in different LyX windows.
2822 * \li Syntax: buffer-new-template <BUFFER>
2823 * \li Params: <BUFFER>: already opened document which is to be shown.
2826 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2828 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2829 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2830 * \li Notion: In the ->Readonly mode checks-in/commits the data if the file is under version control.
2831 In the Readonly-> mode checkouts the data from repository. \n
2832 If these operations fail, buffer won't be toggled.
2833 * \li Syntax: buffer-toggle-read-only
2834 * \li Origin: Lgb, 27 May 1997
2837 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2839 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2840 * \li Action: Displays current buffer in chosen format.
2841 * \li Notion: Displays the contents of the current buffer in the chosen
2842 format, for example, PDF or DVI. This runs the necessary
2843 converter, calls the defined viewer, and so forth.
2844 * \li Syntax: buffer-view <FORMAT>
2845 * \li Params: <FORMAT>: The format to display, where this is one of the
2846 formats defined (in the current GUI) in the
2847 Tools>Preferences>File Formats dialog.
2850 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2852 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2853 * \li Action: Exports the current document and put the result into the
2854 temporary directory.
2855 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2856 the output will be rewriten - updated. This is useful in case your viewer
2857 is able to detect such changes (e.g. ghostview for postscript).
2858 * \li Syntax: buffer-update <FORMAT>
2859 * \li Params: <FORMAT>: The format to display, where this is one of the
2860 formats defined (in the current GUI) in the
2861 Tools>Preferences>File Formats dialog.
2862 * \li Origin: Dekel, 5 Aug 2000
2865 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2868 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2869 * \li Action: Saves the current buffer.
2870 * \li Notion: Saves the current buffer to disk, using the filename that
2871 is already associated with the buffer, asking for one if
2872 none is yet assigned.
2873 * \li Syntax: buffer-write
2876 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2878 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2879 * \li Action: Rename and save current buffer.
2880 * \li Syntax: buffer-write-as <FILENAME>
2881 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2882 is with respect to the original location of the buffer/file.
2885 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2887 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2888 * \li Action: Save all changed documents.
2889 * \li Syntax: buffer-write-all
2890 * \li Origin: rgh, gpothier 6 Aug 2007
2893 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2895 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2896 * \li Action: Switch to the next opened document.
2897 * \li Notion: Note that this does not necessarily mean next in tabbar
2898 (for full list see View menu).
2899 * \li Syntax: buffer-next
2902 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2904 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2905 * \li Action: Switch to the previous opened document.
2906 * \li Syntax: buffer-previous
2909 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2911 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2912 * \li Action: When run from a child document, this updates (exports) document built
2913 from the master buffer. If a master is not found, it updates the
2915 * \li Syntax: master-buffer-update
2916 * \li Origin: Tommaso, 20 Sep 2007
2919 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2921 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2922 * \li Action: When run from a child document, this command shows a preview built
2923 from the master buffer. If a master is not found, it previews the
2925 * \li Syntax: master-buffer-view
2926 * \li Origin: Tommaso, 20 Sep 2007
2929 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2931 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2932 * \li Action: Set language of the current document.
2933 * \li Syntax: buffer-language <LANG>
2934 * \li Params: <LANG>: language name. See lib/languages for list.
2935 * \li Origin: leeming, 30 Mar 2004
2938 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2940 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2941 * \li Action: Save the current document settings as default.
2942 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2943 * \li Syntax: buffer-save-as-default [<ARGS>]
2944 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2945 you can find in document header of usual .lyx file.
2946 * \li Origin: leeming, 30 Mar 2004
2949 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2951 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2952 * \li Action: Apply the given settings to the current document.
2953 * \li Syntax: buffer-params-apply [<ARGS>]
2954 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2955 you can find in document header of usual .lyx file.
2956 * \li Origin: leeming, 30 Mar 2004
2959 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2962 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2963 * \li Action: Inserts another LyX file.
2964 * \li Syntax: file-insert [<FILE>]
2965 * \li Params: <FILE>: Filename to be inserted.
2968 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2970 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2971 * \li Action: Inserts plain text file.
2972 * \li Syntax: file-insert-plaintext [<FILE>]
2973 * \li Params: <FILE>: Filename to be inserted.
2974 * \li Origin: CFO-G, 19 Nov 1997
2977 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2979 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2980 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2981 * \li Syntax: file-insert-plaintext-para [<FILE>]
2982 * \li Params: <FILE>: Filename to be inserted.
2983 * \li Origin: Levon, 14 Feb 2001
2986 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2988 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2989 * \li Action: Open LyX document.
2990 * \li Syntax: file-open [<FILE>]
2991 * \li Params: <FILE>: Filename to be opened.
2994 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2997 * \var lyx::FuncCode lyx::LFUN_CALL
2998 * \li Action: Executes a command defined in a .def file.
2999 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3000 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
3001 where <NAME> is the name of the new command and <LFUN> is the lfun code
3002 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3003 \\def_file "FileName" allows to include another .def file. \n
3004 This is particularly useful in connection with toolbar buttons:
3005 Since the name of the button image for this lfun is
3006 lib/images/commands/<NAME>.png this is the way to assign an image
3007 to a complex command-sequence.
3008 * \li Syntax: call <NAME>
3009 * \li Params: <NAME>: Name of the command that must be called.
3010 * \li Origin: broider, 2 Oct 2007
3013 { LFUN_CALL, "call", NoBuffer, System },
3015 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3016 * \li Action: Simulate halting Meta key (Alt key on PCs).
3017 * \li Notion: Used for buffer editation not for GUI control.
3018 * \li Syntax: meta-prefix
3021 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3023 * \var lyx::FuncCode lyx::LFUN_CANCEL
3024 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3025 * \li Syntax: cancel
3028 { LFUN_CANCEL, "cancel", NoBuffer, System },
3031 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3032 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
3033 * \li Notion: Usually bound to M-x shortcut.
3034 * \li Syntax: command-execute
3037 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3039 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3040 * \li Action: Return the current key sequence and available options as a string.
3041 * \li Notion: No options are added if no current map exists. \n
3042 This is probably usable only with connection to lyxserver.
3043 * \li Syntax: command-prefix
3046 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3048 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3049 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3050 * \li Syntax: command-sequence <CMDS>
3051 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3052 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3053 * \li Origin: Andre, 11 Nov 1999
3056 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3058 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3059 * \li Action: Runs the first listed command that is enabled.
3060 * \li Notion: This can be used to bind multiple functions to a single key,
3061 and then which one is used will depend upon the context.
3062 * \li Syntax: command-alternatives <CMDS>
3063 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3064 * \li Sample: command-alternatives completion-accept;cell-forward
3065 * \li Origin: rgh, 24 September 2008
3068 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3070 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3071 * \li Action: Shows message in statusbar (for script purposes).
3072 * \li Syntax: message <STRING>
3073 * \li Origin: Lgb, 8 Apr 2001
3076 { LFUN_MESSAGE, "message", NoBuffer, System },
3078 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3079 * \li Action: Save user preferences.
3080 * \li Syntax: preferences-save
3081 * \li Origin: Lgb, 27 Nov 1999
3084 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3086 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3087 * \li Action: Reconfigure the automatic settings.
3088 * \li Syntax: reconfigure
3089 * \li Origin: Asger, 14 Feb 1997
3092 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3094 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3095 * \li Action: Apply the given settings to user preferences.
3096 * \li Syntax: lyxrc-apply <SETTINGS>
3097 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3098 to get an idea which commands to use and their syntax.
3099 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3102 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3104 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3105 * \li Action: Determine whether keep cursor inside the editing window regardless
3106 the scrollbar movement.
3107 * \li Syntax: toggle-cursor-follows-scrollbar
3108 * \li Origin: ARRae, 2 Dec 1997
3111 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3113 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3114 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3115 * \li Notion: A new color entry is created if the color is unknown.
3116 Color names can be stored as a part of user settings.
3117 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3118 * \li Origin: SLior, 11 Jun 2000
3121 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3123 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3124 * \li Action: Count the statistics (number of words and characters)
3125 in the document or in the given selection.
3126 * \li Notion: Note that this function gives the number of words/chars written,
3127 not the number of characters which will be typeset.
3128 * \li Syntax: statistics
3129 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3132 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3134 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3135 * \li Action: Show the inline completion at the cursor position.
3136 * \li Syntax: completion-inline
3137 * \li Origin: sts, Feb 19 2008
3140 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3142 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3143 * \li Action: Show the completion popup at the cursor position.
3144 * \li Syntax: completion-popup
3145 * \li Origin: sts, Feb 19 2008
3148 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3150 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3151 * \li Action: Try to complete the word or command at the cursor position.
3152 * \li Syntax: complete
3153 * \li Origin: sts, Feb 19 2008
3156 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3159 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3160 * \li Action: Try to cancel completion, either the popup or the inline completion
3161 * \li Syntax: completion-cancel
3162 * \li Origin: sts, Sep 07 2008
3165 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3167 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3168 * \li Action: Accept suggested completion.
3169 * \li Syntax: completion-accept
3170 * \li Origin: sanda, Sep 08 2008
3173 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3177 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3178 * \li Action: Activate the branch
3179 * \li Syntax: branch-activate <BRANCH>
3180 * \li Params: <BRANCH>: The branch to activate
3181 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3182 could be used to export a pdf with the answers branch included
3183 without one's having to open LyX and activate the branch manually.
3184 * \li Origin: rgh, 27 May 2008
3187 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3189 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3190 * \li Action: De-activate the branch
3191 * \li Syntax: branch-deactivate <BRANCH>
3192 * \li Params: <BRANCH>: The branch to deactivate
3193 * \li Origin: rgh, 27 May 2008
3196 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3199 * \var lyx::FuncCode lyx::LFUN_COPY_LABEL_AS_REF
3200 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3201 * \li Syntax: copy-label-as-reference
3202 * \li Origin: sts, 16 Nov 2008
3205 { LFUN_COPY_LABEL_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
3207 { LFUN_NOACTION, "", Noop, Hidden }
3208 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3211 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
3212 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3219 LyXAction::LyXAction()
3225 // Returns an action tag from a string.
3226 FuncRequest LyXAction::lookupFunc(string const & func) const
3228 string const func2 = trim(func);
3230 if (func2.empty()) {
3231 return FuncRequest(LFUN_NOACTION);
3235 string const arg = split(func2, cmd, ' ');
3237 func_map::const_iterator fit = lyx_func_map.find(cmd);
3239 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
3243 string const LyXAction::getActionName(FuncCode action) const
3245 info_map::const_iterator const it = lyx_info_map.find(action);
3246 return it != lyx_info_map.end() ? it->second.name : string();
3250 LyXAction::func_type LyXAction::getActionType(FuncCode action) const
3252 info_map::const_iterator const it = lyx_info_map.find(action);
3253 return it != lyx_info_map.end() ? it->second.type : Hidden;
3257 bool LyXAction::funcHasFlag(FuncCode action,
3258 LyXAction::func_attrib flag) const
3260 info_map::const_iterator ici = lyx_info_map.find(action);
3262 if (ici == lyx_info_map.end()) {
3263 LYXERR0("action: " << action << " is not known.");
3264 LASSERT(false, /**/);
3267 return ici->second.attrib & flag;
3271 LyXAction::const_func_iterator LyXAction::func_begin() const
3273 return lyx_func_map.begin();
3277 LyXAction::const_func_iterator LyXAction::func_end() const
3279 return lyx_func_map.end();
3283 LyXErr & operator<<(LyXErr & l, FuncCode code)
3286 l.stream() << lyxaction.getActionName(code);