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
688 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
691 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
692 * \li Action: Moves the cursor one position logically backwards.
693 * \li Notion: This is not the action which should be bound to the arrow keys,
694 because backwards may be left or right, depending on the
695 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
696 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
697 * \li Syntax: char-backward
700 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
702 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
703 * \li Action: Moves the cursor one position logically backwards, adding
704 traversed position to the selection.
705 * \li Notion: See also #LFUN_CHAR_BACKWARD.
706 * \li Syntax: char-backward-select
709 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
711 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
712 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
713 * \li Syntax: char-delete-backward
716 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
718 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
719 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
720 * \li Syntax: char-delete-forward
723 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
725 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
726 * \li Action: Moves the cursor one position logically forward.
727 * \li Notion: This is not the action which should be bound to the arrow keys,
728 because forward may be left or right, depending on the language.
729 The arrow keys should be bound to #LFUN_CHAR_LEFT or
730 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
731 * \li Syntax: char-forward
734 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
736 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
737 * \li Action: Moves the cursor one position logically forward, adding
738 traversed position to the selection.
739 * \li Notion: See also #LFUN_CHAR_FORWARD.
740 * \li Syntax: char-forward-select
743 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
745 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
746 * \li Action: Moves the cursor one position "to the left".
747 * \li Notion: This is the action which should be taken when the "left" key
748 is pressed. Generally, it moves the cursor one position to the
749 left. However, in Bidi text this become slightly more
750 complicated, and there are different modes of cursor movement.
751 In "visual mode", this moves left, plain and simple. In "logical
752 mode", movement is logically forward in RTL paragraphs, and
753 logically backwards in LTR paragraphs.
754 * \li Syntax: char-left
757 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
759 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
760 * \li Action: Moves the cursor one position "to the left", adding
761 traversed position to the selection.
762 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
763 * \li Syntax: char-left-select
766 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
768 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
769 * \li Action: Moves the cursor one position "to the right".
770 * \li Notion: This is the action which should be taken when the "right" key
771 is pressed. Generally, it moves the cursor one position to the
772 right. However, in Bidi text this become slightly more
773 complicated, and there are different modes of cursor movement.
774 In "visual mode", this moves right, plain and simple. In "logical
775 mode", movement is logically forward in LTR paragraphs, and
776 logically backwards in RTL paragraphs.
777 * \li Syntax: char-right
780 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
782 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
783 * \li Action: Moves the cursor one position "to the right", adding
784 traversed position to the selection.
785 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
786 * \li Syntax: char-right-select
789 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
792 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
793 * \li Action: Moves the cursor to the logically previous beginning of a word.
794 * \li Notion: This is not the action which should be bound to the arrow keys,
795 because backwards may be left or right, depending on the
796 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
797 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
798 * \li Syntax: word-backward
801 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
803 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
804 * \li Action: Moves the cursor to the logically previous beginning of a word,
805 adding the logically traversed text to the selection.
806 * \li Notion: See also #LFUN_WORD_BACKWARD.
807 * \li Syntax: word-backward-select
810 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
812 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
813 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
814 * \li Syntax: word-delete-backward
817 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
819 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
820 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
821 * \li Syntax: word-delete-forward
824 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
826 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
827 * \li Action: Search for a given string in forward direction.
828 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
829 * \li Syntax: word-find-forward [<STRING>]
830 * \li Origin: Etienne, 16 Feb 1998
833 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
835 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
836 * \li Action: Search for a given string in backward direction.
837 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
838 * \li Syntax: word-find-backward [<STRING>]
839 * \li Origin: Etienne, 20 Feb 1998
842 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
844 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
845 * \li Action: Search for next occurence of a string.
846 * \li Syntax: word-find [<DATA>]
847 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
848 If no parameter is given, search with last find-dialog
849 data is used for search (i.e. find-next).
850 * \li Origin: Andre, Jan 7 2004
853 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
855 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
856 * \li Action: Replace a string in the document.
857 * \li Syntax: word-replace [<DATA>]
858 * \li Params: <DATA>: data is of the form
861 <casesensitive> <matchword> <all> <forward>"
862 * \li Origin: Andre, Jan 7 2004
865 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
867 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
868 * \li Action: Search for next occurence of a pattern.
869 * \li Syntax: word-findadv [<DATA>]
870 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
871 If no parameter is given, search with last find-dialog
872 data is used for search (i.e. find-next).
873 * \li Origin: Tommaso, Nov 15 2007
876 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly, Edit },
877 /*! \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
878 * \li Action: Moves the cursor to the logically next beginning of a word.
879 * \li Notion: This is not the action which should be bound to the arrow keys,
880 because forward may be left or right, depending on the language.
881 The arrow keys should be bound to #LFUN_WORD_LEFT or
882 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
883 * \li Syntax: word-forward
886 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
888 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
889 * \li Action: Moves the cursor to the logically next beginning of a word,
890 adding the logically traversed text to the selection.
891 * \li Notion: See also #LFUN_WORD_FORWARD.
892 * \li Syntax: word-forward-select
895 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
897 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
898 * \li Action: Moves the cursor to the next beginning of a word "on the left".
899 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
900 "left" key is pressed. Generally, it moves the cursor to the
901 next beginning of a word on the left. However, in Bidi text this
902 become slightly more complicated, and there are different modes
903 of cursor movement. In "visual mode", this moves left, plain and
904 simple. In "logical mode", movement is logically forward in RTL
905 paragraphs, and logically backwards in LTR paragraphs.
906 * \li Syntax: word-left
907 * \li Origin: dov, 28 Oct 2007
910 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
912 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
913 * \li Action: Moves the cursor to the next beginning of a word "on the left",
914 adding *logically* traversed text to the selection.
915 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
916 * \li Syntax: word-left-select
917 * \li Origin: dov, 28 Oct 2007
920 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
922 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
923 * \li Action: Moves the cursor to the next beginning of a word "on the right".
924 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
925 "right" key is pressed. Generally, it moves the cursor to the
926 next beginning of a word on the right. However, in Bidi text
927 this become slightly more complicated, and there are different
928 modes of cursor movement. In "visual mode", this moves right,
929 plain and simple. In "logical mode", movement is logically
930 forward in LTR paragraphs, and logically backwards in RTL
932 * \li Syntax: word-right
933 * \li Origin: dov, 28 Oct 2007
936 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
938 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
939 * \li Action: Moves the cursor to the next beginning of a word "on the right",
940 adding *logically* traversed text to the selection.
941 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
942 * \li Syntax: word-right-select
943 * \li Origin: dov, 28 Oct 2007
946 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
948 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
949 * \li Action: Puts the word where the cursor stands into the selection.
950 * \li Syntax: word-select
951 * \li Origin: Andre, 11 Sep 2002
954 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
956 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
957 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
958 or the letter on the cursor position.
959 * \li Syntax: word-capitalize
962 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
964 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
965 * \li Action: Change the words in the selection or from the cursor position
966 to the end of word to the upper case.
967 * \li Syntax: word-upcase
970 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
972 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
973 * \li Action: Change the words in the selection or from the cursor position
974 to the end of word to the lower case.
975 * \li Syntax: word-lowcase
978 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
980 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
981 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
982 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
983 * \li Params: <STRING>: word to look up
984 <LANG>: language (see file languages)
985 * \li Origin: Levon, 20 Jul 2001
988 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
990 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
991 * \li Action: Move the cursor to the beginning of the document.
992 * \li Syntax: buffer-begin
995 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
997 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
998 * \li Action: Move the cursor to the beginning of the document adding the
999 traversed text to the selection.
1000 * \li Syntax: buffer-begin-select
1003 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1005 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1006 * \li Action: Move the cursor to the end of the document.
1007 * \li Syntax: buffer-end
1010 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1012 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1013 * \li Action: Move the cursor to the end of the document adding the
1014 traversed text to the selection.
1015 * \li Syntax: buffer-end-select
1018 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1021 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1022 * \li Action: Move the cursor to the beginning of the current inset
1023 if it is not already there, or at the beginning of the
1024 enclosing inset otherwise
1025 * \li Syntax: inset-begin
1026 * \li Origin: JMarc, 2009/03/16
1029 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1031 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1032 * \li Action: Move the cursor to the beginning of the current inset
1033 if it is not already there, or at the beginning of the
1034 enclosing inset otherwise (adding the
1035 traversed text to the selection).
1036 * \li Syntax: inset-begin-select
1037 * \li Origin: JMarc, 2009/03/16
1040 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1042 * \var lyx::FuncCode lyx::LFUN_INSET_END
1043 * \li Action: Move the cursor to the end of the current inset
1044 if it is not already there, or at the end of the
1045 enclosing inset otherwise
1046 * \li Syntax: inset-end
1047 * \li Origin: JMarc, 2009/03/16
1050 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1052 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1053 * \li Action: Move the cursor to the end of the current inset
1054 if it is not already there, or at the end of the
1055 enclosing inset otherwise (adding the
1056 traversed text to the selection).
1057 * \li Syntax: inset-end-select
1058 * \li Origin: JMarc, 2009/03/16
1061 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1064 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1065 * \li Action: Move the cursor to the begining of the (screen) line.
1066 * \li Syntax: line-begin
1069 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1071 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1072 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1073 traversed text to the selection.
1074 * \li Syntax: line-begin-select
1077 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1079 * \var lyx::FuncCode lyx::LFUN_LINE_END
1080 * \li Action: Move the cursor to the end of the (screen) line.
1081 * \li Syntax: line-end
1084 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1086 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1087 * \li Action: Move the cursor to the end of the (screen) line adding the
1088 traversed text to the selection.
1089 * \li Syntax: line-end-select
1092 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1094 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1095 * \li Action: Deletes the letters to the end of the (screen) line or
1096 deletes the selection.
1097 * \li Syntax: line-delete-forward
1100 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1102 * \var lyx::FuncCode lyx::LFUN_COPY
1103 * \li Action: Copies to the clipboard the last edit.
1107 { LFUN_COPY, "copy", ReadOnly, Edit },
1109 * \var lyx::FuncCode lyx::LFUN_CUT
1110 * \li Action: Cuts to the clipboard.
1114 { LFUN_CUT, "cut", Noop, Edit },
1116 * \var lyx::FuncCode lyx::LFUN_PASTE
1117 * \li Action: Pastes material from the active clipboard.
1118 * \li Syntax: paste [<TYPE>]
1119 * \li Params: <TYPE>: pdf|png|jpeg|linkback
1122 { LFUN_PASTE, "paste", Noop, Edit },
1124 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1125 * \li Action: Pastes text from the active clipboard.
1126 * \li Syntax: clipboard-paste [<ARG>]
1127 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1128 * \li Origin: baum, 10 Jul 2006
1131 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1133 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1134 * \li Action: Pastes the currently text selected text.
1135 * \li Notion: Primary selection mechanism is linux-only thing.
1136 * \li Syntax: primary-selection-paste [<ARG>]
1137 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1140 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1142 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1143 * \li Action: Pastes the text in permanent selection.
1144 * \li Syntax: selection-paste
1147 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1149 * \var lyx::FuncCode lyx::LFUN_UNDO
1150 * \li Action: Undoes the last edit.
1154 { LFUN_UNDO, "undo", Noop, Edit },
1156 * \var lyx::FuncCode lyx::LFUN_REDO
1157 * \li Action: Redoes the last thing undone.
1161 { LFUN_REDO, "redo", Noop, Edit },
1163 * \var lyx::FuncCode lyx::LFUN_REPEAT
1164 * \li Action: Repeat the given command.
1165 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1166 * \li Origin: Andre, 27 Oct 2003
1169 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1171 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1172 * \li Action: Transposes the character at the cursor with the one before it.
1173 * \li Syntax: chars-transpose
1174 * \li Origin: Lgb, 25 Apr 2001
1177 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1180 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1181 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1183 * \li Syntax: depth-decrement
1186 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1188 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1189 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1191 * \li Syntax: depth-increment
1194 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1197 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1198 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1199 * \li Syntax: font-bold
1202 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1205 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1206 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1207 * \li Syntax: font-boldsymbol
1210 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1212 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1213 * \li Action: Toggles the typewriter family font (selection-wise).
1214 * \li Syntax: font-typewriter
1217 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1219 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1220 * \li Action: Toggles underline in the font (selection-wise).
1221 * \li Syntax: font-underline
1224 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1226 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1227 * \li Action: Toggles the emphasis font style (selection-wise).
1228 * \li Syntax: font-emph
1231 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1233 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1234 * \li Action: Toggles Noun text style font (selection-wise).
1235 * \li Syntax: font-noun
1238 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1240 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1241 * \li Action: Toggles Roman family font (selection-wise).
1242 * \li Syntax: font-roman
1245 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1247 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1248 * \li Action: Toggles Sans Serif family font (selection-wise).
1249 * \li Syntax: font-sans
1252 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1254 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1255 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1256 * \li Syntax: font-frak
1257 * \li Origin: vermeer, 10 Jan 2002
1260 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1262 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1263 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1264 * \li Syntax: font-ital
1265 * \li Origin: vermeer, 10 Jan 2002
1268 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1270 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1271 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1272 * \li Syntax: font-default
1275 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1277 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1278 * \li Action: Sets font size according to lyx format string.
1279 * \li Syntax: font-size <SIZE>
1280 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1281 largest|huge|giant|increase|decrease|default
1284 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1286 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1287 * \li Action: Toggle user-defined (=last-time used) text style.
1288 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1289 automatically trigerred when using Text Style dialog.
1290 * \li Syntax: textstyle-apply
1291 * \li Origin: leeming, 12 Mar 2003
1294 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1296 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1297 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1298 * \li Syntax: textstyle-update <FONT_INFO>
1299 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1300 size, emph, noun, underbar, number, color, language,
1302 Use lyx -dbg action for exact syntax of text-style
1304 * \li Origin: leeming, 12 Mar 2003
1307 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1309 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1310 * \li Action: Update fonts and its metrics.
1311 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1312 * \li Syntax: screen-font-update
1313 * \li Origin: ARRae, 13 Aug 2000
1316 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1318 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1319 * \li Action: Returns the info about the current font.
1320 * \li Syntax: font-state
1323 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1326 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1327 * \li Action: Inserts citation from loaded citation database.
1328 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1329 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1330 <TEXT_BEFORE>: text which should appear before citation.
1331 * \li Origin: AAS, 97-02-23
1334 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1336 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1337 * \li Action: Adds database, which will be used for bibtex citations.
1338 * \li Notion: Databases are added to the first BibTeX inset
1339 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1340 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1341 * \li Origin: Ale, 30 May 1997
1344 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1346 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1347 * \li Action: Adds database, which will be used for bibtex citations.
1348 * \li Notion: Databases are deleted from the first BibTeX inset
1349 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1350 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1351 * \li Origin: Ale, 30 May 1997
1354 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1357 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1358 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1359 * \li Syntax: layout <LAYOUT>
1360 * \li Params: <LAYOUT>: the layout to use
1363 { LFUN_LAYOUT, "layout", Noop, Layout },
1365 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1366 * \li Action: Launches the paragraph settings dialog.
1367 * \li Syntax: layout-paragraph
1370 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1372 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1373 * \li Action: Launches the tabular settings dialog.
1374 * \li Syntax: layout-tabular
1375 * \li Origin: Jug, 31 Jul 2000
1378 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1380 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1381 * \li Action: Displays list of layout choices.
1382 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1383 dropbox allowing for choice of layout.
1384 * \li Syntax: drop-layouts-choice
1387 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1389 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1390 * \li Action: Clears the module list.
1391 * \li Notion: Clears the list of included modules for the current buffer.
1392 * \li Syntax: layout-modules-clear
1393 * \li Origin: rgh, 25 August 2007
1396 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1398 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1399 * \li Action: Adds a module.
1400 * \li Notion: Adds a module to the list of included modules for the current buffer.
1401 * \li Syntax: layout-module-add <MODULE>
1402 * \li Params: <MODULE>: the module to be added
1403 * \li Origin: rgh, 25 August 2007
1406 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1408 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1409 * \li Action: Reloads layout information.
1410 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1411 recognizing any changes that have been made to layout files on the fly.
1412 This is intended to be used only by layout developers and should not be
1413 used when one is trying to do actual work.
1414 * \li Syntax: layout-reload
1415 * \li Origin: rgh, 3 September 2007
1418 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1420 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1421 * \li Action: Sets the text class for the current buffer.
1422 * \li Syntax: textclass-apply <TEXTCLASS>
1423 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1424 the filename, minus the ".layout" extension.
1427 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1429 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1430 * \li Action: Loads information for a textclass from disk.
1431 * \li Syntax: textclass-load <TEXTCLASS>
1432 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1433 the filename, minus the ".layout" extension.
1436 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1439 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1440 * \li Action: Disable selecting of text-region.
1441 * \li Syntax: mark-off
1444 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1446 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1447 * \li Action: Enable selecting of text-region.
1448 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1449 * \li Syntax: mark-on
1452 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1454 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1455 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1456 * \li Syntax: mark-toggle
1457 * \li Origin: Andre, May 5 2006
1460 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1463 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1464 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1465 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1466 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1467 either a LaTeX name or a valid character.
1468 ( is the default letter.
1469 * \li Sample: math-delim { rangle
1470 * \li Origin: Alejandro, 18 Jun 1996
1473 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1475 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1476 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1477 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1478 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1479 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1480 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1481 * \li Origin: Enrico & Georg, 7 May 2006
1484 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1486 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1487 * \li Action: Creates a new displayed equation in text mode.
1488 Toggles inlined/display formula in math mode.
1489 * \li Syntax: math-display [<ARG>]
1490 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1491 new equation from the text mode.
1492 * \li Origin: Alejandro, 18 Jun 1996
1495 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1497 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1498 * \li Action: Inserts math objects and symbols.
1499 * \li Syntax: math-insert <ARG>
1500 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1503 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1505 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1506 * \li Action: Enters subscript expression in math expression.
1507 * \li Syntax: math-subscript
1508 * \li Origin: vermeer, 12 Dec 2001
1511 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1513 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1514 * \li Action: Enters subscript expression in math expression.
1515 * \li Syntax: math-superscript
1516 * \li Origin: vermeer, 12 Dec 2001
1519 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1521 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1522 * \li Action: Toggles the position of the limits from above/below to the right
1523 side an vice versa in integral symbol, a limit, a summation, etc.
1524 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1526 * \li Syntax: math-limits [<STATE>]
1527 * \li Params: <STATE>: limits|nolimits
1530 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1532 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1533 * \li Action: Inserts a math macro definition at the cursor position in the text.
1534 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1535 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".
1536 <NARGS>: The number of parameters of the macro. Default is 0.
1537 "def": Has no effect anymore, just for compatibility with former LyX versions.
1538 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1541 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1543 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1544 * \li Action: Mutates the type of math inset to the newly selected one.
1545 * \li Syntax: math-mutate <TYPE>
1546 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1547 multline|gather|flalign
1548 * \li Origin: Andre, 23 May 2001
1551 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1553 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1554 * \li Action: Inserts space into math expression.
1555 * \li Notion: Use spacebar after entering this space to change type of space.
1556 * \li Syntax: math-space [<TYPE>] [<LEN>]
1557 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1558 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1559 custom space: hspace \n
1560 "," used by default.
1561 Note that ! is equivalent to negthinspace, , = thinspace,
1562 : = medspace, and ; = thickspace.
1563 <LEN>: length for custom spaces (hspace)
1564 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1567 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1569 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1570 * \li Action: Inserts a matrix.
1571 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1572 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1573 (b, c or t) (i.e. 1 char) and the horizontal alignments
1574 (l, c or r) (i.e. <COL> chars).
1575 * \li Sample: math-matrix 3 3 bccc
1578 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1580 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1581 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1582 cursor position), in math mode enters text mode inside math expression.
1583 * \li Notion: If there is some selected text, it puts the text inside created math box.
1584 * \li Syntax: math-mode [<ARG>]
1585 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .
1586 * \li Origin: Alejandro, 4 Jun 1996
1589 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1591 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1592 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1593 cursor position). Used by the advanced search dialog.
1594 * \li Notion: If there is any selected text, then it is moved inside the created
1596 * \li Syntax: regexp-mode [<ARG>]
1597 * \li Params: <ARG>: eventual argument (regular expression).
1598 * \li Origin: Tommaso, 4 Oct 2008
1601 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1603 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1604 * \li Action: Toggles numbering of the current formula line.
1605 * \li Notion: Must be in display formula mode.
1606 * \li Syntax: math-number-line-toggle
1607 * \li Origin: Alejandro, 18 Jun 1996
1610 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1612 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1613 * \li Action: Toggles numbering/labeling of the current formula.
1614 * \li Notion: Must be in display formula mode.
1615 * \li Syntax: math-number-toggle
1616 * \li Origin: Alejandro, 4 Jun 1996
1619 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1621 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1622 * \li Action: Calls external program and passes the current expression/equation
1623 as an argument for the calculation in the format appropriate to the
1625 * \li Notion: Selection can be used to determine the input for the external program.
1626 * \li Syntax: math-extern <LANG> [<COMMAND>]
1627 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1628 where "script" stands fot the external script (normalized
1629 expression will be passed)
1630 * \li Origin: Andre, 24 Apr 2001
1631 * \li Sample: math-extern maple simplify
1634 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1636 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1637 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1638 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1639 * \li Syntax: math-size <STYLE>
1640 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1641 * \li Origin: Alejandro, 15 Aug 1996; ps, 14 Jun 2008
1644 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1646 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1647 * \li Action: Changes the text style used in math.
1648 * \li Syntax: math-font-style <STYLE>
1649 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1650 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1651 |textsc|textsl|textup
1652 * \li Origin: vfr, 9 jan 2009
1655 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1657 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1658 * \li Action: Unfold a Math Macro.
1659 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1661 * \li Syntax: math-macro-unfold
1662 * \li Origin: sts, 06 January 2008
1665 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1667 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1668 * \li Action: Fold a Math Macro.
1669 * \li Notion: Fold the Math Macro the cursor is in if it was
1670 unfolded, i.e. displayed as \foo before.
1671 * \li Syntax: math-macro-fold
1672 * \li Origin: sts, 06 January 2008
1675 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1677 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1678 * \li Action: Add a parameter.
1679 * \li Notion: Add a parameter to a Math Macro.
1680 * \li Params: <NUM>: The number of the parameter behind which the new one
1681 will be added (1 for the first, i.e. use 0 for add a
1682 parameter at the left), defaults to the last one.
1683 * \li Syntax: math-macro-add-param <NUM>
1684 * \li Origin: sts, 06 January 2008
1687 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1689 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1690 * \li Action: Remove the last parameter.
1691 * \li Notion: Remove the last parameter of a Math Macro and
1692 remove its value in all instances of the macro
1694 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1695 the first), defaults to the last one.
1696 * \li Syntax: math-macro-remove-param <NUM>
1697 * \li Origin: sts, 06 January 2008
1700 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1702 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1703 * \li Action: Append a greedy parameter.
1704 * \li Notion: Append a greedy parameter to a Math Macro which
1705 eats the following mathed cell in every instance of
1706 the macro in the buffer.
1707 * \li Syntax: math-macro-append-greedy-param
1708 * \li Origin: sts, 06 January 2008
1711 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1713 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1714 * \li Action: Remove a greedy parameter.
1715 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1716 out the values of it in every instance of the macro
1717 in the buffer. If it is an optional parameter the [valud]
1719 * \li Syntax: math-macro-remove-greedy-param
1720 * \li Origin: sts, 06 January 2008
1723 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1725 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1726 * \li Action: Make a parameter optional.
1727 * \li Notion: Turn the first non-optional parameter of a Math Macro
1728 into an optional parameter with a default value.
1729 * \li Syntax: math-macro-make-optional
1730 * \li Origin: sts, 06 January 2008
1733 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1735 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1736 * \li Action: Make a parameter non-optional.
1737 * \li Notion: Turn the last optional parameter of a Math Macro
1738 into a non-optional parameter. The default value is
1739 remembered to be reused later if the user changes his mind.
1740 * \li Syntax: math-macro-make-nonoptional
1741 * \li Origin: sts, 06 January 2008
1744 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1746 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1747 * \li Action: Add an optional parameter.
1748 * \li Notion: Insert an optional parameter just behind the
1749 already existing optional parameters.
1750 * \li Syntax: math-macro-add-optional-param
1751 * \li Origin: sts, 06 January 2008
1754 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1756 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1757 * \li Action: Remove the last optional parameter.
1758 * \li Notion: Remove the last optional parameter of a Math Macro and
1759 remove it in all the instances of the macro in the buffer.
1760 * \li Syntax: math-macro-remove-optional-param
1761 * \li Origin: sts, 06 January 2008
1764 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1766 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1767 * \li Action: Add a greedy optional parameter.
1768 * \li Notion: Add a greedy optional parameter which eats the value
1769 from the following cells in mathed which are in the [value]
1771 * \li Syntax: math-macro-add-greedy-optional-param
1772 * \li Origin: sts, 06 January 2008
1775 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1777 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1778 * \li Action: Only active in Math Macro definition.
1779 * \li Notion: Dummy function which is only active in a Math Macro definition.
1780 It's used to toggle the Math Macro toolbar if the cursor moves
1781 into a Math Macro definition.
1782 * \li Syntax: in-mathmacrotemplate
1783 * \li Origin: sts, 06 January 2008
1786 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1789 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1790 * \li Action: Moves the current paragraph downwards in the document.
1791 * \li Syntax: paragraph-move-down
1792 * \li Origin: Edwin, 8 Apr 2006
1795 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1797 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1798 * \li Action: Moves the current paragraph upwards in the document.
1799 * \li Syntax: paragraph-move-up
1800 * \li Origin: Edwin, 8 Apr 2006
1803 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1806 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1807 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1808 in upward direction.
1809 * \li Syntax: paragraph-up
1810 * \li Origin: Asger, 1 Oct 1996
1813 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1815 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1816 * \li Action: Move the cursor and select the text to the next paragraph (or
1817 begining of the current one) in upward direction.
1818 * \li Syntax: paragraph-up-select
1819 * \li Origin: Asger, 1 Oct 1996
1822 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1824 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1825 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1826 in downward direction.
1827 * \li Syntax: paragraph-down
1828 * \li Origin: Asger, 1 Oct 1996
1831 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1833 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1834 * \li Action: Move the cursor and select the text to the next paragraph (or
1835 begining of the current one) in downward direction.
1836 * \li Syntax: paragraph-down-select
1837 * \li Origin: Asger, 1 Oct 1996
1840 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1842 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1843 * \li Action: Jump to a paragraph given by its id number and optionally the
1844 desired position within the paragraph.
1845 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1846 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1847 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1848 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1849 <POSITION_IN_PAR>: desired position within the paragraph
1850 * \li Origin: Dekel, 26 Aug 2000
1853 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1855 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1856 * \li Action: Breaks the current paragraph at the current location.
1857 * \li Syntax: break-paragraph
1860 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1862 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1863 * \li Action: Breaks the current paragraph at the current location.
1864 * \li Notion: Removes the selection.
1865 * \li Syntax: break-paragraph [<LAYOUT>]
1866 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1867 to default layout) when the cursor is at the end of
1871 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1873 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1874 * \li Action: Change paragraph settings.
1875 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1876 This function only modifies, and does not override, existing settings.
1877 Note that the "leftindent" indent setting is deprecated.
1878 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1879 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1880 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1881 <ALIGN>: \\align block|left|right|center|default\n
1882 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1883 * \li Origin: rgh, Aug 15 2007
1886 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1888 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1889 * \li Action: Change paragraph settings.
1890 * \li Notion: Overwrite all nonspecified settings to the default ones.
1891 Use paragraph-params lfun if you don't want to overwrite others settings.
1892 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1893 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1894 * \li Origin: leeming, 30 Mar 2004
1897 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1899 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1900 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1901 * \li Notion: This is internal LFUN, not to be used by users. Called internally
1902 by #LFUN_DIALOG_UPDATE.
1903 * \li Origin: leeming, 13 Mar 2003
1906 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1909 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1910 * \li Action: Move the current group in the upward direction in the
1911 structure of the document.
1912 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1913 the whole substructure of the group.
1914 * \li Syntax: outline-up
1915 * \li Origin: Vermeer, 23 Mar 2006
1918 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1920 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1921 * \li Action: Move the current group in the downward direction in the
1922 structure of the document.
1923 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1924 the whole substructure of the group.
1925 * \li Syntax: outline-down
1926 * \li Origin: Vermeer, 23 Mar 2006
1929 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1931 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1932 * \li Action: Moves the current group in the downward direction in the
1933 hierarchy of the document structure.
1934 * \li Notion: Part -> Chapter -> Section -> etc.
1935 * \li Syntax: outline-in
1936 * \li Origin: Vermeer, 23 Mar 2006
1939 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1941 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1942 * \li Action: Moves the current group in the upward direction in the
1943 hierarchy of the document structure.
1944 * \li Notion: Part <- Chapter <- Section <- etc.
1945 * \li Syntax: outline-out
1946 * \li Origin: Vermeer, 23 Mar 2006
1949 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1951 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1952 * \li Action: Edit the inset at cursor with an external application,
1953 * if one is attributed.
1954 * \li Syntax: inset-edit [<INSET_PARAMS>]
1955 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
1956 Currently only the filename will be considered.
1957 * \li Origin: JSpitzm, 27 Apr 2006
1960 { LFUN_INSET_EDIT, "inset-edit", ReadOnly, Edit },
1963 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
1964 * \li Action: Inserts table into the document.
1965 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
1966 * \li Params: In case no arguments are given show insert dialog.
1967 * \li Origin: Jug, 12 Apr 2000
1970 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1972 * \var lyx::FuncCode lyx::LFUN_TABULAR_FEATURE
1973 * \li Action: Sets various features to the table/cell on the current cursor position.
1974 * \li Notion: Various math-environment features are handled here as well, e.g.
1975 add-vline-left/right for Grid/Cases environment
1976 * \li Syntax: tabular-feature <FEATURE> [<ARG>]
1977 * \li Params: <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
1978 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
1979 align-left|align-right|align-center|align-block|valign-top|valign-bottom|
1980 valign-middle|m-align-left|m-align-right|m-align-center|m-valign-top|
1981 m-valign-bottom|m-valign-middle|multicolumn|set-all-lines|unset-all-lines|
1982 set-longtabular|unset-longtabular|set-pwidth|set-mpwidth|
1983 set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
1984 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
1985 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
1986 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
1987 set-special-column|set-special-multi|set-booktabs|unset-booktabs|
1988 set-top-space|set-bottom-space|set-interline-space|set-border-lines|
1989 tabular-valign-top|tabular-valign-middle|tabular-valign-bottom \n
1990 <ARG>: additional argument for some commands, use debug mode to explore its values.
1991 * \li Origin: Jug, 28 Jul 2000
1994 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1996 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
1997 * \li Action: Moves the cursor to the previous cell inside the table.
1998 * \li Syntax: cell-backward
1999 * \li Origin: Jug, 22 May 2000
2002 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
2004 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2005 * \li Action: Moves the cursor to the next cell inside the table.
2006 * \li Syntax: cell-forward
2009 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
2011 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2012 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2013 * \li Syntax: cell-split
2014 * \li Origin: Ale, 15 May 1997
2017 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2020 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2021 * \li Action: Register the document as an file inside version control system (RCS, CVS).
2022 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2023 of cvs/svn/rcs entries in the document's directory. \n
2024 See LyX Additional Features Manual (Version Control Chapter) for additional
2026 * \li Syntax: vc-register
2027 * \li Origin: Lgb, 1 Jul 1997
2030 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2032 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2033 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2034 * \li Notion: In RCS case this also unlocks the file.
2035 * \li Syntax: vc-check-in
2036 * \li Origin: Lgb, 1 Jul 1997
2039 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2041 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2042 * \li Action: Checks-out the document for edit (and locks it for RCS).
2043 * \li Notion: This is implemented only for RCS and SVN, not CVS.
2044 * \li Syntax: vc-check-out
2045 * \li Origin: Lgb, 1 Jul 1997
2048 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2050 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2051 * \li Action: Reverts the document to the last check-in/commit in VCS.
2052 * \li Syntax: vc-revert
2053 * \li Origin: Lgb, 1 Jul 1997
2056 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2058 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2059 * \li Action: Undo last check-in.
2060 * \li Notion: This is currently implemented only for RCS.
2061 * \li Syntax: vc-check-out
2062 * \li Origin: Lgb, 1 Jul 1997
2065 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2067 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2068 * \li Action: Executes external command. This command is intended to support
2069 additional VCS commands.
2070 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2071 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2072 U - dUmmy - no flags \n
2073 D - Doc - need document loaded to proceed \n
2074 I - dIrty - mark document dirty \n
2075 R - Reload - ensure that the document is saved and reload it after command execution \n
2076 M - Message - ask for input string (commit message)\n
2077 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2078 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current document/path/message.
2079 * \li Sample: vc-command DR $$p "svn up"
2080 * \li Origin: sanda, 13 Jan 2009
2083 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2086 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2087 * \li Action: Toggles change tracking to on/off.
2088 * \li Syntax: changes-track
2089 * \li Origin: levon, 1 Oct 2002
2092 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2094 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2095 * \li Action: Toggles showing of change tracking in typesetted output.
2096 * \li Syntax: changes-output
2097 * \li Origin: jspitzm, 21 Jan 2005
2100 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2102 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2103 * \li Action: Moves the cursor to the position of the next change
2104 of the change tracking records.
2105 * \li Syntax: change-next
2106 * \li Origin: schmitt, 4 Oct 2006
2109 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2111 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2112 * \li Action: Open change tracking dialog for merging and moves the cursor
2113 to the position of the next change.
2114 * \li Syntax: changes-merge
2115 * \li Origin: Levon, 16 Oct 2002
2118 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2120 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2121 * \li Action: Accepts tracked change inside the selection.
2122 * \li Syntax: change-accept
2123 * \li Origin: Levon, 16 Oct 2002
2126 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2128 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2129 * \li Action: Rejects tracked change inside the selection.
2130 * \li Syntax: change-accept
2131 * \li Origin: Levon, 16 Oct 2002
2134 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2136 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2137 * \li Action: Accepts all tracked changes in the document.
2138 * \li Syntax: all-changes-accept
2139 * \li Origin: Levon, 16 Oct 2002
2142 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2144 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2145 * \li Action: Rejects all tracked changes in the document.
2146 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2147 * \li Syntax: all-changes-reject
2148 * \li Origin: Levon, 16 Oct 2002
2151 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2154 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2155 * \li Action: Apply data for an inset.
2156 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2157 be applied. This is either changed to #LFUN_INSET_MODIFY or
2158 #LFUN_INSET_INSERT depending on the context where it is called.
2159 * \li Syntax: inset-apply <ARGS>
2160 * \li Params: See #LFUN_INSET_INSERT .
2163 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2165 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2166 * \li Action: Dissolve the current inset into text.
2167 * \li Syntax: inset-dissolve [<INSET>]
2168 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2169 is dissolved. For example "dissolve" entry in the charstyles
2170 sub-menu should only dissolve the charstyle inset, even if the
2171 cursor is inside several nested insets of different type.\n
2172 For values see #lyx::InsetLayout::lyxtype_ .
2173 * \li Origin: JSpitz, 7 Aug 2006
2176 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
2178 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2179 * \li Action: Insert new inset (type given by the parameters).
2180 * \li Syntax: inset-insert <INSET> <ARGS>
2181 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
2182 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2183 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
2185 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2186 where <label name> is the name of the referenced label and
2187 <Format> is one of the following: \n
2188 ref -- <reference> \n
2189 eqref -- (<reference>) \n
2190 pageref -- <page> \n
2191 vpageref -- on <page> \n
2192 vref -- <reference> on <page> \n
2193 prettyref -- Formatted reference
2196 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2198 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2199 * \li Action: Modify existing inset.
2200 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2201 floats, graphics, include, label, listings, note,
2202 phantom, ref, space, tabular, vspace, wrap insets.
2203 * \li Syntax: inset-modify <INSET> <ARGS>
2204 * \li Params: See #LFUN_INSET_INSERT for further details.
2207 { LFUN_INSET_MODIFY, "", Noop, Hidden },
2209 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
2210 * \li Action: Modify the inset at cursor position, if there is one.
2211 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2212 floats, graphics, include, label, listings, note,
2213 phantom, ref, space, tabular, vspace, wrap insets.
2214 * \li Syntax: next-inset-modify <INSET> <ARGS>
2215 * \li Syntax: next-inset-modify changetype <TYPE>
2216 * \li Params: See #LFUN_INSET_INSERT for further details.
2217 * \li Origin: JSpitzm, 23 Mar 2008
2220 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", Noop, Edit },
2222 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2223 * \li Action: Updates the values inside the dialog from the inset.
2224 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2225 by #LFUN_DIALOG_UPDATE
2226 * \li Params: <DIALOG-NAME>
2227 * \li Origin: leeming, 25 Feb 2003
2230 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2232 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2233 * \li Action: Open the inset's properties dialog.
2234 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2235 * \li Syntax: inset-settings <INSET>
2236 * \li Params: <INSET>: <box|branch|ert|float|listings|note|phantom|tabular|wrap>
2239 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
2241 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
2242 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
2243 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
2244 be entered. Also cf. #LFUN_INSET_SETTINGS.
2245 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2246 floats, graphics, include, label, listings, note,
2247 phantom, ref, space, tabular, vspace, wrap insets.
2248 * \li Syntax: next-inset-toggle <ARG>
2249 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
2250 * \li Origin: leeming, 30 Mar 2004
2253 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
2255 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2256 * \li Action: Toggles the collapsable inset we are currently in.
2257 * \li Syntax: inset-toggle [<ARG>]
2258 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2259 open/close/toggle are for collapsable insets. close can be currently used
2260 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
2261 assign synchronize the branch-inset with activation status of the branch.
2262 Used for global toggling when changed activation.
2263 * \li Origin: lasgouttes, 19 Jul 2001
2266 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
2268 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
2269 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
2270 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
2271 * \li Syntax: all-insets-toggle <STATE> <INSET>
2272 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
2273 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets
2274 * \li Origin: leeming, 30 Mar 2004
2277 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
2279 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2280 * \li Action: Set the group for the graphics inset on the cursor position.
2281 * \li Syntax: set-graphics-group [<GROUP>]
2282 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2283 the graphics inset is removed from the current group.
2284 * \li Origin: sanda, 6 May 2008
2287 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2290 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2291 * \li Action: Moves the cursor out of the current slice, going forward.
2292 * \li Notion: Cursor movement within an inset may be different than cursor
2293 movement in the surrounding text. This action should be called
2294 automatically by the cursor movement within the inset, when
2295 movement within the inset has ceased (reached the end of the
2296 last paragraph, for example), in order to move correctly
2297 back into the surrounding text.
2300 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2302 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2303 * \li Action: Moves the cursor out of the current slice, going backwards.
2304 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2307 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2309 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2310 * \li Action: Moves the cursor out of the current slice, going right.
2311 * \li Notion: See also #LFUN_FINISHED_FORWARD
2314 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2316 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2317 * \li Action: Moves the cursor out of the current slice, going left.
2318 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2321 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2324 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2325 * \li Action: Set language from the current cursor position.
2326 * \li Syntax: language <LANG>
2327 * \li Params: <LANG>: Requested language. Look in lib/languages for
2329 * \li Origin: Dekel, 2 Mar 2000
2332 { LFUN_LANGUAGE, "language", Noop, Edit },
2335 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2336 * \li Action: Goto a label.
2337 * \li Syntax: label-goto [<LABEL>]
2338 * \li Params: <LABEL>: Requested label. If no label is given and reference
2339 is on cursor position, Bookmark 0 is saved and
2340 cursor moves to the position of referenced label.
2341 * \li Origin: Ale, 6 Aug 1997
2344 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2346 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2347 * \li Action: Inserts label to text or displayed formula.
2348 * \li Syntax: label-insert [<LABEL>]
2349 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2350 name will be opened.
2353 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2355 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2356 * \li Action: Go to the next label or cross-reference.
2357 * \li Syntax: reference-next
2358 * \li Origin: Dekel, 14 Jan 2001
2361 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2364 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2365 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2366 if necessary. Note that bookmarsk are saved per-session, not
2368 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2369 1. to the paragraph you are currently editing \n
2370 2. to the paragraph from where you are jumping to the last-edited
2371 position (jump-back feature) \n
2372 3. when jumping from crossreference to the requested label by
2374 * \li Syntax: bookmark-goto <NUMBER>
2375 * \li Params: <NUMBER>: the number of the bookmark to restore.
2376 * \li Origin: Dekel, 27 January 2001
2379 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2381 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2382 * \li Action: Save a bookmark.
2383 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2384 must be between 1 and 9, inclusive. Note that bookmarks are
2385 saved per-session, not per file.
2386 * \li Syntax: bookmark-save <NUMBER>
2387 * \li Params: <NUMBER>: the number of the bookmark to save.
2388 * \li Origin: Dekel, 27 January 2001
2391 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2393 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2394 * \li Action: Clears the list of saved bookmarks.
2395 * \li Syntax: bookmark-clear
2396 * \li Origin: bpeng, 31 October 2006
2399 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2402 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2403 * \li Action: Open the given help file according to the language setting.
2404 * \li Syntax: help-open <FILE>[.lyx]
2405 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2406 * \li Origin: Jug, 27 Jun 1999
2409 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2411 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2412 * \li Action: Terminates the current LyX instance.
2413 * \li Notion: Terminates the current LyX instance, asking whether to save
2414 modified documents, etc.
2415 * \li Syntax: lyx-quit
2418 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2420 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2421 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2422 * \li Notion: Skiping "auto" when allowauto is false.
2423 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2424 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2425 minibuffer|review|view/update|math_panels|vcs
2426 * \li Origin: Edwin, 21 May 2007
2429 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2431 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2432 * \li Action: Opens the menu given by its name.
2433 * \li Syntax: menu-open <NAME>
2434 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2437 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2439 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2440 * \li Action: Various UI visibility-toggling actions.
2441 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2442 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2443 menubar : Toggle visibility of the menubar.\n
2444 scrollbar : Toggle visibility of the scrollbar.\n
2445 frame : Toggle visibility of the frames around editing window.\n
2446 fullscreen : Toggle fullscreen mode. This also covers calling the
2447 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2448 custom tweaks of the toolbars should be used.
2449 * \li Origin: sanda, 9 Feb 2007
2452 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2455 * \var lyx::FuncCode lyx::WINDOW_NEW
2456 * \li Action: Creates new empty LyX window.
2457 * \li Notion: Already opened documents from the previous window can be found under View menu.
2458 * \li Syntax: window-new [<GEOMETRY>]
2459 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2460 accepted only on Windows platform.
2461 * \li Origin: Abdel, 21 Oct 2006
2464 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2466 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2467 * \li Action: Closes the current LyX window.
2468 * \li Syntax: window-close
2469 * \li Origin: Abdel, 23 Oct 2006
2472 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2475 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2476 * \li Action: Creates another split view of current buffer.
2477 * \li Notion: All split views act in the same way indpendently.
2478 * \li Syntax: split-view <vertical|horizontal>
2479 * \li Params: horizontal : The work areas are laid out side by side.\n
2480 vertical : The work areas laid out vertically.
2481 * \li Origin: Abdel, 20 Feb 2008
2484 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2487 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2488 * \li Action: Close the current tab group.
2489 * \li Notion: This only closes the work areas, not the buffer themselves.
2490 The still opened buffers can be visualized in another tab group.
2491 * \li Syntax: close-tab-group
2492 * \li Origin: Abdel, 21 Feb 2008
2495 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2497 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2498 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2499 * \li Syntax: dialog-show <NAME> [<DATA>]
2500 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2501 document|errorlist|ert|external|file|findreplace|float|graphics|\n
2502 include|index|info|nomenclature|label|listings|log|mathdelimiter|\n
2503 mathmatrix|note|paragraph|phantom|prefs|print|ref|sendto|space|\n
2504 spellchecker|symbols|tabular|tabularcreate|thesaurus|texinfo|toc|href|\n
2505 view-source|vspace|wrap|<SPECIAL> \n
2506 <SPECIAL>: latexlog|vclog \n
2507 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2509 * \li Origin: leeming, 17 Jun 2003
2512 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2514 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2515 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2516 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2517 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2518 * \li Params: See #LFUN_DIALOG_SHOW .
2519 * \li Origin: leeming, 25 Feb 2003
2522 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2524 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2525 * \li Action: Updates the dialog values from the inset/paragraph/document.
2526 * \li Syntax: dialog-update <NAME>
2527 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2529 * \li Origin: leeming, 25 Feb 2003
2532 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2534 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2535 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2536 * \li Syntax: dialog-hide <NAME>
2537 * \li Params: See #LFUN_DIALOG_SHOW .
2538 * \li Origin: leeming, 25 Feb 2003
2541 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2543 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2544 * \li Action: Toggles dialog between showed/hidden state.
2545 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2546 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2547 * \li Params: See #LFUN_DIALOG_SHOW .
2548 * \li Origin: JSpitzm, 30 Apr 2007
2551 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2553 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2554 * \li Action: Closes opened connection to opened inset.
2555 * \li Notion: Connection is used for apply functions.
2556 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2557 * \li Origin: leeming, 25 Feb 2003
2560 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2563 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2564 * \li Action: This function is called when mouse button is pressed (inside workarea).
2565 Action depends on the context.
2566 * \li Notion: This is internal LFUN, not to be used by users.
2567 * \li Origin: Andre, 9 Aug 2002
2570 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2572 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2573 * \li Action: This function is called when double click on mouse button is
2574 pressed (inside workarea). Action depends on the context.
2575 * \li Notion: This is internal LFUN, not to be used by users.
2576 * \li Origin: Andre, 9 Aug 2002
2579 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2581 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2582 * \li Action: This function is called when triple click on mouse button is
2583 pressed (inside workarea). Action depends on the context.
2584 * \li Notion: This is internal LFUN, not to be used by users.
2585 * \li Origin: Andre, 9 Aug 2002
2588 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2590 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2591 * \li Action: This function is called when mouse cursor is moving over the text.
2592 Action depends on the context.
2593 * \li Notion: This is internal LFUN, not to be used by users.
2594 * \li Origin: Andre, 9 Aug 2002
2597 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2599 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2600 * \li Action: This function is called when mouse button is released (inside workarea).
2601 Action depends on the context.
2602 * \li Notion: This is internal LFUN, not to be used by users.
2603 * \li Origin: Andre, 9 Aug 2002
2606 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2609 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2610 * \li Action: Turn off the loaded keyboard map.
2611 * \li Syntax: keymap-off
2614 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2616 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2617 * \li Action: Turn on the primary keyboard map.
2618 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2619 keyboard support. They can be still used to maintain uniform keyboard
2620 layout across the various plaforms.\n
2621 The language is to be set in the Preferences dialog.
2622 * \li Syntax: keymap-primary
2625 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2627 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2628 * \li Action: Turn on the secondary keyboard map.
2629 * \li Syntax: keymap-secondary
2632 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2634 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2635 * \li Action: Toggles keyboard maps (first/second/off).
2636 * \li Syntax: keymap-toggle
2637 * \li Origin: leeming, 30 Mar 2004
2640 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2643 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2644 * \li Action: Returns the current layout (that is environment) name
2645 on the cursor position.
2646 * \li Syntax: server-get-layout
2649 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2651 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2652 * \li Action: Returns path and file name of the currently edited document.
2653 * \li Syntax: server-get-filename
2656 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2658 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2659 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2660 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
2661 * \li Origin: Edmar, 23 Dec 1998
2664 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
2666 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2667 * \li Action: Sends notify message about the last key-sequence to client.
2668 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2669 See also Debug extensions section in Additional features manual.
2670 * \li Syntax: server-notify
2673 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2675 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2676 * \li Action: Sets the cursor position based on the editing area coordinates
2677 (similar as clicking on that point with left mouse button).
2678 * \li Syntax: server-set-xy <X> <Y>
2681 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2683 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2684 * \li Action: Returns the coordinates of cursor position in the editing area.
2685 * \li Syntax: server-get-xy
2688 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2691 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2692 * \li Action: Generates the code (literate programming).
2693 * \li Notion: Latex file with extension \literate_extension is generated.
2694 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2695 \build_error_filter to process the compilation error messages. \n
2696 In case you want to process your literate file with a script, or some other program,
2697 just insert in your lyxrc file an entry with:\n
2698 \build_command "my_script my_arguments" \n
2699 The \build_error_filter differs from the \literate_error_filter only in that the
2700 former will identify error messages from your compiler.
2701 * \li Syntax: build-program
2704 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2707 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2708 * \li Action: Saves the current buffer to a temporary file.
2709 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2710 is called automatically by LyX, to "autosave" the current buffer.
2711 * \li Syntax: buffer-auto-save
2714 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2716 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2717 * \li Action: Loads the given child document.
2718 * \li Notion: The current document is treated as a parent.
2719 * \li Syntax: buffer-child-open <FILE>
2720 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2721 * \li Origin: Ale, 28 May 1997
2724 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2726 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2727 * \li Action: Runs chktex for the current document.
2728 * \li Syntax: buffer-chktex
2729 * \li Origin: Asger, 30 Oct 1997
2732 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2734 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2735 * \li Action: Toggles compression of the current document on/off.
2736 * \li Syntax: buffer-toggle-compression
2737 * \li Origin: bpeng, 27 Apr 2006
2740 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2742 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2743 * \li Action: Closes the current buffer.
2744 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2745 if the buffer has been modified.
2746 * \li Syntax: buffer-close
2749 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2751 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2752 * \li Action: Exports the current buffer (document) to the given format.
2753 * \li Syntax: buffer-export <FORMAT>
2754 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2755 can find in Tools->Preferences->File formats->Format.
2756 Usual format you will enter is "pdf2" (pdflatex),
2757 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2758 In case of "custom" you will be asked for a format you
2759 want to start from and for the command that you want to
2760 apply to this format. Internally the control is then passed
2761 to #LFUN_BUFFER_EXPORT_CUSTOM.
2762 * \li Origin: Lgb, 29 Jul 1997
2765 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2767 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2768 * \li Action: Exports the current buffer (document) from the given format using
2769 the given command on it.
2770 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2771 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2772 intermediate file).\n
2773 <COMMAND> this command will be launched on the file. Note that you can
2774 use "$$FName" string to qualify the intermediate file.
2775 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2776 * \li Origin: leeming, 27 Mar 2004
2779 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2781 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2782 * \li Action: Prints the current document.
2783 * \li Notion: Many settings can be given via the preferences dialog.
2784 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2785 * \li Params: <TARGET> is either "printer" or "file".\n
2786 <TARGER-NAME> is either "default" or file name or printer name.\n
2787 <COMMAND> command ensuring the printing job.
2788 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2789 * \li Origin: leeming, 28 Mar 2004
2792 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2794 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2795 * \li Action: Import a given file as a lyx document.
2796 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2797 defined convertors in preferences. Look into File->Import menu to get
2798 an idea of the currently active import formats.
2799 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2800 * \li Origin: Asger, 24 Jul 1998
2803 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
2805 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
2806 * \li Action: Creates a new buffer (that is, document).
2807 * \li Notion: Implicit path can be set in Preferences dialog.
2808 * \li Syntax: buffer-new [<FILE>]
2809 * \li Params: <FILE>: filename of created file with absolute path.
2812 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
2814 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
2815 * \li Action: Creates a new buffer (that is, document) from a template.
2816 * \li Notion: Path for new files and templates can be set in Preferences dialog.
2817 Template will be asked for via Open-dialog.
2818 * \li Syntax: buffer-new-template [<FILE>]
2819 * \li Params: <FILE>: filename of created file with absolute path.
2822 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2824 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2825 * \li Action: Reverts opened document.
2826 * \li Syntax: buffer-reload
2827 * \li Origin: Asger, 2 Feb 1997
2830 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2832 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2833 * \li Action: Switch to the given buffer.
2834 * \li Notion: This is useful also in case you need simultaneously more views of the edited
2835 document in different LyX windows.
2836 * \li Syntax: buffer-new-template <BUFFER>
2837 * \li Params: <BUFFER>: already opened document which is to be shown.
2840 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2842 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2843 * \li Action: Toggle editing mode of the current document between read/write and read-only.
2844 * \li Notion: In the ->Readonly mode checks-in/commits the data if the file is under version control.
2845 In the Readonly-> mode checkouts the data from repository. \n
2846 If these operations fail, buffer won't be toggled.
2847 * \li Syntax: buffer-toggle-read-only
2848 * \li Origin: Lgb, 27 May 1997
2851 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2853 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2854 * \li Action: Displays current buffer in chosen format.
2855 * \li Notion: Displays the contents of the current buffer in the chosen
2856 format, for example, PDF or DVI. This runs the necessary
2857 converter, calls the defined viewer, and so forth.
2858 * \li Syntax: buffer-view <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.
2864 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2866 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2867 * \li Action: Exports the current document and put the result into the
2868 temporary directory.
2869 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2870 the output will be rewriten - updated. This is useful in case your viewer
2871 is able to detect such changes (e.g. ghostview for postscript).
2872 * \li Syntax: buffer-update <FORMAT>
2873 * \li Params: <FORMAT>: The format to display, where this is one of the
2874 formats defined (in the current GUI) in the
2875 Tools>Preferences>File Formats dialog.
2876 * \li Origin: Dekel, 5 Aug 2000
2879 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2882 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2883 * \li Action: Saves the current buffer.
2884 * \li Notion: Saves the current buffer to disk, using the filename that
2885 is already associated with the buffer, asking for one if
2886 none is yet assigned.
2887 * \li Syntax: buffer-write
2890 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2892 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2893 * \li Action: Rename and save current buffer.
2894 * \li Syntax: buffer-write-as <FILENAME>
2895 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2896 is with respect to the original location of the buffer/file.
2899 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2901 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2902 * \li Action: Save all changed documents.
2903 * \li Syntax: buffer-write-all
2904 * \li Origin: rgh, gpothier 6 Aug 2007
2907 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2909 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2910 * \li Action: Switch to the next opened document.
2911 * \li Notion: Note that this does not necessarily mean next in tabbar
2912 (for full list see View menu).
2913 * \li Syntax: buffer-next
2916 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2918 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2919 * \li Action: Switch to the previous opened document.
2920 * \li Syntax: buffer-previous
2923 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2925 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2926 * \li Action: When run from a child document, this updates (exports) document built
2927 from the master buffer. If a master is not found, it updates the
2929 * \li Syntax: master-buffer-update
2930 * \li Origin: Tommaso, 20 Sep 2007
2933 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2935 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2936 * \li Action: When run from a child document, this command shows a preview built
2937 from the master buffer. If a master is not found, it previews the
2939 * \li Syntax: master-buffer-view
2940 * \li Origin: Tommaso, 20 Sep 2007
2943 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2945 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2946 * \li Action: Set language of the current document.
2947 * \li Syntax: buffer-language <LANG>
2948 * \li Params: <LANG>: language name. See lib/languages for list.
2949 * \li Origin: leeming, 30 Mar 2004
2952 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2954 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2955 * \li Action: Save the current document settings as default.
2956 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2957 * \li Syntax: buffer-save-as-default [<ARGS>]
2958 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2959 you can find in document header of usual .lyx file.
2960 * \li Origin: leeming, 30 Mar 2004
2963 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2965 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2966 * \li Action: Apply the given settings to the current document.
2967 * \li Syntax: buffer-params-apply [<ARGS>]
2968 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2969 you can find in document header of usual .lyx file.
2970 * \li Origin: leeming, 30 Mar 2004
2973 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2976 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2977 * \li Action: Inserts another LyX file.
2978 * \li Syntax: file-insert [<FILE>]
2979 * \li Params: <FILE>: Filename to be inserted.
2982 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2984 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2985 * \li Action: Inserts plain text file.
2986 * \li Syntax: file-insert-plaintext [<FILE>]
2987 * \li Params: <FILE>: Filename to be inserted.
2988 * \li Origin: CFO-G, 19 Nov 1997
2991 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2993 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2994 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2995 * \li Syntax: file-insert-plaintext-para [<FILE>]
2996 * \li Params: <FILE>: Filename to be inserted.
2997 * \li Origin: Levon, 14 Feb 2001
3000 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3002 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3003 * \li Action: Open LyX document.
3004 * \li Syntax: file-open [<FILE>]
3005 * \li Params: <FILE>: Filename to be opened.
3008 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3011 * \var lyx::FuncCode lyx::LFUN_CALL
3012 * \li Action: Executes a command defined in a .def file.
3013 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3014 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
3015 where <NAME> is the name of the new command and <LFUN> is the lfun code
3016 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3017 \\def_file "FileName" allows to include another .def file. \n
3018 This is particularly useful in connection with toolbar buttons:
3019 Since the name of the button image for this lfun is
3020 lib/images/commands/<NAME>.png this is the way to assign an image
3021 to a complex command-sequence.
3022 * \li Syntax: call <NAME>
3023 * \li Params: <NAME>: Name of the command that must be called.
3024 * \li Origin: broider, 2 Oct 2007
3027 { LFUN_CALL, "call", NoBuffer, System },
3029 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3030 * \li Action: Simulate halting Meta key (Alt key on PCs).
3031 * \li Notion: Used for buffer editation not for GUI control.
3032 * \li Syntax: meta-prefix
3035 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3037 * \var lyx::FuncCode lyx::LFUN_CANCEL
3038 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3039 * \li Syntax: cancel
3042 { LFUN_CANCEL, "cancel", NoBuffer, System },
3045 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3046 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
3047 * \li Notion: Usually bound to M-x shortcut.
3048 * \li Syntax: command-execute
3051 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3053 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3054 * \li Action: Return the current key sequence and available options as a string.
3055 * \li Notion: No options are added if no current map exists. \n
3056 This is probably usable only with connection to lyxserver.
3057 * \li Syntax: command-prefix
3060 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3062 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3063 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3064 * \li Syntax: command-sequence <CMDS>
3065 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3066 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3067 * \li Origin: Andre, 11 Nov 1999
3070 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3072 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3073 * \li Action: Runs the first listed command that is enabled.
3074 * \li Notion: This can be used to bind multiple functions to a single key,
3075 and then which one is used will depend upon the context.
3076 * \li Syntax: command-alternatives <CMDS>
3077 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3078 * \li Sample: command-alternatives completion-accept;cell-forward
3079 * \li Origin: rgh, 24 September 2008
3082 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3084 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3085 * \li Action: Shows message in statusbar (for script purposes).
3086 * \li Syntax: message <STRING>
3087 * \li Origin: Lgb, 8 Apr 2001
3090 { LFUN_MESSAGE, "message", NoBuffer, System },
3092 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3093 * \li Action: Save user preferences.
3094 * \li Syntax: preferences-save
3095 * \li Origin: Lgb, 27 Nov 1999
3098 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3100 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3101 * \li Action: Reconfigure the automatic settings.
3102 * \li Syntax: reconfigure
3103 * \li Origin: Asger, 14 Feb 1997
3106 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3108 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3109 * \li Action: Apply the given settings to user preferences.
3110 * \li Syntax: lyxrc-apply <SETTINGS>
3111 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3112 to get an idea which commands to use and their syntax.
3113 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3116 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3118 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3119 * \li Action: Determine whether keep cursor inside the editing window regardless
3120 the scrollbar movement.
3121 * \li Syntax: toggle-cursor-follows-scrollbar
3122 * \li Origin: ARRae, 2 Dec 1997
3125 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3127 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3128 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3129 * \li Notion: A new color entry is created if the color is unknown.
3130 Color names can be stored as a part of user settings.
3131 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3132 * \li Origin: SLior, 11 Jun 2000
3135 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3137 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3138 * \li Action: Count the statistics (number of words and characters)
3139 in the document or in the given selection.
3140 * \li Notion: Note that this function gives the number of words/chars written,
3141 not the number of characters which will be typeset.
3142 * \li Syntax: statistics
3143 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3146 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3148 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3149 * \li Action: Show the inline completion at the cursor position.
3150 * \li Syntax: completion-inline
3151 * \li Origin: sts, Feb 19 2008
3154 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3156 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3157 * \li Action: Show the completion popup at the cursor position.
3158 * \li Syntax: completion-popup
3159 * \li Origin: sts, Feb 19 2008
3162 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3164 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3165 * \li Action: Try to complete the word or command at the cursor position.
3166 * \li Syntax: complete
3167 * \li Origin: sts, Feb 19 2008
3170 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3173 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3174 * \li Action: Try to cancel completion, either the popup or the inline completion
3175 * \li Syntax: completion-cancel
3176 * \li Origin: sts, Sep 07 2008
3179 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3181 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3182 * \li Action: Accept suggested completion.
3183 * \li Syntax: completion-accept
3184 * \li Origin: sanda, Sep 08 2008
3187 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3191 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3192 * \li Action: Activate the branch
3193 * \li Syntax: branch-activate <BRANCH>
3194 * \li Params: <BRANCH>: The branch to activate
3195 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3196 could be used to export a pdf with the answers branch included
3197 without one's having to open LyX and activate the branch manually.
3198 * \li Origin: rgh, 27 May 2008
3201 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
3203 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3204 * \li Action: De-activate the branch
3205 * \li Syntax: branch-deactivate <BRANCH>
3206 * \li Params: <BRANCH>: The branch to deactivate
3207 * \li Origin: rgh, 27 May 2008
3210 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
3213 * \var lyx::FuncCode lyx::LFUN_COPY_LABEL_AS_REF
3214 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3215 * \li Syntax: copy-label-as-reference
3216 * \li Origin: sts, 16 Nov 2008
3219 { LFUN_COPY_LABEL_AS_REF, "copy-label-as-reference", ReadOnly | NoUpdate, Edit },
3221 { LFUN_NOACTION, "", Noop, Hidden }
3222 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3225 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
3226 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3233 LyXAction::LyXAction()
3239 // Returns an action tag from a string.
3240 FuncRequest LyXAction::lookupFunc(string const & func) const
3242 string const func2 = trim(func);
3244 if (func2.empty()) {
3245 return FuncRequest(LFUN_NOACTION);
3249 string const arg = split(func2, cmd, ' ');
3251 func_map::const_iterator fit = lyx_func_map.find(cmd);
3253 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
3257 string const LyXAction::getActionName(FuncCode action) const
3259 info_map::const_iterator const it = lyx_info_map.find(action);
3260 return it != lyx_info_map.end() ? it->second.name : string();
3264 LyXAction::func_type LyXAction::getActionType(FuncCode action) const
3266 info_map::const_iterator const it = lyx_info_map.find(action);
3267 return it != lyx_info_map.end() ? it->second.type : Hidden;
3271 bool LyXAction::funcHasFlag(FuncCode action,
3272 LyXAction::func_attrib flag) const
3274 info_map::const_iterator ici = lyx_info_map.find(action);
3276 if (ici == lyx_info_map.end()) {
3277 LYXERR0("action: " << action << " is not known.");
3278 LASSERT(false, /**/);
3281 return ici->second.attrib & flag;
3285 LyXAction::const_func_iterator LyXAction::func_begin() const
3287 return lyx_func_map.begin();
3291 LyXAction::const_func_iterator LyXAction::func_end() const
3293 return lyx_func_map.end();
3297 LyXErr & operator<<(LyXErr & l, FuncCode code)
3300 l.stream() << lyxaction.getActionName(code);