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.\n
2202 If no parameter is given, interactive dialog will be shown.
2203 * \li Sample: Compare current document against last commit\n
2205 * \li Sample: Compare current document against current revision - 5 commits\n
2207 * \li Sample: Compare revisions 120 and 155\n
2209 * \li Origin: sanda, 12 Feb 2010
2212 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2215 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2216 * \li Action: Toggles change tracking to on/off.
2217 * \li Syntax: changes-track
2218 * \li Origin: levon, 1 Oct 2002
2221 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2223 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2224 * \li Action: Toggles showing of change tracking in typesetted output.
2225 * \li Syntax: changes-output
2226 * \li Origin: jspitzm, 21 Jan 2005
2229 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2231 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2232 * \li Action: Moves the cursor to the position of the next change
2233 of the change tracking records.
2234 * \li Syntax: change-next
2235 * \li Origin: schmitt, 4 Oct 2006
2238 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2240 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2241 * \li Action: Moves the cursor to the position of the previous change
2242 of the change tracking records.
2243 * \li Syntax: change-previous
2244 * \li Origin: vfr, 4 Apr 2009
2247 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2249 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2250 * \li Action: Open change tracking dialog for merging and moves the cursor
2251 to the position of the next change.
2252 * \li Syntax: changes-merge
2253 * \li Origin: Levon, 16 Oct 2002
2256 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2258 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2259 * \li Action: Accepts tracked change inside the selection.
2260 * \li Syntax: change-accept
2261 * \li Origin: Levon, 16 Oct 2002
2264 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2266 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2267 * \li Action: Rejects tracked change inside the selection.
2268 * \li Syntax: change-accept
2269 * \li Origin: Levon, 16 Oct 2002
2272 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2274 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2275 * \li Action: Accepts all tracked changes in the document.
2276 * \li Syntax: all-changes-accept
2277 * \li Origin: Levon, 16 Oct 2002
2280 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2282 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2283 * \li Action: Rejects all tracked changes in the document.
2284 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2285 * \li Syntax: all-changes-reject
2286 * \li Origin: Levon, 16 Oct 2002
2289 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2292 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2293 * \li Action: Apply data for an inset.
2294 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2295 be applied. This is either changed to #LFUN_INSET_MODIFY or
2296 #LFUN_INSET_INSERT depending on the context where it is called.
2297 * \li Syntax: inset-apply <ARGS>
2298 * \li Params: See #LFUN_INSET_INSERT .
2301 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2303 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2304 * \li Action: Dissolve the current inset into text.
2305 * \li Syntax: inset-dissolve [<INSET>]
2306 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2307 is dissolved. For example "dissolve" entry in the charstyles
2308 sub-menu should only dissolve the charstyle inset, even if the
2309 cursor is inside several nested insets of different type.\n
2310 For values see #lyx::InsetLayout::lyxtype_ .
2311 * \li Origin: JSpitz, 7 Aug 2006
2314 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2316 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2317 * \li Action: Insert new inset (type given by the parameters).
2318 * \li Syntax: inset-insert <INSET> <ARGS>
2319 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular
2320 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
2321 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2322 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2323 where <label name> is the name of the referenced label and
2324 <Format> is one of the following: \n
2325 ref -- <reference> \n
2326 eqref -- (<reference>) \n
2327 pageref -- <page> \n
2328 vpageref -- on <page> \n
2329 vref -- <reference> on <page> \n
2330 prettyref -- Formatted reference
2333 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2335 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2336 * \li Action: Modify some properties of an inset.
2337 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2338 floats, graphics, include, index, info, label,
2339 listings, newline, newpage, nomencl, note, phantom,
2340 ref, space, tabular, vspace, wrap insets.
2341 * \li Syntax: inset-modify <INSET> <ARGS>
2342 * \li Syntax: inset-modify changetype <TYPE>
2343 * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
2344 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2345 In case that <INSET> is "tabular" various math-environment features
2346 are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
2347 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2348 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2349 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2350 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2351 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2352 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2353 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
2354 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2355 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2356 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2357 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2358 set-special-column|set-special-multicolumn|set-special-multirow|
2359 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2360 set-interline-space|set-border-lines|tabular-valign-top|
2361 tabular-valign-middle|tabular-valign-bottom \n
2362 <ARG>: additional argument for some commands, use debug mode to explore its values.
2363 * \li Sample: inset-modify note Note Comment
2364 * \li Sample: inset-modify changetype Ovalbox
2367 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2369 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2370 * \li Action: Updates the values inside the dialog from the inset.
2371 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2372 by #LFUN_DIALOG_UPDATE
2373 * \li Params: <DIALOG-NAME>
2374 * \li Origin: leeming, 25 Feb 2003
2377 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2379 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2380 * \li Action: Open the inset's properties dialog.
2381 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2382 float, graphics, href, include, index, index_print, label, line,
2383 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2384 * \li Syntax: inset-settings <INSET>
2385 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
2386 graphics|href|include|index|index_print|label|line|
2387 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2390 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2392 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2393 * \li Action: Toggles the collapsable inset at cursor position,
2394 or the inset we are currently in.
2395 * \li Syntax: inset-toggle [<ARG>]
2396 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2397 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2398 assign synchronize the branch-inset with activation status of the branch.
2399 Used for global toggling when changed activation.
2400 * \li Origin: lasgouttes, 19 Jul 2001
2403 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2405 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2406 * \li Action: Apply the given commands on insets of a given name.
2407 * \li Notion: WARNING: use at your own risks; this function gives
2408 you too many ways of shooting yourself in the foot.
2409 A typical example is
2410 inset-forall Note note-insert
2411 which starts an infinite loop. This is mitigated by the fact
2412 that the number of actions is arbitrarily limited to 10000.
2413 Note also that inset-forall does not update metrics between
2414 iterations, which can lead to bugs. This has to be eventually
2416 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2417 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2418 The name is used like for InsetLayout in layout files: "Note"
2419 matches all note insets, while "Note:Note" only matches LyX
2421 * \li Sample: Remove all index insets: \n
2422 inset-forall Index delete-char-forward \n
2423 Close all Notes (also works for a particular branch, for example): \n
2424 inset-forall Note inset-toggle close \n
2425 Transform all yellow notes to comments \n
2426 inset-forall Note:Note inset-modify note Note Comment \n
2427 Try to put LyX in an infinite loop if there is at least a Note: \n
2428 inset-forall Note char-backward
2429 * \li Origin: lasgouttes, 27 Nov 2009
2432 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2435 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2436 * \li Action: Reloads the image if necessary.
2437 * \li Syntax: graphics-reload
2438 * \li Origin: vfr, 10 Aug 2009
2441 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2443 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2444 * \li Action: Set the group for the graphics inset on the cursor position.
2445 * \li Syntax: set-graphics-group [<GROUP>]
2446 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2447 the graphics inset is removed from the current group.
2448 * \li Origin: sanda, 6 May 2008
2451 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2454 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2455 * \li Action: Moves the cursor out of the current slice, going forward.
2456 * \li Notion: Cursor movement within an inset may be different than cursor
2457 movement in the surrounding text. This action should be called
2458 automatically by the cursor movement within the inset, when
2459 movement within the inset has ceased (reached the end of the
2460 last paragraph, for example), in order to move correctly
2461 back into the surrounding text.
2464 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2466 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2467 * \li Action: Moves the cursor out of the current slice, going backwards.
2468 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2471 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2473 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2474 * \li Action: Moves the cursor out of the current slice, going right.
2475 * \li Notion: See also #LFUN_FINISHED_FORWARD
2478 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2480 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2481 * \li Action: Moves the cursor out of the current slice, going left.
2482 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2485 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2488 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2489 * \li Action: Set language from the current cursor position.
2490 * \li Syntax: language <LANG>
2491 * \li Params: <LANG>: Requested language. Look in lib/languages for
2493 * \li Origin: Dekel, 2 Mar 2000
2496 { LFUN_LANGUAGE, "language", Noop, Edit },
2499 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2500 * \li Action: Goto a label.
2501 * \li Syntax: label-goto [<LABEL>]
2502 * \li Params: <LABEL>: Requested label. If no label is given and reference
2503 is on cursor position, Bookmark 0 is saved and
2504 cursor moves to the position of referenced label.
2505 * \li Origin: Ale, 6 Aug 1997
2508 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2510 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2511 * \li Action: Inserts label to text or displayed formula.
2512 * \li Syntax: label-insert [<LABEL>]
2513 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2514 name will be opened.
2517 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2519 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2520 * \li Action: Go to the next label or cross-reference.
2521 * \li Syntax: reference-next
2522 * \li Origin: Dekel, 14 Jan 2001
2525 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2528 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2529 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2530 if necessary. Note that bookmarsk are saved per-session, not
2532 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2533 1. to the paragraph you are currently editing \n
2534 2. to the paragraph from where you are jumping to the last-edited
2535 position (jump-back feature) \n
2536 3. when jumping from crossreference to the requested label by
2538 * \li Syntax: bookmark-goto <NUMBER>
2539 * \li Params: <NUMBER>: the number of the bookmark to restore.
2540 * \li Origin: Dekel, 27 January 2001
2543 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2545 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2546 * \li Action: Save a bookmark.
2547 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2548 must be between 1 and 9, inclusive. Note that bookmarks are
2549 saved per-session, not per file.
2550 * \li Syntax: bookmark-save <NUMBER>
2551 * \li Params: <NUMBER>: the number of the bookmark to save.
2552 * \li Origin: Dekel, 27 January 2001
2555 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2557 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2558 * \li Action: Clears the list of saved bookmarks.
2559 * \li Syntax: bookmark-clear
2560 * \li Origin: bpeng, 31 October 2006
2563 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2566 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2567 * \li Action: Open the given help file according to the language setting.
2568 * \li Syntax: help-open <FILE>[.lyx]
2569 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2570 * \li Origin: Jug, 27 Jun 1999
2573 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2575 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2576 * \li Action: Terminates the current LyX instance.
2577 * \li Notion: Terminates the current LyX instance, asking whether to save
2578 modified documents, etc.
2579 * \li Syntax: lyx-quit
2582 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2584 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2585 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2586 * \li Notion: Skipping "auto" when allowauto is false.
2587 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2588 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
2589 minibuffer|review|view/update|math_panels|vcs|
2590 view-others|update-others
2591 * \li Origin: Edwin, 21 May 2007
2594 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2596 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2597 * \li Action: Opens the menu given by its name.
2598 * \li Syntax: menu-open <NAME>
2599 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2602 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2604 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2605 * \li Action: Various UI visibility-toggling actions.
2606 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2607 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2608 menubar : Toggle visibility of the menubar.\n
2609 scrollbar : Toggle visibility of the scrollbar.\n
2610 frame : Toggle visibility of the frames around editing window.\n
2611 fullscreen : Toggle fullscreen mode. This also covers calling the
2612 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2613 custom tweaks of the toolbars should be used.
2614 * \li Origin: sanda, 9 Feb 2007
2617 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2620 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2621 * \li Action: Creates new empty LyX window.
2622 * \li Notion: Already opened documents from the previous window can be found under View menu.
2623 * \li Syntax: window-new [<GEOMETRY>]
2624 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2625 accepted only on Windows platform.
2626 * \li Origin: Abdel, 21 Oct 2006
2629 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2631 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2632 * \li Action: Closes the current LyX window.
2633 * \li Syntax: window-close
2634 * \li Origin: Abdel, 23 Oct 2006
2637 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2640 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2641 * \li Action: Creates another split view of current buffer.
2642 * \li Notion: All split views act in the same way indpendently.
2643 * \li Syntax: split-view <vertical|horizontal>
2644 * \li Params: horizontal : The work areas are laid out side by side.\n
2645 vertical : The work areas laid out vertically.
2646 * \li Origin: Abdel, 20 Feb 2008
2649 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2652 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2653 * \li Action: Close the current tab group.
2654 * \li Notion: This only closes the work areas, not the buffer themselves.
2655 The still opened buffers can be visualized in another tab group.
2656 * \li Syntax: close-tab-group
2657 * \li Origin: Abdel, 21 Feb 2008
2660 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2662 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2663 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2664 * \li Syntax: dialog-show <NAME> [<DATA>]
2665 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2666 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2667 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2668 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2669 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2670 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2671 <SPECIAL>: latexlog|vclog \n
2672 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2674 * \li Origin: leeming, 17 Jun 2003
2677 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2679 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2680 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2681 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2682 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2683 * \li Params: See #LFUN_DIALOG_SHOW .
2684 * \li Origin: leeming, 25 Feb 2003
2687 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2689 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2690 * \li Action: Updates the dialog values from the inset/paragraph/document.
2691 * \li Syntax: dialog-update <NAME>
2692 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2694 * \li Origin: leeming, 25 Feb 2003
2697 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2699 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2700 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2701 * \li Syntax: dialog-hide <NAME>
2702 * \li Params: See #LFUN_DIALOG_SHOW .
2703 * \li Origin: leeming, 25 Feb 2003
2706 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2708 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2709 * \li Action: Toggles dialog between showed/hidden state.
2710 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2711 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2712 * \li Params: See #LFUN_DIALOG_SHOW .
2713 * \li Origin: JSpitzm, 30 Apr 2007
2716 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2718 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2719 * \li Action: Closes opened connection to opened inset.
2720 * \li Notion: Connection is used for apply functions.
2721 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2722 * \li Origin: leeming, 25 Feb 2003
2725 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2728 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2729 * \li Action: This function is called when mouse button is pressed (inside workarea).
2730 Action depends on the context.
2731 * \li Notion: This is internal LFUN, not to be used by users.
2732 * \li Origin: Andre, 9 Aug 2002
2735 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2737 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2738 * \li Action: This function is called when double click on mouse button is
2739 pressed (inside workarea). Action depends on the context.
2740 * \li Notion: This is internal LFUN, not to be used by users.
2741 * \li Origin: Andre, 9 Aug 2002
2744 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2746 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2747 * \li Action: This function is called when triple click on mouse button is
2748 pressed (inside workarea). Action depends on the context.
2749 * \li Notion: This is internal LFUN, not to be used by users.
2750 * \li Origin: Andre, 9 Aug 2002
2753 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2755 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2756 * \li Action: This function is called when mouse cursor is moving over the text.
2757 Action depends on the context.
2758 * \li Notion: This is internal LFUN, not to be used by users.
2759 * \li Origin: Andre, 9 Aug 2002
2762 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2764 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2765 * \li Action: This function is called when mouse button is released (inside workarea).
2766 Action depends on the context.
2767 * \li Notion: This is internal LFUN, not to be used by users.
2768 * \li Origin: Andre, 9 Aug 2002
2771 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2774 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2775 * \li Action: Turn off the loaded keyboard map.
2776 * \li Syntax: keymap-off
2779 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2781 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2782 * \li Action: Turn on the primary keyboard map.
2783 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2784 keyboard support. They can be still used to maintain uniform keyboard
2785 layout across the various plaforms.\n
2786 The language is to be set in the Preferences dialog.
2787 * \li Syntax: keymap-primary
2790 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2792 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2793 * \li Action: Turn on the secondary keyboard map.
2794 * \li Syntax: keymap-secondary
2797 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2799 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2800 * \li Action: Toggles keyboard maps (first/second/off).
2801 * \li Syntax: keymap-toggle
2802 * \li Origin: leeming, 30 Mar 2004
2805 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2808 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2809 * \li Action: Returns the current layout (that is environment) name
2810 on the cursor position.
2811 * \li Syntax: server-get-layout
2814 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2816 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2817 * \li Action: Returns path and file name of the currently edited document.
2818 * \li Syntax: server-get-filename
2821 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2823 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2824 * \li Action: Sets the cursor position based on the row number of generated TeX file.
2825 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2826 line from LaTeX compilation. Note that before this function can be used
2827 export to LaTeX output must occur (in order to map the row numbers).
2828 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2829 * \li Params: <FILE>: the filename. Environment variables are expanded in the path.
2830 In case this LFUN does not work make sure you are giving correct
2832 If the file is located inside LyX temporary directory it will be
2833 mapped back into the appropriate opened buffer (e.g. for the case
2834 of generated .tex file).
2835 .ext: extensions will be automatically replaced by .lyx.
2836 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2837 * \li Origin: Edmar, 23 Dec 1998
2840 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2842 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
2843 * \li Action: Sets the cursor position in the previewed (e.g. dvi) file based on the row
2844 number in LyX window.
2845 * \li Notion: The external program used for forward search call can be specified in
2846 \forward_search_dvi and \forward_search_pdf RC settings.
2847 By default, the value for pdf is empty, while for dvi it is\n
2848 "xdvi -sourceposition $$n:$$t $$o"\n
2849 The values replaced in the call: $$n for row number, $$t for
2850 exported temporary .tex file, $$o exported output file, either
2851 dvi or pdf, depending on which one exists in the temp dir
2853 * \li Syntax: forward-search
2854 * \li Origin: sanda, 14 Apr 2010
2857 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
2859 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2860 * \li Action: Sends notify message about the last key-sequence to client.
2861 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2862 See also Debug extensions section in Additional features manual.
2863 * \li Syntax: server-notify
2866 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2868 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2869 * \li Action: Sets the cursor position based on the editing area coordinates
2870 (similar as clicking on that point with left mouse button).
2871 * \li Syntax: server-set-xy <X> <Y>
2874 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2876 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2877 * \li Action: Returns the coordinates of cursor position in the editing area.
2878 * \li Syntax: server-get-xy
2881 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2884 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2885 * \li Action: Generates the code (literate programming).
2886 * \li Notion: Latex file with extension \literate_extension is generated.
2887 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2888 \build_error_filter to process the compilation error messages. \n
2889 In case you want to process your literate file with a script, or some other program,
2890 just insert in your lyxrc file an entry with:\n
2891 \build_command "my_script my_arguments" \n
2892 The \build_error_filter differs from the \literate_error_filter only in that the
2893 former will identify error messages from your compiler.
2894 * \li Syntax: build-program
2897 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2900 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2901 * \li Action: Saves the current buffer to a temporary file.
2902 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2903 is called automatically by LyX, to "autosave" the current buffer.
2904 * \li Syntax: buffer-auto-save
2907 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2909 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2910 * \li Action: Loads the given child document.
2911 * \li Notion: The current document is treated as a parent.
2912 * \li Syntax: buffer-child-open <FILE>
2913 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2914 * \li Origin: Ale, 28 May 1997
2917 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2919 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2920 * \li Action: Runs chktex for the current document.
2921 * \li Syntax: buffer-chktex
2922 * \li Origin: Asger, 30 Oct 1997
2925 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2927 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2928 * \li Action: Toggles compression of the current document on/off.
2929 * \li Syntax: buffer-toggle-compression
2930 * \li Origin: bpeng, 27 Apr 2006
2933 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2935 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
2936 * \li Action: Toggles including of resources for forward/reverse search of the given document.
2937 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
2938 is used for DVI. Custom LaTeX macro can be defined in preferences.
2939 * \li Syntax: buffer-toggle-output-sync
2940 * \li Origin: sanda, 25 May 2010
2943 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
2945 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2946 * \li Action: Closes the current buffer.
2947 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2948 if the buffer has been modified.
2949 * \li Syntax: buffer-close
2952 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2954 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2955 * \li Action: Closes all buffers.
2956 * \li Notion: Closes all buffers, asking whether to save it, etc,
2957 if a buffer has been modified.
2958 * \li Syntax: buffer-close-all
2961 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2963 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2964 * \li Action: Exports the current buffer (document) to the given format.
2965 * \li Syntax: buffer-export <FORMAT>
2966 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2967 can find in Tools->Preferences->File formats->Format.
2968 Usual format you will enter is "pdf2" (pdflatex),
2969 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2970 In case of "custom" you will be asked for a format you
2971 want to start from and for the command that you want to
2972 apply to this format. Internally the control is then passed
2973 to #LFUN_BUFFER_EXPORT_CUSTOM.
2974 * \li Origin: Lgb, 29 Jul 1997
2977 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2979 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2980 * \li Action: Exports the current buffer (document) from the given format using
2981 the given command on it.
2982 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2983 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2984 intermediate file).\n
2985 <COMMAND> this command will be launched on the file. Note that you can
2986 use "$$FName" string to qualify the intermediate file.
2987 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2988 * \li Origin: leeming, 27 Mar 2004
2991 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2993 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2994 * \li Action: Prints the current document.
2995 * \li Notion: Many settings can be given via the preferences dialog.
2996 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2997 * \li Params: <TARGET> is either "printer" or "file".\n
2998 <TARGER-NAME> is either "default" or file name or printer name.\n
2999 <COMMAND> command ensuring the printing job.
3000 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
3001 * \li Origin: leeming, 28 Mar 2004
3004 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
3006 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3007 * \li Action: Import a given file as a lyx document.
3008 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3009 defined convertors in preferences. Look into File->Import menu to get
3010 an idea of the currently active import formats.
3011 * \li Syntax: buffer-import <FORMAT> [<FILE>]
3012 * \li Origin: Asger, 24 Jul 1998
3015 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3017 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3018 * \li Action: Creates a new buffer (that is, document).
3019 * \li Notion: Implicit path can be set in Preferences dialog.
3020 * \li Syntax: buffer-new [<FILE>]
3021 * \li Params: <FILE>: filename of created file with absolute path.
3024 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3026 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3027 * \li Action: Creates a new buffer (that is, document) from a template.
3028 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3029 Template will be asked for via Open-dialog.
3030 * \li Syntax: buffer-new-template [<FILE>]
3031 * \li Params: <FILE>: filename of created file with absolute path.
3034 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3036 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3037 * \li Action: Reverts opened document.
3038 * \li Syntax: buffer-reload
3039 * \li Origin: Asger, 2 Feb 1997
3042 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3044 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3045 * \li Action: Display/switch to the given buffer.
3046 * \li Syntax: buffer-switch <BUFFER>
3047 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3048 document which is to be shown.
3051 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3053 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3054 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3055 * \li Notion: This function is not allowed if the file is under version control, since
3056 read-only flag is often used in version control file locking.
3057 * \li Syntax: buffer-toggle-read-only
3058 * \li Origin: Lgb, 27 May 1997
3061 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3063 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3064 * \li Action: Displays current buffer in chosen format.
3065 * \li Notion: Displays the contents of the current buffer in the chosen
3066 format, for example, PDF or DVI. This runs the necessary
3067 converter, calls the defined viewer, and so forth.
3068 * \li Syntax: buffer-view [<FORMAT>]
3069 * \li Params: <FORMAT>: The format to display, where this is one of the
3070 formats defined (in the current GUI) in the
3071 Tools>Preferences>File Formats dialog.
3072 If no format is given, the default format as
3073 specified in the same dialog is used.
3076 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3078 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3079 * \li Action: Exports the current document and put the result into the
3080 temporary directory.
3081 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3082 the output will be rewriten - updated. This is useful in case your viewer
3083 is able to detect such changes (e.g. ghostview for postscript).
3084 * \li Syntax: buffer-update [<FORMAT>]
3085 * \li Params: <FORMAT>: The format to display, where this is one of the
3086 formats defined (in the current GUI) in the
3087 Tools>Preferences>File Formats dialog.
3088 If no format is given, the default format as
3089 specified in the same dialog is used.
3090 * \li Origin: Dekel, 5 Aug 2000
3093 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3096 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3097 * \li Action: Saves the current buffer.
3098 * \li Notion: Saves the current buffer to disk, using the filename that
3099 is already associated with the buffer, asking for one if
3100 none is yet assigned.
3101 * \li Syntax: buffer-write
3104 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3106 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3107 * \li Action: Rename and save current buffer.
3108 * \li Syntax: buffer-write-as <FILENAME>
3109 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3110 is with respect to the original location of the buffer/file.
3113 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3115 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3116 * \li Action: Save all changed documents.
3117 * \li Syntax: buffer-write-all
3118 * \li Origin: rgh, gpothier 6 Aug 2007
3121 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3123 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3124 * \li Action: Switch to the next opened document.
3125 * \li Notion: Note that this does not necessarily mean next in tabbar
3126 (for full list see View menu).
3127 * \li Syntax: buffer-next
3130 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3132 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3133 * \li Action: Switch to the previous opened document.
3134 * \li Syntax: buffer-previous
3137 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3139 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3140 * \li Action: When run from a child document, this updates (exports) document built
3141 from the master buffer, if available.
3142 * \li Syntax: master-buffer-update [<FORMAT>]
3143 * \li Params: <FORMAT>: The format to display, where this is one of the
3144 formats defined (in the current GUI) in the
3145 Tools>Preferences>File Formats dialog.
3146 If no format is given, the default format as
3147 specified in the same dialog is used.
3148 * \li Origin: Tommaso, 20 Sep 2007
3151 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3153 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3154 * \li Action: When run from a child document, this command shows a preview built
3155 from the master buffer, if available.
3156 * \li Syntax: master-buffer-view [<FORMAT>]
3157 * \li Params: <FORMAT>: The format to display, where this is one of the
3158 formats defined (in the current GUI) in the
3159 Tools>Preferences>File Formats dialog.
3160 If no format is given, the default format as
3161 specified in the same dialog is used.
3162 * \li Origin: Tommaso, 20 Sep 2007
3165 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3167 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3168 * \li Action: Set language of the current document.
3169 * \li Syntax: buffer-language <LANG>
3170 * \li Params: <LANG>: language name. See lib/languages for list.
3171 * \li Origin: leeming, 30 Mar 2004
3174 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3176 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3177 * \li Action: Save the current document settings as default.
3178 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3179 * \li Syntax: buffer-save-as-default [<ARGS>]
3180 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3181 you can find in document header of usual .lyx file.
3182 * \li Origin: leeming, 30 Mar 2004
3185 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3187 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3188 * \li Action: Apply the given settings to the current document.
3189 * \li Syntax: buffer-params-apply [<ARGS>]
3190 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3191 you can find in document header of usual .lyx file.
3192 * \li Origin: leeming, 30 Mar 2004
3195 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3198 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3199 * \li Action: Inserts another LyX file.
3200 * \li Syntax: file-insert [<FILE>]
3201 * \li Params: <FILE>: Filename to be inserted.
3204 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3206 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3207 * \li Action: Inserts plain text file.
3208 * \li Syntax: file-insert-plaintext [<FILE>]
3209 * \li Params: <FILE>: Filename to be inserted.
3210 * \li Origin: CFO-G, 19 Nov 1997
3213 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3215 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3216 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3217 * \li Syntax: file-insert-plaintext-para [<FILE>]
3218 * \li Params: <FILE>: Filename to be inserted.
3219 * \li Origin: Levon, 14 Feb 2001
3222 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3224 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3225 * \li Action: Open LyX document.
3226 * \li Syntax: file-open [<FILE>]
3227 * \li Params: <FILE>: Filename to be opened.
3230 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3233 * \var lyx::FuncCode lyx::LFUN_CALL
3234 * \li Action: Executes a command defined in a .def file.
3235 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3236 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3237 where <NAME> is the name of the new command and <LFUN> is the lfun code
3238 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3239 \def_file "FileName" allows to include another .def file. \n
3240 This is particularly useful in connection with toolbar buttons:
3241 Since the name of the button image for this lfun is
3242 lib/images/commands/<NAME>.png this is the way to assign an image
3243 to a complex command-sequence.
3244 * \li Syntax: call <NAME>
3245 * \li Params: <NAME>: Name of the command that must be called.
3246 * \li Origin: broider, 2 Oct 2007
3249 { LFUN_CALL, "call", NoBuffer, System },
3251 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3252 * \li Action: Simulate halting Meta key (Alt key on PCs).
3253 * \li Notion: Used for buffer editation not for GUI control.
3254 * \li Syntax: meta-prefix
3257 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3259 * \var lyx::FuncCode lyx::LFUN_CANCEL
3260 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3261 * \li Syntax: cancel
3264 { LFUN_CANCEL, "cancel", NoBuffer, System },
3267 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3268 * \li Action: Switches the focus to the minibuffer so that the user can type
3269 in there. If necessary, it opens the minibuffer toolbar.
3270 * \li Notion: Usually bound to M-x shortcut.
3271 * \li Syntax: command-execute
3274 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3277 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3278 * \li Action: Return the current key sequence and available options as a string.
3279 * \li Notion: No options are added if no current map exists. \n
3280 This is probably usable only with connection to lyxserver.
3281 * \li Syntax: command-prefix
3284 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3286 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3287 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3288 * \li Syntax: command-sequence <CMDS>
3289 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3290 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3291 * \li Origin: Andre, 11 Nov 1999
3294 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3296 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3297 * \li Action: Runs the first listed command that is enabled.
3298 * \li Notion: This can be used to bind multiple functions to a single key,
3299 and then which one is used will depend upon the context.
3300 * \li Syntax: command-alternatives <CMDS>
3301 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3302 * \li Sample: command-alternatives completion-accept;cell-forward
3303 * \li Origin: rgh, 24 September 2008
3306 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3308 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3309 * \li Action: Shows message in statusbar (for script purposes).
3310 * \li Syntax: message <STRING>
3311 * \li Origin: Lgb, 8 Apr 2001
3314 { LFUN_MESSAGE, "message", NoBuffer, System },
3316 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3317 * \li Action: Set debug output level.
3318 * \li Syntax: debug-level-set <LEVEL>
3319 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3320 of their combination. 0 is equivalent to disabling all debug
3321 events. See lyx -dbg for the current list of debug levels
3323 * \li Origin: sanda, 28 Dec 2009
3326 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3329 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3330 * \li Action: Save user preferences.
3331 * \li Syntax: preferences-save
3332 * \li Origin: Lgb, 27 Nov 1999
3335 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3337 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3338 * \li Action: Reconfigure the automatic settings.
3339 * \li Syntax: reconfigure
3340 * \li Origin: Asger, 14 Feb 1997
3343 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3345 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3346 * \li Action: Apply the given settings to user preferences.
3347 * \li Syntax: lyxrc-apply <SETTINGS>
3348 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3349 to get an idea which commands to use and their syntax.
3350 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3353 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3355 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3356 * \li Action: Determine whether keep cursor inside the editing window regardless
3357 the scrollbar movement.
3358 * \li Syntax: toggle-cursor-follows-scrollbar
3359 * \li Origin: ARRae, 2 Dec 1997
3362 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3364 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3365 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3366 * \li Notion: A new color entry is created if the color is unknown.
3367 Color names can be stored as a part of user settings.
3368 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3369 * \li Origin: SLior, 11 Jun 2000
3372 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3374 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3375 * \li Action: Count the statistics (number of words and characters)
3376 in the document or in the given selection.
3377 * \li Notion: Note that this function gives the number of words/chars written,
3378 not the number of characters which will be typeset.
3379 * \li Syntax: statistics
3380 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3383 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3385 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3386 * \li Action: Show the inline completion at the cursor position.
3387 * \li Syntax: completion-inline
3388 * \li Origin: sts, Feb 19 2008
3391 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3393 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3394 * \li Action: Show the completion popup at the cursor position.
3395 * \li Syntax: completion-popup
3396 * \li Origin: sts, Feb 19 2008
3399 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3401 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3402 * \li Action: Try to complete the word or command at the cursor position.
3403 * \li Syntax: complete
3404 * \li Origin: sts, Feb 19 2008
3407 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3410 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3411 * \li Action: Try to cancel completion, either the popup or the inline completion.
3412 * \li Syntax: completion-cancel
3413 * \li Origin: sts, Sep 07 2008
3416 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3418 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3419 * \li Action: Accept suggested completion.
3420 * \li Syntax: completion-accept
3421 * \li Origin: sanda, Sep 08 2008
3424 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3428 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3429 * \li Action: Add a branch to the buffer's BranchList.
3430 * \li Syntax: branch-add <BRANCH>
3431 * \li Params: <BRANCH>: Name of the branch to add
3432 * \li Origin: spitz, 7 Jul 2009
3435 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3439 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3440 * \li Action: Activate the branch.
3441 * \li Syntax: branch-activate <BRANCH>
3442 * \li Params: <BRANCH>: The branch to activate
3443 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3444 could be used to export a pdf with the answers branch included
3445 without one's having to open LyX and activate the branch manually.
3446 * \li Origin: rgh, 27 May 2008
3449 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3451 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3452 * \li Action: De-activate the branch.
3453 * \li Syntax: branch-deactivate <BRANCH>
3454 * \li Params: <BRANCH>: The branch to deactivate
3455 * \li Origin: rgh, 27 May 2008
3458 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3461 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3462 * \li Action: Rename all branches of a given name in a document.
3463 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3464 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3465 * <NEWNAME>: New name of the branch
3466 * \li Origin: spitz, 9 Jul 2009
3469 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3471 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3472 * \li Action: Create new branch and directly put the branch inset into
3474 * \li Syntax: branch-add-insert [<NAME>]
3475 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3476 * \li Origin: sanda, 10 Jul 2009
3479 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3483 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3484 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3485 * \li Syntax: copy-label-as-reference <LABEL>
3486 * \li Params: <LABEL>: The label to copy (for multi-line math)
3487 * \li Origin: sts, 16 Nov 2008
3490 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference",
3491 ReadOnly | NoUpdate | AtPoint, Edit },
3494 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3495 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3496 * \li Syntax: label-insert-as-reference
3497 * \li Origin: vfr, 7 Apr 2009
3500 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3503 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3504 * \li Action: Increases the zoom of the screen fonts.
3505 * \li Syntax: buffer-zoom-in [<ZOOM>]
3506 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3507 * \li Origin: vfr, 30 Mar 2009
3510 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3513 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3514 * \li Action: Decreases the zoom of the screen fonts.
3515 * \li Syntax: buffer-zoom-out [<ZOOM>]
3516 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3517 * \li Origin: vfr, 30 Mar 2009
3520 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3523 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3524 * \li Action: Copies the inset to the clipboard as a certain type
3525 * \li Syntax: inset-copy-as [<TYPE>]
3526 * \li Params: <TYPE>: The type as which the inset is copied. This
3527 can vary from inset to inset.
3528 * \li Sample: InsetInfo is copied as text
3529 * \li Origin: vfr, 18 Apr 2010
3532 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3534 { LFUN_NOACTION, "", Noop, Hidden }
3535 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3538 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3539 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3545 LyXAction::LyXAction()
3551 FuncRequest LyXAction::lookupFunc(string const & func) const
3553 string const func2 = trim(func);
3556 return FuncRequest(LFUN_NOACTION);
3559 string const arg = split(func2, cmd, ' ');
3561 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3563 return fit != lyx_func_map.end()
3564 ? FuncRequest(fit->second, arg)
3565 : FuncRequest(LFUN_UNKNOWN_ACTION);
3569 string const LyXAction::getActionName(FuncCode action) const
3571 InfoMap::const_iterator const it = lyx_info_map.find(action);
3572 return it != lyx_info_map.end() ? it->second.name : string();
3576 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3578 InfoMap::const_iterator const it = lyx_info_map.find(action);
3579 return it != lyx_info_map.end() ? it->second.type : Hidden;
3583 bool LyXAction::funcHasFlag(FuncCode action,
3584 LyXAction::FuncAttribs flag) const
3586 InfoMap::const_iterator ici = lyx_info_map.find(action);
3588 if (ici == lyx_info_map.end()) {
3589 LYXERR0("action: " << action << " is not known.");
3590 LASSERT(false, /**/);
3593 return ici->second.attrib & flag;
3597 LyXAction::const_iterator LyXAction::func_begin() const
3599 return lyx_func_map.begin();
3603 LyXAction::const_iterator LyXAction::func_end() const
3605 return lyx_func_map.end();
3609 LyXErr & operator<<(LyXErr & l, FuncCode code)
3612 l.stream() << lyxaction.getActionName(code);