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.
61 * Use spaces for indentation (doxy -> .lyx generator is tab-sensitive).
65 * \var lyx::FuncCode lyx::LFUN_
78 void LyXAction::newFunc(FuncCode action, string const & name,
79 unsigned int attrib, LyXAction::FuncType type)
81 lyx_func_map[name] = action;
84 tmpinfo.attrib = attrib;
86 lyx_info_map[action] = tmpinfo;
90 // Needed for LFUNs documentation to be accepted, since doxygen won't take
91 // \var inside functions.
92 #ifndef DOXYGEN_SHOULD_SKIP_THIS
93 void LyXAction::init()
95 // This function was changed to use the array below in initalization
96 // instead of calling newFunc numerous times because of compilation
97 // times. Since the array is not static we get back the memory it
98 // occupies after the init is completed. It compiles several
112 ev_item const items[] = {
115 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
116 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
117 to the next character typed.
118 * \li Syntax: accent-acute
121 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
123 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
124 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
125 to the next character typed.
126 * \li Syntax: accent-breve
129 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
131 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
132 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
133 to the next character typed.
134 * \li Syntax: accent-caron
137 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
139 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
140 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
141 to the next character typed.
142 * \li Syntax: accent-cedilla
145 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
147 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
148 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
149 to the next character typed.
150 * \li Syntax: accent-circle
153 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
155 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
156 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
157 to the next character typed.
158 * \li Syntax: accent-circumflex
161 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
163 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
164 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
165 to the next character typed.
166 * \li Syntax: accent-dot
169 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
171 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
172 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
173 to the next character typed.
174 * \li Syntax: accent-grave
177 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
179 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
180 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
181 to the next character typed.
182 * \li Syntax: accent-grave
185 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
187 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
188 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
189 to the next character typed.
190 * \li Syntax: accent-macron
193 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
195 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
196 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
197 to the next character typed.
198 * \li Syntax: accent-ogonek
201 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
203 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
204 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
205 over the next two character typed.
206 * \li Notion: The following char will finish the tie.
207 * \li Syntax: accent-tie
210 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
212 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
213 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
214 over the next character typed.
215 * \li Syntax: accent-tilde
218 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
220 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
221 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
222 over the next character typed.
223 * \li Syntax: accent-umlaut
226 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
228 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
229 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
230 under the next character typed.
231 * \li Syntax: accent-underbar
234 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
236 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
237 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
238 under the next character typed.
239 * \li Syntax: accent-underdot
242 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
245 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
246 * \li Action: Inserts a caption inset.
247 * \li Syntax: caption-insert
248 * \li Origin: Lgb, 18 Jul 2000
251 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
253 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
254 * \li Action: Inserts the current date.
255 * \li Syntax: date-insert [<ARG>]
256 * \li Params: <ARG>: Format of date. The default value (%x) can be set
257 in Preferences->Date format. For possible formats
258 see manual page of strftime function.
259 * \li Origin: jdblair, 31 Jan 2000
262 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
264 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
265 * \li Action: Inserts a footnote inset.
266 * \li Syntax: footnote-insert
267 * \li Origin: Jug, 7 Mar 2000
270 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
272 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
273 * \li Action: Inserts an ERT inset.
274 * \li Syntax: ert-insert
275 * \li Origin: Jug, 18 Feb 2000
278 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
280 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
281 * \li Action: Inserts a float inset.
282 * \li Syntax: float-insert <TYPE>
283 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
284 "algorithm", "table", "figure" parameters can be given.
285 * \li Origin: Lgb, 27 Jun 2000
288 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
290 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
291 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
292 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
293 * \li Syntax: float-wide-insert <TYPE>
294 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
295 "algorithm", "table", "figure" parameters can be given.
296 * \li Origin: Lgb, 31 Oct 2001
299 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_FLOAT_LIST_INSERT
302 * \li Action: Inserts the list of floats in the document.
303 * \li Syntax: float-list-insert <TYPE>
304 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
305 "algorithm", "table", "figure" parameters can be given.
306 * \li Origin: Lgb, 3 May 2001
309 { LFUN_FLOAT_LIST_INSERT, "float-list-insert", Noop, Edit },
311 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
312 * \li Action: Inserts floats wrapped by the text around.
313 * \li Syntax: wrap-insert <TYPE>
314 * \li Params: <TYPE>: table|figure
315 * \li Origin: Dekel, 7 Apr 2002
318 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
320 * \var lyx::FuncCode lyx::LFUN_ARGUMENT_INSERT
321 * \li Action: Inserts an argument (short title) inset.
322 * \li Syntax: argument-insert
323 * \li Origin: vermeer, 12 Aug 2002
326 { LFUN_ARGUMENT_INSERT, "argument-insert", Noop, Edit },
328 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
329 * \li Action: Inserts a horizontal line.
330 * \li Syntax: line-insert
331 * \li Origin: Andre, Oct 27 2003
334 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
336 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
337 * \li Action: Inserts a new page.
338 * \li Syntax: newpage-insert <ARG>
339 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
340 * \li Origin: uwestoehr, 24 Nov 2007
343 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
345 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
346 * \li Action: Inserts a marginal note.
347 * \li Syntax: marginalnote-insert
348 * \li Origin: Lgb, 26 Jun 2000
351 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
353 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
354 * \li Action: Inserts a single unicode character.
355 * \li Syntax: unicode-insert <CHAR>
356 * \li Params: <CHAR>: The character to insert, given as its code
357 point, in hexadecimal.
358 * \li Sample: unicode-insert 0x0100
359 * \li Origin: Lgb, 22 Oct 2006
362 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
364 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
365 * \li Action: Inserts a new listings inset.
366 * \li Syntax: listing-insert
367 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
370 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
372 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
373 * \li Action: Inserts a new preview inset.
374 * \li Syntax: preview-insert
375 * \li Origin: vfr, 28 Mar 2010
378 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
380 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
381 * \li Action: Insert a tab into a listings inset.
382 * \li Notion: It also works on a selection.
383 * \li Syntax: tab-insert
384 * \li Origin: vfr, Sep 30 2008
387 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
389 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
390 * \li Action: Delete a tab or up to an equivalent amount of spaces from
392 * \li Notion: It also works on a selection - it removes a tab or spaces from the
393 beginning of each line spanned by the selection. This is useful if
394 you want to indent/unindent multiple lines in one action.
395 * \li Syntax: tab-delete
396 * \li Origin: vfr, Sep 30 2008
399 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
401 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
402 * \li Action: Inserts quotes according to the type and quote-language preference.
403 * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
405 * \li Syntax: quote-insert [<TYPE>]
406 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
409 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
411 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
412 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
413 information in a non-editable boxed InsetText.
414 * \li Notion: Apart from lfun arguments you can use the following method: \n
415 1. input the type and argument of this inset, e.g. "menu paste", in
417 2. select the text and run info-insert lfun.
418 * \li Syntax: info-insert <TYPE> <ARG>
419 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
420 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
422 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
423 lyxrc: name of rc_entry (e.g. bind_file) \n
424 lyxinfo: "version" - used version of LyX \n
425 package: name of latex package (e.g. listings) \n
426 textclass: name of textclass (e.g. article) \n
427 menu: name of lfun used in menu \n
428 icon: name of lfun used in toolbar \n
429 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
430 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
431 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
432 * \li Origin: bpeng, 7 Oct 2007
435 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
437 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
438 * \li Action: Inserts branch inset.
439 * \li Syntax: branch-insert <BRANCH-NAME>
440 * \li Origin: vermeer, 17 Aug 2003
443 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
445 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
446 * \li Action: Inserts Box inset.
447 * \li Syntax: box-insert [<TYPE>]
448 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
449 Framed is the default one.
450 * \li Origin: vermeer, 7 Oct 2003
453 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
455 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
456 * \li Action: Inserts CharStyle, Custom inset or XML short element.
457 * \li Notion: Look into the Customization manual for more information about
459 To make this command enabled the layout file for the document
460 class you're using has to load the character styles. There are
461 a few contained in the Logical Markup module. You can also of
462 course create some yourself. \n
463 For dissolving the element see #LFUN_INSET_DISSOLVE.
464 * \li Syntax: flex-insert <TYPE:Name>
465 * \li Params: TYPE: CharStyle|Custom|Element|Standard \n
466 Identifies whether this is a Character Style, a
467 Custom Inset or an XML Element, and which dynamical
468 sub-menu this flex inset is in on the LyX menu tree.
469 If Standard (currently unused): none of these.\n
470 Name: This name must be defined either in your layout file
471 or imported by some module. The definition is
472 InsetLayout <TYPE:Name>
473 * \li Sample: flex-insert CharStyle:Code
476 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
478 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
479 * \li Action: Inserts the given string (accordingly to the correct keymap).
480 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
481 settings "auto_region_delete".
482 * \li Syntax: self-insert <STRING>
485 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
487 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
488 * \li Action: Inserts one of horizontal space insets.
489 * \li Syntax: space-insert <NAME> [<LEN>]
490 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
491 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
493 <LEN>: length for custom spaces (hspace, hspace* for protected)
494 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
497 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
499 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
500 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
501 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
502 * \li Syntax: href-insert [<TARGET>]
503 * \li Origin: CFO-G, 21 Nov 1997
506 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
508 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
509 * \li Action: Inserts various characters into the document.
510 * \li Syntax: specialchar-insert <CHAR>
511 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
512 end-of-sentence, menu-separator.
513 * \li Origin: JSpitzm, 6 Dec 2007
516 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
518 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
519 * \li Action: Inserts table of contents.
520 * \li Syntax: toc-insert
521 * \li Origin: Lgb, 27 May 97
524 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
526 * \var lyx::FuncCode lyx::LFUN_APPENDIX
527 * \li Action: Start (or remove) Appendix on the given cursor position.
528 * \li Syntax: appendix
529 * \li Origin: ettrich, 5 May 1998
532 { LFUN_APPENDIX, "appendix", Noop, Edit },
535 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
536 * \li Action: Inserts Index entry.
537 * \li Notion: It automatically takes the word on the cursor position.
538 * \li Syntax: index-insert [<TYPE:Name>]
539 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
540 with an empty argument, the default index is selected.
541 * \li Origin: leeming, 3 Aug 2000
544 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
546 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
547 * \li Action: Inserts list of Index entries on a new page.
548 * \li Syntax: index-print [<TYPE:Name>]
549 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
550 with an empty argument, the default index is selected.
551 * \li Origin: Lgb, 27 Feb 1997
554 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
557 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
558 * \li Action: Inserts Nomenclature entry.
559 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
560 * \li Syntax: nomencl-insert [<SYMBOL>]
561 * \li Origin: Ugras, 4 Nov 2006
564 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
566 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
567 * \li Action: Inserts list of Nomenclature entries.
568 * \li Syntax: nomenclature-print
569 * \li Origin: Ugras, 4 Nov 2006
572 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
575 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
576 * \li Action: Inserts Note on the current cursor postion,
577 move selection inside the inset.
578 * \li Syntax: note-insert [<TYPE>]
579 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
582 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
584 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
585 * \li Action: Moves the cursor to the begining of next Note inset.
586 * \li Syntax: note-next
589 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
591 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
592 * \li Action: Inserts phantom on the current cursor postion,
593 move selection inside the inset.
594 * \li Syntax: phantom-insert [<TYPE>]
595 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
596 * \li Origin: uwestoehr, 30 Jan 2009
599 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
601 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
602 * \li Action: Inserts a line break or new line.
603 * \li Syntax: newline-insert [<ARG>]
604 * \li Params: <ARG>: <newline|linebreak> default: newline
605 * \li Origin: JSpitzm, 25 Mar 2008
608 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
610 * \var lyx::FuncCode lyx::LFUN_ESCAPE
611 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
612 Inside math mode jumps out of the math inset.
614 * \li Origin: Lgb, 17 May 2001
617 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
619 * \var lyx::FuncCode lyx::LFUN_DOWN
620 * \li Action: Moves the cursor one line in downward direction.
624 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
626 * \var lyx::FuncCode lyx::LFUN_UP
627 * \li Action: Moves the cursor one line in upward direction.
631 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
633 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
634 * \li Action: Moves the cursor one line in downward direction adding the current
635 position to the selection.
636 * \li Syntax: down-select
639 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
641 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
642 * \li Action: Moves the cursor one line in upward direction adding the current
643 position to the selection.
644 * \li Syntax: up-select
647 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
649 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
650 * \li Action: Moves the cursor one page in downward direction.
651 * \li Syntax: screen-down
654 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
656 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
657 * \li Action: Moves the cursor one page in upward direction.
658 * \li Syntax: screen-up
661 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
663 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
664 * \li Action: Moves the cursor one screen in downward direction adding the current
665 position to the selection.
666 * \li Syntax: screen-down-select
669 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
671 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
672 * \li Action: Moves the cursor one page in upward direction adding the current
673 position to the selection.
674 * \li Syntax: screen-up-select
677 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
679 * \var lyx::FuncCode lyx::LFUN_SCROLL
680 * \li Action: Scroll the buffer view.
681 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
682 * \li Syntax: scroll <TYPE> <QUANTITY>
683 * \li Params: <TYPE>: line|page\n
684 <QUANTITY>: up|down|<number>
685 * \li Origin: Abdel, Dec 27 2007
688 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
690 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
691 * \li Action: Recenters the screen on the current cursor position.
692 * \li Syntax: screen-recenter
695 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
698 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
699 * \li Action: Repositions the screen such that the cursor is visible.
700 * \li Syntax: screen-show-cursor
701 * \li Origin: vfr, 25 Mar 2009
704 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
707 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
708 * \li Action: Moves the cursor one position logically backwards.
709 * \li Notion: This is not the action which should be bound to the arrow keys,
710 because backwards may be left or right, depending on the
711 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
712 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
713 * \li Syntax: char-backward
716 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
718 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
719 * \li Action: Moves the cursor one position logically backwards, adding
720 traversed position to the selection.
721 * \li Notion: See also #LFUN_CHAR_BACKWARD.
722 * \li Syntax: char-backward-select
725 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
727 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
728 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
729 * \li Syntax: char-delete-backward
732 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
734 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
735 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
736 * \li Syntax: char-delete-forward
739 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
741 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
742 * \li Action: Moves the cursor one position logically forward.
743 * \li Notion: This is not the action which should be bound to the arrow keys,
744 because forward may be left or right, depending on the language.
745 The arrow keys should be bound to #LFUN_CHAR_LEFT or
746 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
747 * \li Syntax: char-forward
750 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
752 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
753 * \li Action: Moves the cursor one position logically forward, adding
754 traversed position to the selection.
755 * \li Notion: See also #LFUN_CHAR_FORWARD.
756 * \li Syntax: char-forward-select
759 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
761 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
762 * \li Action: Moves the cursor one position "to the left".
763 * \li Notion: This is the action which should be taken when the "left" key
764 is pressed. Generally, it moves the cursor one position to the
765 left. However, in Bidi text this become slightly more
766 complicated, and there are different modes of cursor movement.
767 In "visual mode", this moves left, plain and simple. In "logical
768 mode", movement is logically forward in RTL paragraphs, and
769 logically backwards in LTR paragraphs.
770 * \li Syntax: char-left
773 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
775 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
776 * \li Action: Moves the cursor one position "to the left", adding
777 traversed position to the selection.
778 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
779 * \li Syntax: char-left-select
782 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
784 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
785 * \li Action: Moves the cursor one position "to the right".
786 * \li Notion: This is the action which should be taken when the "right" key
787 is pressed. Generally, it moves the cursor one position to the
788 right. However, in Bidi text this become slightly more
789 complicated, and there are different modes of cursor movement.
790 In "visual mode", this moves right, plain and simple. In "logical
791 mode", movement is logically forward in LTR paragraphs, and
792 logically backwards in RTL paragraphs.
793 * \li Syntax: char-right
796 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
798 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
799 * \li Action: Moves the cursor one position "to the right", adding
800 traversed position to the selection.
801 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
802 * \li Syntax: char-right-select
805 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
808 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
809 * \li Action: Moves the cursor to the logically previous beginning of a word.
810 * \li Notion: This is not the action which should be bound to the arrow keys,
811 because backwards may be left or right, depending on the
812 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
813 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
814 * \li Syntax: word-backward
817 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
819 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
820 * \li Action: Moves the cursor to the logically previous beginning of a word,
821 adding the logically traversed text to the selection.
822 * \li Notion: See also #LFUN_WORD_BACKWARD.
823 * \li Syntax: word-backward-select
826 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
828 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
829 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
830 * \li Syntax: word-delete-backward
833 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
835 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
836 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
837 * \li Syntax: word-delete-forward
840 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
842 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
843 * \li Action: Search for a given string in forward direction.
844 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
845 * \li Syntax: word-find-forward [<STRING>]
846 * \li Origin: Etienne, 16 Feb 1998
849 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
851 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
852 * \li Action: Search for a given string in backward direction.
853 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
854 * \li Syntax: word-find-backward [<STRING>]
855 * \li Origin: Etienne, 20 Feb 1998
858 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
860 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
861 * \li Action: Search for next occurence of a string.
862 * \li Syntax: word-find [<DATA>]
863 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
864 If no parameter is given, search with last find-dialog
865 data is used for search (i.e. find-next).
866 * \li Origin: Andre, Jan 7 2004
869 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
871 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
872 * \li Action: Replace a string in the document.
873 * \li Syntax: word-replace [<DATA>]
874 * \li Params: <DATA>: data is of the form
877 <casesensitive> <matchword> <all> <forward>"
878 * \li Origin: Andre, Jan 7 2004
881 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
883 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
884 * \li Action: Search for next occurence of a pattern.
885 * \li Syntax: word-findadv [<DATA>]
886 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
887 If no parameter is given, search with last find-dialog
888 data is used for search (i.e. find-next).
889 * \li Origin: Tommaso, Nov 15 2007
892 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
894 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
895 * \li Action: Moves the cursor to the logically next beginning of a word.
896 * \li Notion: This is not the action which should be bound to the arrow keys,
897 because forward may be left or right, depending on the language.
898 The arrow keys should be bound to #LFUN_WORD_LEFT or
899 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
900 * \li Syntax: word-forward
903 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
905 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
906 * \li Action: Moves the cursor to the logically next beginning of a word,
907 adding the logically traversed text to the selection.
908 * \li Notion: See also #LFUN_WORD_FORWARD.
909 * \li Syntax: word-forward-select
912 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
914 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
915 * \li Action: Moves the cursor to the next beginning of a word "on the left".
916 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
917 "left" key is pressed. Generally, it moves the cursor to the
918 next beginning of a word on the left. However, in Bidi text this
919 become slightly more complicated, and there are different modes
920 of cursor movement. In "visual mode", this moves left, plain and
921 simple. In "logical mode", movement is logically forward in RTL
922 paragraphs, and logically backwards in LTR paragraphs.
923 * \li Syntax: word-left
924 * \li Origin: dov, 28 Oct 2007
927 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
929 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
930 * \li Action: Moves the cursor to the next beginning of a word "on the left",
931 adding *logically* traversed text to the selection.
932 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
933 * \li Syntax: word-left-select
934 * \li Origin: dov, 28 Oct 2007
937 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
939 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
940 * \li Action: Moves the cursor to the next beginning of a word "on the right".
941 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
942 "right" key is pressed. Generally, it moves the cursor to the
943 next beginning of a word on the right. However, in Bidi text
944 this become slightly more complicated, and there are different
945 modes of cursor movement. In "visual mode", this moves right,
946 plain and simple. In "logical mode", movement is logically
947 forward in LTR paragraphs, and logically backwards in RTL
949 * \li Syntax: word-right
950 * \li Origin: dov, 28 Oct 2007
953 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
955 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
956 * \li Action: Moves the cursor to the next beginning of a word "on the right",
957 adding *logically* traversed text to the selection.
958 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
959 * \li Syntax: word-right-select
960 * \li Origin: dov, 28 Oct 2007
963 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
965 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
966 * \li Action: Puts the word where the cursor stands into the selection.
967 * \li Syntax: word-select
968 * \li Origin: Andre, 11 Sep 2002
971 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
973 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
974 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
975 or the letter on the cursor position.
976 * \li Syntax: word-capitalize
979 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
981 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
982 * \li Action: Change the words in the selection or from the cursor position
983 to the end of word to the upper case.
984 * \li Syntax: word-upcase
987 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
989 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
990 * \li Action: Change the words in the selection or from the cursor position
991 to the end of word to the lower case.
992 * \li Syntax: word-lowcase
995 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
997 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
998 * \li Action: Add the word under the cursor to the respective
999 * spell checker dictionary.
1000 * \li Syntax: spelling-add [<STRING>] [<LANG>]
1001 * \li Params: <WORD>: word to add
1002 <LANG>: language name (see file languages)
1003 * \li Origin: JSpitzm, 18 Jan 2010
1006 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1008 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1009 * \li Action: Let the spell checker ignore the word under the cursor
1010 * in the current session for the given language.
1011 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1012 * \li Params: <WORD>: word to ignore
1013 <LANG>: language name (see file languages)
1014 * \li Origin: JSpitzm, 18 Jan 2010
1017 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1019 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1020 * \li Action: Remove the word under the cursor from the respective
1021 * spell checker dictionary.
1022 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1023 * \li Params: <WORD>: word to remove
1024 <LANG>: language name (see file languages)
1025 * \li Origin: SWitt, 28 July 2010
1028 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1030 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1031 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1032 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1033 * \li Params: <STRING>: word to look up
1034 <LANG>: language (see file languages)
1035 * \li Origin: Levon, 20 Jul 2001
1038 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1040 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1041 * \li Action: Move the cursor to the beginning of the document.
1042 * \li Syntax: buffer-begin
1045 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1047 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1048 * \li Action: Move the cursor to the beginning of the document adding the
1049 traversed text to the selection.
1050 * \li Syntax: buffer-begin-select
1053 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1055 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1056 * \li Action: Move the cursor to the end of the document.
1057 * \li Syntax: buffer-end
1060 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1062 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1063 * \li Action: Move the cursor to the end of the document adding the
1064 traversed text to the selection.
1065 * \li Syntax: buffer-end-select
1068 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1071 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1072 * \li Action: Move the cursor to the beginning of the current inset
1073 if it is not already there, or at the beginning of the
1074 enclosing inset otherwise
1075 * \li Syntax: inset-begin
1076 * \li Origin: lasgouttes, 16 Mar 2009
1079 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1081 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1082 * \li Action: Move the cursor to the beginning of the current inset
1083 if it is not already there, or at the beginning of the
1084 enclosing inset otherwise (adding the
1085 traversed text to the selection).
1086 * \li Syntax: inset-begin-select
1087 * \li Origin: lasgouttes, 16 Mar 2009
1090 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1092 * \var lyx::FuncCode lyx::LFUN_INSET_END
1093 * \li Action: Move the cursor to the end of the current inset
1094 if it is not already there, or at the end of the
1095 enclosing inset otherwise
1096 * \li Syntax: inset-end
1097 * \li Origin: lasgouttes, 16 Mar 2009
1100 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1102 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1103 * \li Action: Move the cursor to the end of the current inset
1104 if it is not already there, or at the end of the
1105 enclosing inset otherwise (adding the
1106 traversed text to the selection).
1107 * \li Syntax: inset-end-select
1108 * \li Origin: lasgouttes, 16 Mar 2009
1111 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1114 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1115 * \li Action: Selects all contents of an inset.
1116 * \li Syntax: inset-select-all
1117 * \li Origin: vfr, 22 Aug 2009
1120 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1123 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1124 * \li Action: Selects the whole section.
1125 * \li Notion: The cursor should be in a section heading
1126 before calling this lfun.
1127 * \li Syntax: section-select
1128 * \li Origin: vfr, 05 May 2009
1131 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1134 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1135 * \li Action: Move the cursor to the begining of the (screen) line.
1136 * \li Syntax: line-begin
1139 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1141 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1142 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1143 traversed text to the selection.
1144 * \li Syntax: line-begin-select
1147 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1149 * \var lyx::FuncCode lyx::LFUN_LINE_END
1150 * \li Action: Move the cursor to the end of the (screen) line.
1151 * \li Syntax: line-end
1154 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1156 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1157 * \li Action: Move the cursor to the end of the (screen) line adding the
1158 traversed text to the selection.
1159 * \li Syntax: line-end-select
1162 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1164 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1165 * \li Action: Deletes the letters to the end of the (screen) line or
1166 deletes the selection.
1167 * \li Syntax: line-delete-forward
1170 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1172 * \var lyx::FuncCode lyx::LFUN_COPY
1173 * \li Action: Copies to the clipboard the last edit.
1177 { LFUN_COPY, "copy", ReadOnly, Edit },
1179 * \var lyx::FuncCode lyx::LFUN_CUT
1180 * \li Action: Cuts to the clipboard.
1184 { LFUN_CUT, "cut", Noop, Edit },
1186 * \var lyx::FuncCode lyx::LFUN_PASTE
1187 * \li Action: Pastes material (text or picture) from the active clipboard.
1188 * \li Syntax: paste [<TYPE>|<NUM>]
1189 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1190 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1193 { LFUN_PASTE, "paste", Noop, Edit },
1195 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1196 * \li Action: Pastes text from the active clipboard.
1197 * \li Syntax: clipboard-paste [<ARG>]
1198 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1199 * \li Origin: baum, 10 Jul 2006
1202 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1204 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1205 * \li Action: Pastes the currently text selected text.
1206 * \li Notion: Primary selection mechanism is linux-only thing.
1207 * \li Syntax: primary-selection-paste [<ARG>]
1208 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1211 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1213 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1214 * \li Action: Pastes the text in permanent selection.
1215 * \li Syntax: selection-paste
1218 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1220 * \var lyx::FuncCode lyx::LFUN_UNDO
1221 * \li Action: Undoes the last edit.
1225 { LFUN_UNDO, "undo", ReadOnly, Edit },
1227 * \var lyx::FuncCode lyx::LFUN_REDO
1228 * \li Action: Redoes the last thing undone.
1232 { LFUN_REDO, "redo", ReadOnly, Edit },
1234 * \var lyx::FuncCode lyx::LFUN_REPEAT
1235 * \li Action: Repeat the given command.
1236 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1237 * \li Origin: Andre, 27 Oct 2003
1240 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1242 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1243 * \li Action: Transposes the character at the cursor with the one before it.
1244 * \li Syntax: chars-transpose
1245 * \li Origin: Lgb, 25 Apr 2001
1248 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1251 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1252 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1254 * \li Syntax: depth-decrement
1257 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1259 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1260 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1262 * \li Syntax: depth-increment
1265 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1268 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1269 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1270 * \li Syntax: font-bold
1273 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1276 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1277 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1278 * \li Syntax: font-boldsymbol
1281 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1283 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1284 * \li Action: Toggles the typewriter family font (selection-wise).
1285 * \li Syntax: font-typewriter
1288 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1290 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1291 * \li Action: Toggles underline in the font (selection-wise).
1292 * \li Syntax: font-underline
1295 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1297 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1298 * \li Action: Toggles double underline in the font (selection-wise).
1299 * \li Syntax: font-underunderline
1300 * \li Origin: sanda, 5 May 2009
1303 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1305 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1306 * \li Action: Toggles wavy underline in the font (selection-wise).
1307 * \li Syntax: font-underwave
1308 * \li Origin: sanda, 5 May 2009
1311 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1313 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1314 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1315 * \li Syntax: font-strikeout
1316 * \li Origin: sanda, 3 May 2009
1319 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1321 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1322 * \li Action: Toggles the emphasis font style (selection-wise).
1323 * \li Syntax: font-emph
1326 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1328 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1329 * \li Action: Toggles Noun text style font (selection-wise).
1330 * \li Syntax: font-noun
1333 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1335 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1336 * \li Action: Toggles Roman family font (selection-wise).
1337 * \li Syntax: font-roman
1340 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1342 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1343 * \li Action: Toggles Sans Serif family font (selection-wise).
1344 * \li Syntax: font-sans
1347 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1349 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1350 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1351 * \li Syntax: font-frak
1352 * \li Origin: vermeer, 10 Jan 2002
1355 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1357 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1358 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1359 * \li Syntax: font-ital
1360 * \li Origin: vermeer, 10 Jan 2002
1363 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1365 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1366 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1367 * \li Syntax: font-default
1370 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1372 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1373 * \li Action: Sets font size according to lyx format string.
1374 * \li Syntax: font-size <SIZE>
1375 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1376 largest|huge|giant|increase|decrease|default
1379 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1381 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1382 * \li Action: Toggle user-defined (=last-time used) text style.
1383 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1384 automatically trigerred when using Text Style dialog.
1385 * \li Syntax: textstyle-apply
1386 * \li Origin: leeming, 12 Mar 2003
1389 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1391 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1392 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1393 * \li Syntax: textstyle-update <FONT_INFO>
1394 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1395 size, emph, noun, underbar, number, color, language,
1397 Use lyx -dbg action for exact syntax of text-style
1399 * \li Origin: leeming, 12 Mar 2003
1402 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1404 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1405 * \li Action: Update fonts and its metrics.
1406 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1407 * \li Syntax: screen-font-update
1408 * \li Origin: ARRae, 13 Aug 2000
1411 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1413 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1414 * \li Action: Returns the info about the current font.
1415 * \li Syntax: font-state
1418 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1421 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1422 * \li Action: Inserts citation from loaded citation database.
1423 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1424 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1425 <TEXT_BEFORE>: text which should appear before citation.
1426 * \li Origin: AAS, 97-02-23
1429 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1431 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1432 * \li Action: Adds database, which will be used for bibtex citations.
1433 * \li Notion: Databases are added to the first BibTeX inset
1434 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1435 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1436 * \li Origin: Ale, 30 May 1997
1439 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1441 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1442 * \li Action: Adds database, which will be used for bibtex citations.
1443 * \li Notion: Databases are deleted from the first BibTeX inset
1444 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1445 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1446 * \li Origin: Ale, 30 May 1997
1449 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1452 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1453 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1454 * \li Syntax: layout <LAYOUT>
1455 * \li Params: <LAYOUT>: the layout to use
1458 { LFUN_LAYOUT, "layout", Noop, Layout },
1460 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1461 * \li Action: Launches the paragraph settings dialog.
1462 * \li Syntax: layout-paragraph
1465 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1467 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1468 * \li Action: Launches the tabular settings dialog.
1469 * \li Syntax: layout-tabular
1470 * \li Origin: Jug, 31 Jul 2000
1473 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1475 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1476 * \li Action: Displays list of layout choices.
1477 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1478 dropbox allowing for choice of layout.
1479 * \li Syntax: drop-layouts-choice
1482 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1484 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1485 * \li Action: Clears the module list.
1486 * \li Notion: Clears the list of included modules for the current buffer.
1487 * \li Syntax: layout-modules-clear
1488 * \li Origin: rgh, 25 August 2007
1491 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1493 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1494 * \li Action: Adds a module.
1495 * \li Notion: Adds a module to the list of included modules for the current buffer.
1496 * \li Syntax: layout-module-add <MODULE>
1497 * \li Params: <MODULE>: the module to be added
1498 * \li Origin: rgh, 25 August 2007
1501 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1503 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1504 * \li Action: Reloads layout information.
1505 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1506 recognizing any changes that have been made to layout files on the fly.
1507 This is intended to be used only by layout developers and should not be
1508 used when one is trying to do actual work.
1509 * \li Syntax: layout-reload
1510 * \li Origin: rgh, 3 September 2007
1513 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1515 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1516 * \li Action: Sets the text class for the current buffer.
1517 * \li Syntax: textclass-apply <TEXTCLASS>
1518 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1519 the filename, minus the ".layout" extension.
1522 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1524 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1525 * \li Action: Loads information for a textclass from disk.
1526 * \li Syntax: textclass-load <TEXTCLASS>
1527 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1528 the filename, minus the ".layout" extension.
1531 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1534 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1535 * \li Action: Disable selecting of text-region.
1536 * \li Syntax: mark-off
1539 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1541 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1542 * \li Action: Enable selecting of text-region.
1543 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1544 * \li Syntax: mark-on
1547 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1549 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1550 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1551 * \li Syntax: mark-toggle
1552 * \li Origin: Andre, May 5 2006
1555 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1558 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1559 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1560 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1561 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1562 either a LaTeX name or a valid character.
1563 ( is the default letter.
1564 * \li Sample: math-delim { rangle
1565 * \li Origin: Alejandro, 18 Jun 1996
1568 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1570 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1571 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1572 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1573 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1574 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1575 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1576 * \li Origin: Enrico & Georg, 7 May 2006
1579 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1581 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1582 * \li Action: Creates a new displayed equation in text mode.
1583 Toggles inlined/display formula in math mode.
1584 * \li Syntax: math-display [<ARG>]
1585 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1586 new equation from the text mode.
1587 * \li Origin: Alejandro, 18 Jun 1996
1590 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1592 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1593 * \li Action: Inserts math objects and symbols.
1594 * \li Syntax: math-insert <ARG>
1595 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1596 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1597 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1598 replaced by the current selection (only works if the selection
1599 is in mathed). As an example, if "abc" is selected in mathed,
1600 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1601 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1602 If nothing is selected (or the selection is not in mathed),
1603 math-insert works as expected.
1606 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1608 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1609 * \li Action: Enters subscript expression in math expression.
1610 * \li Syntax: math-subscript
1611 * \li Origin: vermeer, 12 Dec 2001
1614 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1616 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1617 * \li Action: Enters subscript expression in math expression.
1618 * \li Syntax: math-superscript
1619 * \li Origin: vermeer, 12 Dec 2001
1622 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1624 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1625 * \li Action: Toggles the position of the limits from above/below to the right
1626 side an vice versa in integral symbol, a limit, a summation, etc.
1627 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1629 * \li Syntax: math-limits [<STATE>]
1630 * \li Params: <STATE>: limits|nolimits
1633 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1635 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1636 * \li Action: Inserts a math macro definition at the cursor position in the text.
1637 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1638 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1639 <NARGS>: The number of parameters of the macro. Default is 0.
1640 "def": Has no effect anymore, just for compatibility with former LyX versions.
1641 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1644 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1646 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1647 * \li Action: Mutates the type of math inset to the newly selected one.
1648 * \li Syntax: math-mutate <TYPE>
1649 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1650 multline|gather|flalign
1651 * \li Origin: Andre, 23 May 2001
1654 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1656 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1657 * \li Action: Inserts space into math expression.
1658 * \li Notion: Use spacebar after entering this space to change type of space.
1659 * \li Syntax: math-space [<TYPE>] [<LEN>]
1660 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1661 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1662 custom space: hspace \n
1663 "," used by default.\n
1664 Note that ! is equivalent to negthinspace, , = thinspace,
1665 : = medspace, and ; = thickspace.\n
1666 <LEN>: length for custom spaces (hspace)
1667 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1670 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1672 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1673 * \li Action: Inserts a matrix.
1674 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1675 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1676 (b, c or t) (i.e. 1 char) and the horizontal alignments
1677 (l, c or r) (i.e. <COL> chars).
1678 * \li Sample: math-matrix 3 3 bccc
1681 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1683 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1684 * \li Action: Inserts a matrix.
1685 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1686 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1687 that should be created.
1688 * \li Sample: math-ams-matrix 3 3 bmatrix
1691 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1693 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1694 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1695 cursor position), in math mode enters text mode inside math expression.
1696 * \li Notion: If there is some selected text, it puts the text inside created math box.
1697 * \li Syntax: math-mode [on|<ARG>]
1698 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1699 "on": allow only entering of math mode from text mode.
1700 * \li Origin: Alejandro, 4 Jun 1996
1703 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1705 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1706 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1707 cursor position). Used by the advanced search dialog.
1708 * \li Notion: If there is any selected text, then it is moved inside the created
1710 * \li Syntax: regexp-mode [<ARG>]
1711 * \li Params: <ARG>: eventual argument (regular expression).
1712 * \li Origin: Tommaso, 4 Oct 2008
1715 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1717 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1718 * \li Action: Toggles numbering of the current formula line.
1719 * \li Notion: Must be in display formula mode.
1720 * \li Syntax: math-number-line-toggle
1721 * \li Origin: Alejandro, 18 Jun 1996
1724 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1726 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1727 * \li Action: Toggles numbering/labeling of the current formula.
1728 * \li Notion: Must be in display formula mode.
1729 * \li Syntax: math-number-toggle
1730 * \li Origin: Alejandro, 4 Jun 1996
1733 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1735 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1736 * \li Action: Calls external program and passes the current expression/equation
1737 as an argument for the calculation in the format appropriate to the
1739 * \li Notion: Selection can be used to determine the input for the external program.
1740 * \li Syntax: math-extern <LANG> [<COMMAND>]
1741 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1742 where "script" stands fot the external script (normalized
1743 expression will be passed)
1744 * \li Origin: Andre, 24 Apr 2001
1745 * \li Sample: math-extern maple simplify
1748 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1750 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1751 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1752 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1753 * \li Syntax: math-size <STYLE>
1754 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1755 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1758 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1760 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1761 * \li Action: Changes the text style used in math.
1762 * \li Syntax: math-font-style <STYLE>
1763 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf
1764 |textnormal|textrm|textsf|texttt|textbf|textmd|textit
1765 |textsc|textsl|textup
1766 * \li Origin: vfr, 9 jan 2009
1769 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1771 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1772 * \li Action: Unfold a Math Macro.
1773 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1775 * \li Syntax: math-macro-unfold
1776 * \li Origin: sts, 06 January 2008
1779 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1781 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1782 * \li Action: Fold a Math Macro.
1783 * \li Notion: Fold the Math Macro the cursor is in if it was
1784 unfolded, i.e. displayed as \foo before.
1785 * \li Syntax: math-macro-fold
1786 * \li Origin: sts, 06 January 2008
1789 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1791 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1792 * \li Action: Add a parameter.
1793 * \li Notion: Add a parameter to a Math Macro.
1794 * \li Params: <NUM>: The number of the parameter behind which the new one
1795 will be added (1 for the first, i.e. use 0 for add a
1796 parameter at the left), defaults to the last one.
1797 * \li Syntax: math-macro-add-param <NUM>
1798 * \li Origin: sts, 06 January 2008
1801 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1803 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1804 * \li Action: Remove the last parameter.
1805 * \li Notion: Remove the last parameter of a Math Macro and
1806 remove its value in all instances of the macro
1808 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1809 the first), defaults to the last one.
1810 * \li Syntax: math-macro-remove-param <NUM>
1811 * \li Origin: sts, 06 January 2008
1814 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1816 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1817 * \li Action: Append a greedy parameter.
1818 * \li Notion: Append a greedy parameter to a Math Macro which
1819 eats the following mathed cell in every instance of
1820 the macro in the buffer.
1821 * \li Syntax: math-macro-append-greedy-param
1822 * \li Origin: sts, 06 January 2008
1825 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1827 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1828 * \li Action: Remove a greedy parameter.
1829 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1830 out the values of it in every instance of the macro
1831 in the buffer. If it is an optional parameter the [valud]
1833 * \li Syntax: math-macro-remove-greedy-param
1834 * \li Origin: sts, 06 January 2008
1837 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1839 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1840 * \li Action: Make a parameter optional.
1841 * \li Notion: Turn the first non-optional parameter of a Math Macro
1842 into an optional parameter with a default value.
1843 * \li Syntax: math-macro-make-optional
1844 * \li Origin: sts, 06 January 2008
1847 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1849 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1850 * \li Action: Make a parameter non-optional.
1851 * \li Notion: Turn the last optional parameter of a Math Macro
1852 into a non-optional parameter. The default value is
1853 remembered to be reused later if the user changes his mind.
1854 * \li Syntax: math-macro-make-nonoptional
1855 * \li Origin: sts, 06 January 2008
1858 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1860 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1861 * \li Action: Add an optional parameter.
1862 * \li Notion: Insert an optional parameter just behind the
1863 already existing optional parameters.
1864 * \li Syntax: math-macro-add-optional-param
1865 * \li Origin: sts, 06 January 2008
1868 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1870 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1871 * \li Action: Remove the last optional parameter.
1872 * \li Notion: Remove the last optional parameter of a Math Macro and
1873 remove it in all the instances of the macro in the buffer.
1874 * \li Syntax: math-macro-remove-optional-param
1875 * \li Origin: sts, 06 January 2008
1878 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1880 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1881 * \li Action: Add a greedy optional parameter.
1882 * \li Notion: Add a greedy optional parameter which eats the value
1883 from the following cells in mathed which are in the [value]
1885 * \li Syntax: math-macro-add-greedy-optional-param
1886 * \li Origin: sts, 06 January 2008
1889 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1891 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1892 * \li Action: Only active in Math Macro definition.
1893 * \li Notion: Dummy function which is only active in a Math Macro definition.
1894 It's used to toggle the Math Macro toolbar if the cursor moves
1895 into a Math Macro definition.
1896 * \li Syntax: in-mathmacrotemplate
1897 * \li Origin: sts, 06 January 2008
1900 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1903 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1904 * \li Action: Moves the current paragraph downwards in the document.
1905 * \li Syntax: paragraph-move-down
1906 * \li Origin: Edwin, 8 Apr 2006
1909 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1911 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1912 * \li Action: Moves the current paragraph upwards in the document.
1913 * \li Syntax: paragraph-move-up
1914 * \li Origin: Edwin, 8 Apr 2006
1917 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1920 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1921 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1922 in upward direction.
1923 * \li Syntax: paragraph-up
1924 * \li Origin: Asger, 1 Oct 1996
1927 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1929 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1930 * \li Action: Move the cursor and select the text to the next paragraph (or
1931 begining of the current one) in upward direction.
1932 * \li Syntax: paragraph-up-select
1933 * \li Origin: Asger, 1 Oct 1996
1936 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1938 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1939 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1940 in downward direction.
1941 * \li Syntax: paragraph-down
1942 * \li Origin: Asger, 1 Oct 1996
1945 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1947 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1948 * \li Action: Move the cursor and select the text to the next paragraph (or
1949 begining of the current one) in downward direction.
1950 * \li Syntax: paragraph-down-select
1951 * \li Origin: Asger, 1 Oct 1996
1954 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1956 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1957 * \li Action: Jump to a paragraph given by its id number and optionally the
1958 desired position within the paragraph.
1959 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1960 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1961 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1962 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1963 <POSITION_IN_PAR>: desired position within the paragraph
1964 * \li Origin: Dekel, 26 Aug 2000
1967 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
1969 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1970 * \li Action: Breaks the current paragraph at the current location.
1971 * \li Notion: Removes the selection.
1972 * \li Syntax: break-paragraph [<LAYOUT>]
1973 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1974 to default layout) when the cursor is at the end of
1978 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1980 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1981 * \li Action: Change paragraph settings.
1982 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1983 This function only modifies, and does not override, existing settings.
1984 Note that the "leftindent" indent setting is deprecated.
1985 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1986 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
1987 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
1988 <ALIGN>: \align block|left|right|center|default\n
1989 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
1990 * \li Origin: rgh, Aug 15 2007
1993 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1995 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1996 * \li Action: Change paragraph settings.
1997 * \li Notion: Overwrite all nonspecified settings to the default ones.
1998 Use paragraph-params lfun if you don't want to overwrite others settings.
1999 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2000 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
2001 * \li Origin: leeming, 30 Mar 2004
2004 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
2006 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
2007 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
2008 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2009 by #LFUN_DIALOG_UPDATE.
2010 * \li Origin: leeming, 13 Mar 2003
2013 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2016 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2017 * \li Action: Move the current group in the upward direction in the
2018 structure of the document.
2019 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2020 the whole substructure of the group.
2021 * \li Syntax: outline-up
2022 * \li Origin: Vermeer, 23 Mar 2006
2025 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2027 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2028 * \li Action: Move the current group in the downward direction in the
2029 structure of the document.
2030 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2031 the whole substructure of the group.
2032 * \li Syntax: outline-down
2033 * \li Origin: Vermeer, 23 Mar 2006
2036 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2038 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2039 * \li Action: Moves the current group in the downward direction in the
2040 hierarchy of the document structure.
2041 * \li Notion: Part -> Chapter -> Section -> etc.
2042 * \li Syntax: outline-in
2043 * \li Origin: Vermeer, 23 Mar 2006
2046 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2048 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2049 * \li Action: Moves the current group in the upward direction in the
2050 hierarchy of the document structure.
2051 * \li Notion: Part <- Chapter <- Section <- etc.
2052 * \li Syntax: outline-out
2053 * \li Origin: Vermeer, 23 Mar 2006
2056 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2059 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2060 * \li Action: Edit the inset at cursor with an external application,
2061 if one is attributed.
2062 * \li Syntax: inset-edit [<INSET_PARAMS>]
2063 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2064 Currently only the filename will be considered.
2065 * \li Origin: JSpitzm, 27 Apr 2006
2068 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2071 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2072 * \li Action: Inserts table into the document.
2073 * \li Notion: See #LFUN_INSET_MODIFY for some more details
2074 about tabular modifications.
2075 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2076 * \li Params: In case no arguments are given show insert dialog.
2077 * \li Origin: Jug, 12 Apr 2000
2080 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2083 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2084 * \li Action: Moves the cursor to the previous cell inside the table.
2085 * \li Syntax: cell-backward
2086 * \li Origin: Jug, 22 May 2000
2089 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
2091 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2092 * \li Action: Moves the cursor to the next cell inside the table.
2093 * \li Syntax: cell-forward
2096 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
2098 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2099 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2100 * \li Syntax: cell-split
2101 * \li Origin: Ale, 15 May 1997
2104 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2107 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2108 * \li Action: Register the document as an file inside version control system (RCS, CVS).
2109 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2110 of cvs/svn/rcs entries in the document's directory. \n
2111 See LyX Additional Features Manual (Version Control Chapter) for additional
2113 * \li Syntax: vc-register
2114 * \li Origin: Lgb, 1 Jul 1997
2117 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2119 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2120 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2121 * \li Notion: In RCS case this also unlocks the file.
2122 * \li Syntax: vc-check-in
2123 * \li Origin: Lgb, 1 Jul 1997
2126 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2128 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2129 * \li Action: Checks-out the document for edit (and locks it for RCS).
2130 * \li Notion: This is implemented only for RCS and SVN, not CVS.
2131 * \li Syntax: vc-check-out
2132 * \li Origin: Lgb, 1 Jul 1997
2135 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2137 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2138 * \li Action: Reverts the document to the last check-in/commit in VCS.
2139 * \li Syntax: vc-revert
2140 * \li Origin: Lgb, 1 Jul 1997
2143 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2145 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2146 * \li Action: Undo last check-in.
2147 * \li Notion: This is currently implemented only for RCS.
2148 * \li Syntax: vc-check-out
2149 * \li Origin: Lgb, 1 Jul 1997
2152 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2154 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2155 * \li Action: Executes external command. This command is intended to support
2156 additional VCS commands.
2157 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2158 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2159 U - dUmmy - no flags \n
2160 D - Doc - need document loaded to proceed \n
2161 I - dIrty - mark document dirty \n
2162 R - Reload - ensure that the document is saved and reload it after command execution \n
2163 M - Message - ask for input string (commit message)\n
2164 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2165 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2166 document(with absolute path)/path/message.
2167 * \li Sample: vc-command DR $$p "svn up"
2168 * \li Origin: sanda, 13 Jan 2009
2171 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2173 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2174 * \li Action: Toggles the locking property of the edited file.
2175 * \li Notion: This is currently implemented only for SVN.
2176 * \li Syntax: vc-locking-toggle
2177 * \li Origin: sanda, 25 Jun 2009
2180 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2182 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2183 * \li Action: Update the local archive directory in which resides
2184 the current document with the remote repository.
2185 * \li Notion: This is currently implemented only for SVN.
2186 * \li Syntax: vc-repo-update
2187 * \li Origin: sanda, 16 Oct 2009
2190 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2192 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2193 * \li Action: Compares two revisions of the same file under version control.
2194 * \li Notion: This is currently implemented only for SVN and RCS.
2195 * \li Syntax: vc-compare <REV1> [<REV2>]
2196 * \li Params: Revision number either points directly to commit in history
2197 or if negative number -x it points to last commit - x.\n
2198 In RCS we subtract only in the last number of revision specification.
2199 Special case "0" is reserved for the last committed revision.\n
2200 <REV1>: Older file.\n
2201 <REV2>: Newer file. Used only if REV1 > 0.
2202 * \li Sample: Compare current document against last commit\n
2204 * \li Sample: Compare current document against current revision - 5 commits\n
2206 * \li Sample: Compare revisions 120 and 155\n
2208 * \li Origin: sanda, 12 Feb 2010
2211 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2214 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2215 * \li Action: Toggles change tracking to on/off.
2216 * \li Syntax: changes-track
2217 * \li Origin: levon, 1 Oct 2002
2220 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2222 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2223 * \li Action: Toggles showing of change tracking in typesetted output.
2224 * \li Syntax: changes-output
2225 * \li Origin: jspitzm, 21 Jan 2005
2228 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2230 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2231 * \li Action: Moves the cursor to the position of the next change
2232 of the change tracking records.
2233 * \li Syntax: change-next
2234 * \li Origin: schmitt, 4 Oct 2006
2237 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2239 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2240 * \li Action: Moves the cursor to the position of the previous change
2241 of the change tracking records.
2242 * \li Syntax: change-previous
2243 * \li Origin: vfr, 4 Apr 2009
2246 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2248 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2249 * \li Action: Open change tracking dialog for merging and moves the cursor
2250 to the position of the next change.
2251 * \li Syntax: changes-merge
2252 * \li Origin: Levon, 16 Oct 2002
2255 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2257 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2258 * \li Action: Accepts tracked change inside the selection.
2259 * \li Syntax: change-accept
2260 * \li Origin: Levon, 16 Oct 2002
2263 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2265 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2266 * \li Action: Rejects tracked change inside the selection.
2267 * \li Syntax: change-accept
2268 * \li Origin: Levon, 16 Oct 2002
2271 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2273 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2274 * \li Action: Accepts all tracked changes in the document.
2275 * \li Syntax: all-changes-accept
2276 * \li Origin: Levon, 16 Oct 2002
2279 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2281 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2282 * \li Action: Rejects all tracked changes in the document.
2283 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2284 * \li Syntax: all-changes-reject
2285 * \li Origin: Levon, 16 Oct 2002
2288 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2291 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2292 * \li Action: Apply data for an inset.
2293 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2294 be applied. This is either changed to #LFUN_INSET_MODIFY or
2295 #LFUN_INSET_INSERT depending on the context where it is called.
2296 * \li Syntax: inset-apply <ARGS>
2297 * \li Params: See #LFUN_INSET_INSERT .
2300 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2302 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2303 * \li Action: Dissolve the current inset into text.
2304 * \li Syntax: inset-dissolve [<INSET>]
2305 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2306 is dissolved. For example "dissolve" entry in the charstyles
2307 sub-menu should only dissolve the charstyle inset, even if the
2308 cursor is inside several nested insets of different type.\n
2309 For values see #lyx::InsetLayout::lyxtype_ .
2310 * \li Origin: JSpitz, 7 Aug 2006
2313 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2315 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2316 * \li Action: Insert new inset (type given by the parameters).
2317 * \li Syntax: inset-insert <INSET> <ARGS>
2318 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular
2319 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2320 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2321 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2322 where <label name> is the name of the referenced label and
2323 <Format> is one of the following: \n
2324 ref -- <reference> \n
2325 eqref -- (<reference>) \n
2326 pageref -- <page> \n
2327 vpageref -- on <page> \n
2328 vref -- <reference> on <page> \n
2329 prettyref -- Formatted reference
2332 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2334 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2335 * \li Action: Modify some properties of an inset.
2336 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2337 floats, graphics, include, index, info, label,
2338 listings, newline, newpage, nomencl, note, phantom,
2339 ref, space, tabular, vspace, wrap insets.
2340 * \li Syntax: inset-modify <INSET> <ARGS>
2341 * \li Syntax: inset-modify changetype <TYPE>
2342 * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
2343 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2344 In case that <INSET> is "tabular" various math-environment features
2345 are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
2346 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2347 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2348 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2349 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2350 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2351 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2352 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
2353 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2354 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2355 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2356 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2357 set-special-column|set-special-multicolumn|set-special-multirow|
2358 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2359 set-interline-space|set-border-lines|tabular-valign-top|
2360 tabular-valign-middle|tabular-valign-bottom \n
2361 <ARG>: additional argument for some commands, use debug mode to explore its values.
2362 * \li Sample: inset-modify note Note Comment
2363 * \li Sample: inset-modify changetype Ovalbox
2366 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2368 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2369 * \li Action: Updates the values inside the dialog from the inset.
2370 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2371 by #LFUN_DIALOG_UPDATE
2372 * \li Params: <DIALOG-NAME>
2373 * \li Origin: leeming, 25 Feb 2003
2376 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2378 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2379 * \li Action: Open the inset's properties dialog.
2380 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2381 float, graphics, href, include, index, index_print, label, listings,
2382 note, phantom, ref, space, tabular, vspace, wrap insets.
2383 * \li Syntax: inset-settings <INSET>
2384 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2385 graphics|href|include|index|index_print|label|listings|
2386 note|phantom|ref|space|tabular|vspace|wrap>.
2389 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2391 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2392 * \li Action: Toggles the collapsable inset at cursor position,
2393 or the inset we are currently in.
2394 * \li Syntax: inset-toggle [<ARG>]
2395 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2396 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2397 assign synchronize the branch-inset with activation status of the branch.
2398 Used for global toggling when changed activation.
2399 * \li Origin: lasgouttes, 19 Jul 2001
2402 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2404 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2405 * \li Action: Apply the given commands on insets of a given name.
2406 * \li Notion: WARNING: use at your own risks; this function gives
2407 you too many ways of shooting yourself in the foot.
2408 A typical example is
2409 inset-forall Note note-insert
2410 which starts an infinite loop. This is mitigated by the fact
2411 that the number of actions is arbitrarily limited to 10000.
2412 Note also that inset-forall does not update metrics between
2413 iterations, which can lead to bugs. This has to be eventually
2415 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2416 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2417 The name is used like for InsetLayout in layout files: "Note"
2418 matches all note insets, while "Note:Note" only matches LyX
2420 * \li Sample: Remove all index insets: \n
2421 inset-forall Index delete-char-forward \n
2422 Close all Notes (also works for a particular branch, for example): \n
2423 inset-forall Note inset-toggle close \n
2424 Transform all yellow notes to comments \n
2425 inset-forall Note:Note inset-modify note Note Comment \n
2426 Try to put LyX in an infinite loop if there is at least a Note: \n
2427 inset-forall Note char-backward
2428 * \li Origin: lasgouttes, 27 Nov 2009
2431 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2434 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2435 * \li Action: Reloads the image if necessary.
2436 * \li Syntax: graphics-reload
2437 * \li Origin: vfr, 10 Aug 2009
2440 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2442 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2443 * \li Action: Set the group for the graphics inset on the cursor position.
2444 * \li Syntax: set-graphics-group [<GROUP>]
2445 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2446 the graphics inset is removed from the current group.
2447 * \li Origin: sanda, 6 May 2008
2450 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2453 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2454 * \li Action: Moves the cursor out of the current slice, going forward.
2455 * \li Notion: Cursor movement within an inset may be different than cursor
2456 movement in the surrounding text. This action should be called
2457 automatically by the cursor movement within the inset, when
2458 movement within the inset has ceased (reached the end of the
2459 last paragraph, for example), in order to move correctly
2460 back into the surrounding text.
2463 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2465 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2466 * \li Action: Moves the cursor out of the current slice, going backwards.
2467 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2470 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2472 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2473 * \li Action: Moves the cursor out of the current slice, going right.
2474 * \li Notion: See also #LFUN_FINISHED_FORWARD
2477 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2479 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2480 * \li Action: Moves the cursor out of the current slice, going left.
2481 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2484 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2487 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2488 * \li Action: Set language from the current cursor position.
2489 * \li Syntax: language <LANG>
2490 * \li Params: <LANG>: Requested language. Look in lib/languages for
2492 * \li Origin: Dekel, 2 Mar 2000
2495 { LFUN_LANGUAGE, "language", Noop, Edit },
2498 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2499 * \li Action: Goto a label.
2500 * \li Syntax: label-goto [<LABEL>]
2501 * \li Params: <LABEL>: Requested label. If no label is given and reference
2502 is on cursor position, Bookmark 0 is saved and
2503 cursor moves to the position of referenced label.
2504 * \li Origin: Ale, 6 Aug 1997
2507 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2509 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2510 * \li Action: Inserts label to text or displayed formula.
2511 * \li Syntax: label-insert [<LABEL>]
2512 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2513 name will be opened.
2516 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2518 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2519 * \li Action: Go to the next label or cross-reference.
2520 * \li Syntax: reference-next
2521 * \li Origin: Dekel, 14 Jan 2001
2524 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2527 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2528 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2529 if necessary. Note that bookmarsk are saved per-session, not
2531 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2532 1. to the paragraph you are currently editing \n
2533 2. to the paragraph from where you are jumping to the last-edited
2534 position (jump-back feature) \n
2535 3. when jumping from crossreference to the requested label by
2537 * \li Syntax: bookmark-goto <NUMBER>
2538 * \li Params: <NUMBER>: the number of the bookmark to restore.
2539 * \li Origin: Dekel, 27 January 2001
2542 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2544 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2545 * \li Action: Save a bookmark.
2546 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2547 must be between 1 and 9, inclusive. Note that bookmarks are
2548 saved per-session, not per file.
2549 * \li Syntax: bookmark-save <NUMBER>
2550 * \li Params: <NUMBER>: the number of the bookmark to save.
2551 * \li Origin: Dekel, 27 January 2001
2554 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2556 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2557 * \li Action: Clears the list of saved bookmarks.
2558 * \li Syntax: bookmark-clear
2559 * \li Origin: bpeng, 31 October 2006
2562 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2565 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2566 * \li Action: Open the given help file according to the language setting.
2567 * \li Syntax: help-open <FILE>[.lyx]
2568 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2569 * \li Origin: Jug, 27 Jun 1999
2572 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2574 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2575 * \li Action: Terminates the current LyX instance.
2576 * \li Notion: Terminates the current LyX instance, asking whether to save
2577 modified documents, etc.
2578 * \li Syntax: lyx-quit
2581 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2583 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2584 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2585 * \li Notion: Skipping "auto" when allowauto is false.
2586 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2587 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2588 minibuffer|review|view/update|math_panels|vcs|
2589 view-others|update-others
2590 * \li Origin: Edwin, 21 May 2007
2593 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2595 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2596 * \li Action: Opens the menu given by its name.
2597 * \li Syntax: menu-open <NAME>
2598 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2601 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2603 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2604 * \li Action: Various UI visibility-toggling actions.
2605 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2606 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2607 menubar : Toggle visibility of the menubar.\n
2608 scrollbar : Toggle visibility of the scrollbar.\n
2609 frame : Toggle visibility of the frames around editing window.\n
2610 fullscreen : Toggle fullscreen mode. This also covers calling the
2611 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2612 custom tweaks of the toolbars should be used.
2613 * \li Origin: sanda, 9 Feb 2007
2616 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2619 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2620 * \li Action: Creates new empty LyX window.
2621 * \li Notion: Already opened documents from the previous window can be found under View menu.
2622 * \li Syntax: window-new [<GEOMETRY>]
2623 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2624 accepted only on Windows platform.
2625 * \li Origin: Abdel, 21 Oct 2006
2628 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2630 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2631 * \li Action: Closes the current LyX window.
2632 * \li Syntax: window-close
2633 * \li Origin: Abdel, 23 Oct 2006
2636 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2639 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2640 * \li Action: Creates another split view of current buffer.
2641 * \li Notion: All split views act in the same way indpendently.
2642 * \li Syntax: split-view <vertical|horizontal>
2643 * \li Params: horizontal : The work areas are laid out side by side.\n
2644 vertical : The work areas laid out vertically.
2645 * \li Origin: Abdel, 20 Feb 2008
2648 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2651 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2652 * \li Action: Close the current tab group.
2653 * \li Notion: This only closes the work areas, not the buffer themselves.
2654 The still opened buffers can be visualized in another tab group.
2655 * \li Syntax: close-tab-group
2656 * \li Origin: Abdel, 21 Feb 2008
2659 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2661 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2662 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2663 * \li Syntax: dialog-show <NAME> [<DATA>]
2664 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2665 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2666 graphics|href|include|index|index_print|info|label|listings|log|mathdelimiter|\n
2667 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2668 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2669 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2670 <SPECIAL>: latexlog|vclog \n
2671 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2673 * \li Origin: leeming, 17 Jun 2003
2676 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2678 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2679 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2680 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2681 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2682 * \li Params: See #LFUN_DIALOG_SHOW .
2683 * \li Origin: leeming, 25 Feb 2003
2686 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2688 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2689 * \li Action: Updates the dialog values from the inset/paragraph/document.
2690 * \li Syntax: dialog-update <NAME>
2691 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2693 * \li Origin: leeming, 25 Feb 2003
2696 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2698 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2699 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2700 * \li Syntax: dialog-hide <NAME>
2701 * \li Params: See #LFUN_DIALOG_SHOW .
2702 * \li Origin: leeming, 25 Feb 2003
2705 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2707 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2708 * \li Action: Toggles dialog between showed/hidden state.
2709 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2710 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2711 * \li Params: See #LFUN_DIALOG_SHOW .
2712 * \li Origin: JSpitzm, 30 Apr 2007
2715 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2717 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2718 * \li Action: Closes opened connection to opened inset.
2719 * \li Notion: Connection is used for apply functions.
2720 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2721 * \li Origin: leeming, 25 Feb 2003
2724 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2727 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2728 * \li Action: This function is called when mouse button is pressed (inside workarea).
2729 Action depends on the context.
2730 * \li Notion: This is internal LFUN, not to be used by users.
2731 * \li Origin: Andre, 9 Aug 2002
2734 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2736 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2737 * \li Action: This function is called when double click on mouse button is
2738 pressed (inside workarea). Action depends on the context.
2739 * \li Notion: This is internal LFUN, not to be used by users.
2740 * \li Origin: Andre, 9 Aug 2002
2743 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2745 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2746 * \li Action: This function is called when triple click on mouse button is
2747 pressed (inside workarea). Action depends on the context.
2748 * \li Notion: This is internal LFUN, not to be used by users.
2749 * \li Origin: Andre, 9 Aug 2002
2752 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2754 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2755 * \li Action: This function is called when mouse cursor is moving over the text.
2756 Action depends on the context.
2757 * \li Notion: This is internal LFUN, not to be used by users.
2758 * \li Origin: Andre, 9 Aug 2002
2761 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2763 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2764 * \li Action: This function is called when mouse button is released (inside workarea).
2765 Action depends on the context.
2766 * \li Notion: This is internal LFUN, not to be used by users.
2767 * \li Origin: Andre, 9 Aug 2002
2770 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2773 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2774 * \li Action: Turn off the loaded keyboard map.
2775 * \li Syntax: keymap-off
2778 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2780 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2781 * \li Action: Turn on the primary keyboard map.
2782 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2783 keyboard support. They can be still used to maintain uniform keyboard
2784 layout across the various plaforms.\n
2785 The language is to be set in the Preferences dialog.
2786 * \li Syntax: keymap-primary
2789 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2791 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2792 * \li Action: Turn on the secondary keyboard map.
2793 * \li Syntax: keymap-secondary
2796 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2798 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2799 * \li Action: Toggles keyboard maps (first/second/off).
2800 * \li Syntax: keymap-toggle
2801 * \li Origin: leeming, 30 Mar 2004
2804 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2807 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2808 * \li Action: Returns the current layout (that is environment) name
2809 on the cursor position.
2810 * \li Syntax: server-get-layout
2813 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2815 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2816 * \li Action: Returns path and file name of the currently edited document.
2817 * \li Syntax: server-get-filename
2820 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2822 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2823 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2824 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2825 line from LaTeX compilation. Note that before this function can be used
2826 export to LaTeX output must occur (in order to map the row numbers).
2827 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2828 * \li Params: <FILE>: the filename. Environment variables are expanded in the path.
2829 In case this LFUN does not work make sure you are giving correct
2831 If the file is located inside LyX temporary directory it will be
2832 mapped back into the appropriate opened buffer (e.g. for the case
2833 of generated .tex file).
2834 .ext: extensions will be automatically replaced by .lyx.
2835 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2836 * \li Origin: Edmar, 23 Dec 1998
2839 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2841 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
2842 * \li Action: Sets the cursor position in the previewed (e.g. dvi) file based on the row
2843 number in LyX window.
2844 * \li Notion: The external program used for forward search call can be specified in
2845 \forward_search_dvi and \forward_search_pdf RC settings.
2846 By default, the value for pdf is empty, while for dvi it is\n
2847 "xdvi -sourceposition $$n:$$t $$o"\n
2848 The values replaced in the call: $$n for row number, $$t for
2849 exported temporary .tex file, $$o exported output file, either
2850 dvi or pdf, depending on which one exists in the temp dir
2852 * \li Syntax: forward-search
2853 * \li Origin: sanda, 14 Apr 2010
2856 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
2858 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2859 * \li Action: Sends notify message about the last key-sequence to client.
2860 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2861 See also Debug extensions section in Additional features manual.
2862 * \li Syntax: server-notify
2865 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2867 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2868 * \li Action: Sets the cursor position based on the editing area coordinates
2869 (similar as clicking on that point with left mouse button).
2870 * \li Syntax: server-set-xy <X> <Y>
2873 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2875 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2876 * \li Action: Returns the coordinates of cursor position in the editing area.
2877 * \li Syntax: server-get-xy
2880 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2883 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2884 * \li Action: Generates the code (literate programming).
2885 * \li Notion: Latex file with extension \literate_extension is generated.
2886 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2887 \build_error_filter to process the compilation error messages. \n
2888 In case you want to process your literate file with a script, or some other program,
2889 just insert in your lyxrc file an entry with:\n
2890 \build_command "my_script my_arguments" \n
2891 The \build_error_filter differs from the \literate_error_filter only in that the
2892 former will identify error messages from your compiler.
2893 * \li Syntax: build-program
2896 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2899 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2900 * \li Action: Saves the current buffer to a temporary file.
2901 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2902 is called automatically by LyX, to "autosave" the current buffer.
2903 * \li Syntax: buffer-auto-save
2906 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2908 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2909 * \li Action: Loads the given child document.
2910 * \li Notion: The current document is treated as a parent.
2911 * \li Syntax: buffer-child-open <FILE>
2912 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2913 * \li Origin: Ale, 28 May 1997
2916 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2918 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2919 * \li Action: Runs chktex for the current document.
2920 * \li Syntax: buffer-chktex
2921 * \li Origin: Asger, 30 Oct 1997
2924 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2926 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2927 * \li Action: Toggles compression of the current document on/off.
2928 * \li Syntax: buffer-toggle-compression
2929 * \li Origin: bpeng, 27 Apr 2006
2932 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2934 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
2935 * \li Action: Toggles including of resources for forward/reverse search of the given document.
2936 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
2937 is used for DVI. Custom LaTeX macro can be defined in preferences.
2938 * \li Syntax: buffer-toggle-output-sync
2939 * \li Origin: sanda, 25 May 2010
2942 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
2944 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2945 * \li Action: Closes the current buffer.
2946 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2947 if the buffer has been modified.
2948 * \li Syntax: buffer-close
2951 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2953 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2954 * \li Action: Closes all buffers.
2955 * \li Notion: Closes all buffers, asking whether to save it, etc,
2956 if a buffer has been modified.
2957 * \li Syntax: buffer-close-all
2960 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2962 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2963 * \li Action: Exports the current buffer (document) to the given format.
2964 * \li Syntax: buffer-export <FORMAT>
2965 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2966 can find in Tools->Preferences->File formats->Format.
2967 Usual format you will enter is "pdf2" (pdflatex),
2968 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2969 In case of "custom" you will be asked for a format you
2970 want to start from and for the command that you want to
2971 apply to this format. Internally the control is then passed
2972 to #LFUN_BUFFER_EXPORT_CUSTOM.
2973 * \li Origin: Lgb, 29 Jul 1997
2976 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2978 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2979 * \li Action: Exports the current buffer (document) from the given format using
2980 the given command on it.
2981 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2982 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2983 intermediate file).\n
2984 <COMMAND> this command will be launched on the file. Note that you can
2985 use "$$FName" string to qualify the intermediate file.
2986 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2987 * \li Origin: leeming, 27 Mar 2004
2990 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2992 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2993 * \li Action: Prints the current document.
2994 * \li Notion: Many settings can be given via the preferences dialog.
2995 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2996 * \li Params: <TARGET> is either "printer" or "file".\n
2997 <TARGER-NAME> is either "default" or file name or printer name.\n
2998 <COMMAND> command ensuring the printing job.
2999 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
3000 * \li Origin: leeming, 28 Mar 2004
3003 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
3005 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3006 * \li Action: Import a given file as a lyx document.
3007 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3008 defined convertors in preferences. Look into File->Import menu to get
3009 an idea of the currently active import formats.
3010 * \li Syntax: buffer-import <FORMAT> [<FILE>]
3011 * \li Origin: Asger, 24 Jul 1998
3014 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3016 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3017 * \li Action: Creates a new buffer (that is, document).
3018 * \li Notion: Implicit path can be set in Preferences dialog.
3019 * \li Syntax: buffer-new [<FILE>]
3020 * \li Params: <FILE>: filename of created file with absolute path.
3023 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3025 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3026 * \li Action: Creates a new buffer (that is, document) from a template.
3027 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3028 Template will be asked for via Open-dialog.
3029 * \li Syntax: buffer-new-template [<FILE>]
3030 * \li Params: <FILE>: filename of created file with absolute path.
3033 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3035 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3036 * \li Action: Reverts opened document.
3037 * \li Syntax: buffer-reload
3038 * \li Origin: Asger, 2 Feb 1997
3041 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3043 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3044 * \li Action: Display/switch to the given buffer.
3045 * \li Syntax: buffer-switch <BUFFER>
3046 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3047 document which is to be shown.
3050 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3052 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3053 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3054 * \li Notion: This function is not allowed if the file is under version control, since
3055 read-only flag is often used in version control file locking.
3056 * \li Syntax: buffer-toggle-read-only
3057 * \li Origin: Lgb, 27 May 1997
3060 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3062 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3063 * \li Action: Displays current buffer in chosen format.
3064 * \li Notion: Displays the contents of the current buffer in the chosen
3065 format, for example, PDF or DVI. This runs the necessary
3066 converter, calls the defined viewer, and so forth.
3067 * \li Syntax: buffer-view [<FORMAT>]
3068 * \li Params: <FORMAT>: The format to display, where this is one of the
3069 formats defined (in the current GUI) in the
3070 Tools>Preferences>File Formats dialog.
3071 If no format is given, the default format as
3072 specified in the same dialog is used.
3075 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3077 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3078 * \li Action: Exports the current document and put the result into the
3079 temporary directory.
3080 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3081 the output will be rewriten - updated. This is useful in case your viewer
3082 is able to detect such changes (e.g. ghostview for postscript).
3083 * \li Syntax: buffer-update [<FORMAT>]
3084 * \li Params: <FORMAT>: The format to display, where this is one of the
3085 formats defined (in the current GUI) in the
3086 Tools>Preferences>File Formats dialog.
3087 If no format is given, the default format as
3088 specified in the same dialog is used.
3089 * \li Origin: Dekel, 5 Aug 2000
3092 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3095 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3096 * \li Action: Saves the current buffer.
3097 * \li Notion: Saves the current buffer to disk, using the filename that
3098 is already associated with the buffer, asking for one if
3099 none is yet assigned.
3100 * \li Syntax: buffer-write
3103 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3105 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3106 * \li Action: Rename and save current buffer.
3107 * \li Syntax: buffer-write-as <FILENAME>
3108 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3109 is with respect to the original location of the buffer/file.
3112 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3114 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3115 * \li Action: Save all changed documents.
3116 * \li Syntax: buffer-write-all
3117 * \li Origin: rgh, gpothier 6 Aug 2007
3120 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3122 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3123 * \li Action: Switch to the next opened document.
3124 * \li Notion: Note that this does not necessarily mean next in tabbar
3125 (for full list see View menu).
3126 * \li Syntax: buffer-next
3129 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3131 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3132 * \li Action: Switch to the previous opened document.
3133 * \li Syntax: buffer-previous
3136 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3138 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3139 * \li Action: When run from a child document, this updates (exports) document built
3140 from the master buffer, if available.
3141 * \li Syntax: master-buffer-update [<FORMAT>]
3142 * \li Params: <FORMAT>: The format to display, where this is one of the
3143 formats defined (in the current GUI) in the
3144 Tools>Preferences>File Formats dialog.
3145 If no format is given, the default format as
3146 specified in the same dialog is used.
3147 * \li Origin: Tommaso, 20 Sep 2007
3150 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3152 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3153 * \li Action: When run from a child document, this command shows a preview built
3154 from the master buffer, if available.
3155 * \li Syntax: master-buffer-view [<FORMAT>]
3156 * \li Params: <FORMAT>: The format to display, where this is one of the
3157 formats defined (in the current GUI) in the
3158 Tools>Preferences>File Formats dialog.
3159 If no format is given, the default format as
3160 specified in the same dialog is used.
3161 * \li Origin: Tommaso, 20 Sep 2007
3164 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3166 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3167 * \li Action: Set language of the current document.
3168 * \li Syntax: buffer-language <LANG>
3169 * \li Params: <LANG>: language name. See lib/languages for list.
3170 * \li Origin: leeming, 30 Mar 2004
3173 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3175 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3176 * \li Action: Save the current document settings as default.
3177 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3178 * \li Syntax: buffer-save-as-default [<ARGS>]
3179 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3180 you can find in document header of usual .lyx file.
3181 * \li Origin: leeming, 30 Mar 2004
3184 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3186 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3187 * \li Action: Apply the given settings to the current document.
3188 * \li Syntax: buffer-params-apply [<ARGS>]
3189 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3190 you can find in document header of usual .lyx file.
3191 * \li Origin: leeming, 30 Mar 2004
3194 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3197 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3198 * \li Action: Inserts another LyX file.
3199 * \li Syntax: file-insert [<FILE>]
3200 * \li Params: <FILE>: Filename to be inserted.
3203 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3205 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3206 * \li Action: Inserts plain text file.
3207 * \li Syntax: file-insert-plaintext [<FILE>]
3208 * \li Params: <FILE>: Filename to be inserted.
3209 * \li Origin: CFO-G, 19 Nov 1997
3212 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3214 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3215 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3216 * \li Syntax: file-insert-plaintext-para [<FILE>]
3217 * \li Params: <FILE>: Filename to be inserted.
3218 * \li Origin: Levon, 14 Feb 2001
3221 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3223 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3224 * \li Action: Open LyX document.
3225 * \li Syntax: file-open [<FILE>]
3226 * \li Params: <FILE>: Filename to be opened.
3229 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3232 * \var lyx::FuncCode lyx::LFUN_CALL
3233 * \li Action: Executes a command defined in a .def file.
3234 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3235 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3236 where <NAME> is the name of the new command and <LFUN> is the lfun code
3237 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3238 \def_file "FileName" allows to include another .def file. \n
3239 This is particularly useful in connection with toolbar buttons:
3240 Since the name of the button image for this lfun is
3241 lib/images/commands/<NAME>.png this is the way to assign an image
3242 to a complex command-sequence.
3243 * \li Syntax: call <NAME>
3244 * \li Params: <NAME>: Name of the command that must be called.
3245 * \li Origin: broider, 2 Oct 2007
3248 { LFUN_CALL, "call", NoBuffer, System },
3250 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3251 * \li Action: Simulate halting Meta key (Alt key on PCs).
3252 * \li Notion: Used for buffer editation not for GUI control.
3253 * \li Syntax: meta-prefix
3256 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3258 * \var lyx::FuncCode lyx::LFUN_CANCEL
3259 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3260 * \li Syntax: cancel
3263 { LFUN_CANCEL, "cancel", NoBuffer, System },
3266 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3267 * \li Action: Switches the focus to the minibuffer so that the user can type
3268 in there. If necessary, it opens the minibuffer toolbar.
3269 * \li Notion: Usually bound to M-x shortcut.
3270 * \li Syntax: command-execute
3273 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3276 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3277 * \li Action: Return the current key sequence and available options as a string.
3278 * \li Notion: No options are added if no current map exists. \n
3279 This is probably usable only with connection to lyxserver.
3280 * \li Syntax: command-prefix
3283 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3285 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3286 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3287 * \li Syntax: command-sequence <CMDS>
3288 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3289 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3290 * \li Origin: Andre, 11 Nov 1999
3293 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3295 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3296 * \li Action: Runs the first listed command that is enabled.
3297 * \li Notion: This can be used to bind multiple functions to a single key,
3298 and then which one is used will depend upon the context.
3299 * \li Syntax: command-alternatives <CMDS>
3300 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3301 * \li Sample: command-alternatives completion-accept;cell-forward
3302 * \li Origin: rgh, 24 September 2008
3305 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3307 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3308 * \li Action: Shows message in statusbar (for script purposes).
3309 * \li Syntax: message <STRING>
3310 * \li Origin: Lgb, 8 Apr 2001
3313 { LFUN_MESSAGE, "message", NoBuffer, System },
3315 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3316 * \li Action: Set debug output level.
3317 * \li Syntax: debug-level-set <LEVEL>
3318 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3319 of their combination. 0 is equivalent to disabling all debug
3320 events. See lyx -dbg for the current list of debug levels
3322 * \li Origin: sanda, 28 Dec 2009
3325 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3328 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3329 * \li Action: Save user preferences.
3330 * \li Syntax: preferences-save
3331 * \li Origin: Lgb, 27 Nov 1999
3334 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3336 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3337 * \li Action: Reconfigure the automatic settings.
3338 * \li Syntax: reconfigure
3339 * \li Origin: Asger, 14 Feb 1997
3342 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3344 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3345 * \li Action: Apply the given settings to user preferences.
3346 * \li Syntax: lyxrc-apply <SETTINGS>
3347 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3348 to get an idea which commands to use and their syntax.
3349 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3352 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3354 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3355 * \li Action: Determine whether keep cursor inside the editing window regardless
3356 the scrollbar movement.
3357 * \li Syntax: toggle-cursor-follows-scrollbar
3358 * \li Origin: ARRae, 2 Dec 1997
3361 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3363 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3364 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3365 * \li Notion: A new color entry is created if the color is unknown.
3366 Color names can be stored as a part of user settings.
3367 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3368 * \li Origin: SLior, 11 Jun 2000
3371 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3373 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3374 * \li Action: Count the statistics (number of words and characters)
3375 in the document or in the given selection.
3376 * \li Notion: Note that this function gives the number of words/chars written,
3377 not the number of characters which will be typeset.
3378 * \li Syntax: statistics
3379 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3382 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3384 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3385 * \li Action: Show the inline completion at the cursor position.
3386 * \li Syntax: completion-inline
3387 * \li Origin: sts, Feb 19 2008
3390 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3392 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3393 * \li Action: Show the completion popup at the cursor position.
3394 * \li Syntax: completion-popup
3395 * \li Origin: sts, Feb 19 2008
3398 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3400 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3401 * \li Action: Try to complete the word or command at the cursor position.
3402 * \li Syntax: complete
3403 * \li Origin: sts, Feb 19 2008
3406 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3409 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3410 * \li Action: Try to cancel completion, either the popup or the inline completion.
3411 * \li Syntax: completion-cancel
3412 * \li Origin: sts, Sep 07 2008
3415 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3417 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3418 * \li Action: Accept suggested completion.
3419 * \li Syntax: completion-accept
3420 * \li Origin: sanda, Sep 08 2008
3423 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3427 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3428 * \li Action: Add a branch to the buffer's BranchList.
3429 * \li Syntax: branch-add <BRANCH>
3430 * \li Params: <BRANCH>: Name of the branch to add
3431 * \li Origin: spitz, 7 Jul 2009
3434 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3438 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3439 * \li Action: Activate the branch.
3440 * \li Syntax: branch-activate <BRANCH>
3441 * \li Params: <BRANCH>: The branch to activate
3442 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3443 could be used to export a pdf with the answers branch included
3444 without one's having to open LyX and activate the branch manually.
3445 * \li Origin: rgh, 27 May 2008
3448 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3450 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3451 * \li Action: De-activate the branch.
3452 * \li Syntax: branch-deactivate <BRANCH>
3453 * \li Params: <BRANCH>: The branch to deactivate
3454 * \li Origin: rgh, 27 May 2008
3457 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3460 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3461 * \li Action: Rename all branches of a given name in a document.
3462 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3463 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3464 * <NEWNAME>: New name of the branch
3465 * \li Origin: spitz, 9 Jul 2009
3468 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3470 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3471 * \li Action: Create new branch and directly put the branch inset into
3473 * \li Syntax: branch-add-insert [<NAME>]
3474 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3475 * \li Origin: sanda, 10 Jul 2009
3478 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3482 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3483 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3484 * \li Syntax: copy-label-as-reference <LABEL>
3485 * \li Params: <LABEL>: The label to copy (for multi-line math)
3486 * \li Origin: sts, 16 Nov 2008
3489 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference",
3490 ReadOnly | NoUpdate | AtPoint, Edit },
3493 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3494 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3495 * \li Syntax: label-insert-as-reference
3496 * \li Origin: vfr, 7 Apr 2009
3499 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3502 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3503 * \li Action: Increases the zoom of the screen fonts.
3504 * \li Syntax: buffer-zoom-in [<ZOOM>]
3505 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3506 * \li Origin: vfr, 30 Mar 2009
3509 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3512 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3513 * \li Action: Decreases the zoom of the screen fonts.
3514 * \li Syntax: buffer-zoom-out [<ZOOM>]
3515 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3516 * \li Origin: vfr, 30 Mar 2009
3519 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3522 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3523 * \li Action: Copies the inset to the clipboard as a certain type
3524 * \li Syntax: inset-copy-as [<TYPE>]
3525 * \li Params: <TYPE>: The type as which the inset is copied. This
3526 can vary from inset to inset.
3527 * \li Sample: InsetInfo is copied as text
3528 * \li Origin: vfr, 18 Apr 2010
3531 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3533 { LFUN_NOACTION, "", Noop, Hidden }
3534 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3537 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3538 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3544 LyXAction::LyXAction()
3550 FuncRequest LyXAction::lookupFunc(string const & func) const
3552 string const func2 = trim(func);
3555 return FuncRequest(LFUN_NOACTION);
3558 string const arg = split(func2, cmd, ' ');
3560 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3562 return fit != lyx_func_map.end()
3563 ? FuncRequest(fit->second, arg)
3564 : FuncRequest(LFUN_UNKNOWN_ACTION);
3568 string const LyXAction::getActionName(FuncCode action) const
3570 InfoMap::const_iterator const it = lyx_info_map.find(action);
3571 return it != lyx_info_map.end() ? it->second.name : string();
3575 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3577 InfoMap::const_iterator const it = lyx_info_map.find(action);
3578 return it != lyx_info_map.end() ? it->second.type : Hidden;
3582 bool LyXAction::funcHasFlag(FuncCode action,
3583 LyXAction::FuncAttribs flag) const
3585 InfoMap::const_iterator ici = lyx_info_map.find(action);
3587 if (ici == lyx_info_map.end()) {
3588 LYXERR0("action: " << action << " is not known.");
3589 LASSERT(false, /**/);
3592 return ici->second.attrib & flag;
3596 LyXAction::const_iterator LyXAction::func_begin() const
3598 return lyx_func_map.begin();
3602 LyXAction::const_iterator LyXAction::func_end() const
3604 return lyx_func_map.end();
3608 LyXErr & operator<<(LyXErr & l, FuncCode code)
3611 l.stream() << lyxaction.getActionName(code);