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_NEWPAGE_INSERT
329 * \li Action: Inserts a new page.
330 * \li Syntax: newpage-insert <ARG>
331 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
332 * \li Origin: uwestoehr, 24 Nov 2007
335 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
337 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
338 * \li Action: Inserts a marginal note.
339 * \li Syntax: marginalnote-insert
340 * \li Origin: Lgb, 26 Jun 2000
343 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
345 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
346 * \li Action: Inserts a single unicode character.
347 * \li Syntax: unicode-insert <CHAR>
348 * \li Params: <CHAR>: The character to insert, given as its code
349 point, in hexadecimal.
350 * \li Sample: unicode-insert 0x0100
351 * \li Origin: Lgb, 22 Oct 2006
354 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
356 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
357 * \li Action: Inserts a new listings inset.
358 * \li Syntax: listing-insert
359 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
362 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
364 * \var lyx::FuncCode lyx::LFUN_PREVIEW_INSERT
365 * \li Action: Inserts a new preview inset.
366 * \li Syntax: preview-insert
367 * \li Origin: vfr, 28 Mar 2010
370 { LFUN_PREVIEW_INSERT, "preview-insert", Noop, Edit },
372 * \var lyx::FuncCode lyx::LFUN_TAB_INSERT
373 * \li Action: Insert a tab into a listings inset.
374 * \li Notion: It also works on a selection.
375 * \li Syntax: tab-insert
376 * \li Origin: vfr, Sep 30 2008
379 { LFUN_TAB_INSERT, "tab-insert", SingleParUpdate, Edit },
381 * \var lyx::FuncCode lyx::LFUN_TAB_DELETE
382 * \li Action: Delete a tab or up to an equivalent amount of spaces from
384 * \li Notion: It also works on a selection - it removes a tab or spaces from the
385 beginning of each line spanned by the selection. This is useful if
386 you want to indent/unindent multiple lines in one action.
387 * \li Syntax: tab-delete
388 * \li Origin: vfr, Sep 30 2008
391 { LFUN_TAB_DELETE, "tab-delete", SingleParUpdate, Edit },
393 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
394 * \li Action: Inserts quotes according to the type and quote-language preference.
395 * \li Notion: Currently English, Swedish, German, Polish, French, Danish quotes
397 * \li Syntax: quote-insert [<TYPE>]
398 * \li Params: <TYPE>: 'single' for single quotes, otherwise double quotes will be used.
401 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
403 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
404 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
405 information in a non-editable boxed InsetText.
406 * \li Notion: Apart from lfun arguments you can use the following method: \n
407 1. input the type and argument of this inset, e.g. "menu paste", in
409 2. select the text and run info-insert lfun.
410 * \li Syntax: info-insert <TYPE> <ARG>
411 * \li Params: <TYPE>: shortcut[s]|lyxrc|lyxinfo|package|textclass|menu|buffer \n
412 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
414 shortcut[s]: name of lfun (e.g math-insert \alpha) \n
415 lyxrc: name of rc_entry (e.g. bind_file) \n
416 lyxinfo: "version" - used version of LyX \n
417 package: name of latex package (e.g. listings) \n
418 textclass: name of textclass (e.g. article) \n
419 menu: name of lfun used in menu \n
420 icon: icon of lfun used in toolbar \n
421 buffer: "name"|"path"|"class"|"vcs-tree-revision"|
422 "vcs-revision"|"vcs-author"|"vcs-date"|"vcs-time"
423 * \li Sample: command-sequence info-insert buffer path; info-insert buffer name
424 * \li Origin: bpeng, 7 Oct 2007
427 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
429 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
430 * \li Action: Inserts branch inset.
431 * \li Syntax: branch-insert <BRANCH-NAME>
432 * \li Origin: vermeer, 17 Aug 2003
435 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
437 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
438 * \li Action: Inserts Box inset.
439 * \li Syntax: box-insert [<TYPE>]
440 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
441 Framed is the default one.
442 * \li Origin: vermeer, 7 Oct 2003
445 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
447 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
448 * \li Action: Inserts CharStyle, Custom inset or XML short element.
449 * \li Notion: Look into the Customization manual for more information about
451 To make this command enabled the layout file for the document
452 class you're using has to load the character styles. There are
453 a few contained in the Logical Markup module. You can also of
454 course create some yourself. \n
455 For dissolving the element see #LFUN_INSET_DISSOLVE.
456 * \li Syntax: flex-insert Name
457 * \li Params: Name: This name must be defined either in your layout file
458 or imported by some module. The definition is
459 InsetLayout Name or InsetLayout <Flex:Name>. The Flex:
461 * \li Sample: flex-insert Code
464 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
466 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
467 * \li Action: Inserts the given string (accordingly to the correct keymap).
468 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
469 settings "auto_region_delete".
470 * \li Syntax: self-insert <STRING>
473 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
475 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
476 * \li Action: Inserts one of horizontal space insets.
477 * \li Syntax: space-insert <NAME> [<LEN>]
478 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
479 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
481 <LEN>: length for custom spaces (hspace, hspace* for protected)
482 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
485 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
487 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
488 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
489 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
490 * \li Syntax: href-insert [<TARGET>]
491 * \li Origin: CFO-G, 21 Nov 1997
494 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
496 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
497 * \li Action: Inserts various characters into the document.
498 * \li Syntax: specialchar-insert <CHAR>
499 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
500 end-of-sentence, menu-separator.
501 * \li Origin: JSpitzm, 6 Dec 2007
504 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
506 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
507 * \li Action: Inserts a subscript or superscript inset.
508 * \li Syntax: script-insert <TYPE>
509 * \li Params: <TYPE>: subscript|superscript
510 * \li Origin: Georg, 23 Nov 2010
513 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
515 * \var lyx::FuncCode lyx::LFUN_APPENDIX
516 * \li Action: Start (or remove) Appendix on the given cursor position.
517 * \li Syntax: appendix
518 * \li Origin: ettrich, 5 May 1998
521 { LFUN_APPENDIX, "appendix", Noop, Edit },
524 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
525 * \li Action: Inserts Index entry.
526 * \li Notion: It automatically takes the word on the cursor position.
527 * \li Syntax: index-insert [<TYPE:Name>]
528 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
529 with an empty argument, the default index is selected.
530 * \li Origin: leeming, 3 Aug 2000
533 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
535 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
536 * \li Action: Inserts list of Index entries on a new page.
537 * \li Syntax: index-print [<TYPE:Name>]
538 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
539 with an empty argument, the default index is selected.
540 * \li Origin: Lgb, 27 Feb 1997
543 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
546 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
547 * \li Action: Inserts Nomenclature entry.
548 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
549 * \li Syntax: nomencl-insert [<SYMBOL>]
550 * \li Origin: Ugras, 4 Nov 2006
553 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
555 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
556 * \li Action: Inserts list of Nomenclature entries.
557 * \li Syntax: nomenclature-print
558 * \li Origin: Ugras, 4 Nov 2006
561 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
564 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
565 * \li Action: Inserts Note on the current cursor postion,
566 move selection inside the inset.
567 * \li Syntax: note-insert [<TYPE>]
568 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
571 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
573 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
574 * \li Action: Moves the cursor to the begining of next Note inset.
575 * \li Syntax: note-next
578 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
580 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
581 * \li Action: Inserts phantom on the current cursor postion,
582 move selection inside the inset.
583 * \li Syntax: phantom-insert [<TYPE>]
584 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
585 * \li Origin: uwestoehr, 30 Jan 2009
588 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
590 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
591 * \li Action: Inserts a line break or new line.
592 * \li Syntax: newline-insert [<ARG>]
593 * \li Params: <ARG>: <newline|linebreak> default: newline
594 * \li Origin: JSpitzm, 25 Mar 2008
597 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
599 * \var lyx::FuncCode lyx::LFUN_ESCAPE
600 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
601 Inside math mode jumps out of the math inset.
603 * \li Origin: Lgb, 17 May 2001
606 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
608 * \var lyx::FuncCode lyx::LFUN_DOWN
609 * \li Action: Moves the cursor one line in downward direction.
613 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
615 * \var lyx::FuncCode lyx::LFUN_UP
616 * \li Action: Moves the cursor one line in upward direction.
620 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
622 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
623 * \li Action: Moves the cursor one line in downward direction adding the current
624 position to the selection.
625 * \li Syntax: down-select
628 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
630 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
631 * \li Action: Moves the cursor one line in upward direction adding the current
632 position to the selection.
633 * \li Syntax: up-select
636 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
638 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
639 * \li Action: Moves the cursor one page in downward direction.
640 * \li Syntax: screen-down
643 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
645 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
646 * \li Action: Moves the cursor one page in upward direction.
647 * \li Syntax: screen-up
650 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
652 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
653 * \li Action: Moves the cursor one screen in downward direction adding the current
654 position to the selection.
655 * \li Syntax: screen-down-select
658 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
660 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
661 * \li Action: Moves the cursor one page in upward direction adding the current
662 position to the selection.
663 * \li Syntax: screen-up-select
666 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
668 * \var lyx::FuncCode lyx::LFUN_SCROLL
669 * \li Action: Scroll the buffer view.
670 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
671 * \li Syntax: scroll <TYPE> <QUANTITY>
672 * \li Params: <TYPE>: line|page\n
673 <QUANTITY>: up|down|<number>
674 * \li Origin: Abdel, Dec 27 2007
677 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
679 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
680 * \li Action: Recenters the screen on the current cursor position.
681 * \li Syntax: screen-recenter
684 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
687 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
688 * \li Action: Repositions the screen such that the cursor is visible.
689 * \li Syntax: screen-show-cursor
690 * \li Origin: vfr, 25 Mar 2009
693 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
696 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
697 * \li Action: Moves the cursor one position logically backwards.
698 * \li Notion: This is not the action which should be bound to the arrow keys,
699 because backwards may be left or right, depending on the
700 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
701 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
702 * \li Syntax: char-backward
705 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
707 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
708 * \li Action: Moves the cursor one position logically backwards, adding
709 traversed position to the selection.
710 * \li Notion: See also #LFUN_CHAR_BACKWARD.
711 * \li Syntax: char-backward-select
714 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
716 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
717 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
718 * \li Syntax: char-delete-backward
721 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
723 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
724 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
725 * \li Syntax: char-delete-forward
728 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
730 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
731 * \li Action: Moves the cursor one position logically forward.
732 * \li Notion: This is not the action which should be bound to the arrow keys,
733 because forward may be left or right, depending on the language.
734 The arrow keys should be bound to #LFUN_CHAR_LEFT or
735 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
736 * \li Syntax: char-forward
739 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
741 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
742 * \li Action: Moves the cursor one position logically forward, adding
743 traversed position to the selection.
744 * \li Notion: See also #LFUN_CHAR_FORWARD.
745 * \li Syntax: char-forward-select
748 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
750 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
751 * \li Action: Moves the cursor one position "to the left".
752 * \li Notion: This is the action which should be taken when the "left" key
753 is pressed. Generally, it moves the cursor one position to the
754 left. However, in Bidi text this become slightly more
755 complicated, and there are different modes of cursor movement.
756 In "visual mode", this moves left, plain and simple. In "logical
757 mode", movement is logically forward in RTL paragraphs, and
758 logically backwards in LTR paragraphs.
759 * \li Syntax: char-left
762 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
764 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
765 * \li Action: Moves the cursor one position "to the left", adding
766 traversed position to the selection.
767 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
768 * \li Syntax: char-left-select
771 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
773 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
774 * \li Action: Moves the cursor one position "to the right".
775 * \li Notion: This is the action which should be taken when the "right" key
776 is pressed. Generally, it moves the cursor one position to the
777 right. However, in Bidi text this become slightly more
778 complicated, and there are different modes of cursor movement.
779 In "visual mode", this moves right, plain and simple. In "logical
780 mode", movement is logically forward in LTR paragraphs, and
781 logically backwards in RTL paragraphs.
782 * \li Syntax: char-right
785 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
787 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
788 * \li Action: Moves the cursor one position "to the right", adding
789 traversed position to the selection.
790 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
791 * \li Syntax: char-right-select
794 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
797 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
798 * \li Action: Moves the cursor to the logically previous beginning of a word.
799 * \li Notion: This is not the action which should be bound to the arrow keys,
800 because backwards may be left or right, depending on the
801 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
802 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
803 * \li Syntax: word-backward
806 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
808 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
809 * \li Action: Moves the cursor to the logically previous beginning of a word,
810 adding the logically traversed text to the selection.
811 * \li Notion: See also #LFUN_WORD_BACKWARD.
812 * \li Syntax: word-backward-select
815 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
817 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
818 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
819 * \li Syntax: word-delete-backward
822 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
824 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
825 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
826 * \li Syntax: word-delete-forward
829 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
831 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
832 * \li Action: Search for a given string in forward direction.
833 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
834 * \li Syntax: word-find-forward [<STRING>]
835 * \li Origin: Etienne, 16 Feb 1998
838 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
840 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
841 * \li Action: Search for a given string in backward direction.
842 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
843 * \li Syntax: word-find-backward [<STRING>]
844 * \li Origin: Etienne, 20 Feb 1998
847 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
849 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
850 * \li Action: Search for next occurence of a string.
851 * \li Syntax: word-find [<DATA>]
852 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
853 If no parameter is given, search with last find-dialog
854 data is used for search (i.e. find-next).
855 * \li Origin: Andre, Jan 7 2004
858 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
860 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
861 * \li Action: Replace a string in the document.
862 * \li Syntax: word-replace [<DATA>]
863 * \li Params: <DATA>: data is of the form
866 <casesensitive> <matchword> <all> <forward>"
867 * \li Origin: Andre, Jan 7 2004
870 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
872 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
873 * \li Action: Search for next occurence of a pattern.
874 * \li Syntax: word-findadv [<DATA>]
875 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
876 If no parameter is given, search with last find-dialog
877 data is used for search (i.e. find-next).
878 * \li Origin: Tommaso, Nov 15 2007
881 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
883 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
884 * \li Action: Moves the cursor to the logically next beginning of a word.
885 * \li Notion: This is not the action which should be bound to the arrow keys,
886 because forward may be left or right, depending on the language.
887 The arrow keys should be bound to #LFUN_WORD_LEFT or
888 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
889 * \li Syntax: word-forward
892 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
894 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
895 * \li Action: Moves the cursor to the logically next beginning of a word,
896 adding the logically traversed text to the selection.
897 * \li Notion: See also #LFUN_WORD_FORWARD.
898 * \li Syntax: word-forward-select
901 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
903 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
904 * \li Action: Moves the cursor to the next beginning of a word "on the left".
905 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
906 "left" key is pressed. Generally, it moves the cursor to the
907 next beginning of a word on the left. However, in Bidi text this
908 become slightly more complicated, and there are different modes
909 of cursor movement. In "visual mode", this moves left, plain and
910 simple. In "logical mode", movement is logically forward in RTL
911 paragraphs, and logically backwards in LTR paragraphs.
912 * \li Syntax: word-left
913 * \li Origin: dov, 28 Oct 2007
916 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
918 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
919 * \li Action: Moves the cursor to the next beginning of a word "on the left",
920 adding *logically* traversed text to the selection.
921 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
922 * \li Syntax: word-left-select
923 * \li Origin: dov, 28 Oct 2007
926 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
928 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
929 * \li Action: Moves the cursor to the next beginning of a word "on the right".
930 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
931 "right" key is pressed. Generally, it moves the cursor to the
932 next beginning of a word on the right. However, in Bidi text
933 this become slightly more complicated, and there are different
934 modes of cursor movement. In "visual mode", this moves right,
935 plain and simple. In "logical mode", movement is logically
936 forward in LTR paragraphs, and logically backwards in RTL
938 * \li Syntax: word-right
939 * \li Origin: dov, 28 Oct 2007
942 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
944 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
945 * \li Action: Moves the cursor to the next beginning of a word "on the right",
946 adding *logically* traversed text to the selection.
947 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
948 * \li Syntax: word-right-select
949 * \li Origin: dov, 28 Oct 2007
952 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
954 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
955 * \li Action: Puts the word where the cursor stands into the selection.
956 * \li Syntax: word-select
957 * \li Origin: Andre, 11 Sep 2002
960 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
962 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
963 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
964 or the letter on the cursor position.
965 * \li Syntax: word-capitalize
968 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
970 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
971 * \li Action: Change the words in the selection or from the cursor position
972 to the end of word to the upper case.
973 * \li Syntax: word-upcase
976 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
978 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
979 * \li Action: Change the words in the selection or from the cursor position
980 to the end of word to the lower case.
981 * \li Syntax: word-lowcase
984 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
986 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
987 * \li Action: Add the word under the cursor to the respective
988 * spell checker dictionary.
989 * \li Syntax: spelling-add [<STRING>] [<LANG>]
990 * \li Params: <WORD>: word to add
991 <LANG>: language name (see file languages)
992 * \li Origin: JSpitzm, 18 Jan 2010
995 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
997 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
998 * \li Action: Let the spell checker ignore the word under the cursor
999 * in the current session for the given language.
1000 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1001 * \li Params: <WORD>: word to ignore
1002 <LANG>: language name (see file languages)
1003 * \li Origin: JSpitzm, 18 Jan 2010
1006 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1008 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1009 * \li Action: Remove the word under the cursor from the respective
1010 * spell checker dictionary.
1011 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1012 * \li Params: <WORD>: word to remove
1013 <LANG>: language name (see file languages)
1014 * \li Origin: SWitt, 28 July 2010
1017 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1019 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1020 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1021 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1022 * \li Params: <STRING>: word to look up
1023 <LANG>: language (see file languages)
1024 * \li Origin: Levon, 20 Jul 2001
1027 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1029 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1030 * \li Action: Move the cursor to the beginning of the document.
1031 * \li Syntax: buffer-begin
1034 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1036 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1037 * \li Action: Move the cursor to the beginning of the document adding the
1038 traversed text to the selection.
1039 * \li Syntax: buffer-begin-select
1042 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1044 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1045 * \li Action: Move the cursor to the end of the document.
1046 * \li Syntax: buffer-end
1049 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1051 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1052 * \li Action: Move the cursor to the end of the document adding the
1053 traversed text to the selection.
1054 * \li Syntax: buffer-end-select
1057 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1060 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1061 * \li Action: Move the cursor to the beginning of the current inset
1062 if it is not already there, or at the beginning of the
1063 enclosing inset otherwise
1064 * \li Syntax: inset-begin
1065 * \li Origin: lasgouttes, 16 Mar 2009
1068 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1070 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1071 * \li Action: Move the cursor to the beginning of the current inset
1072 if it is not already there, or at the beginning of the
1073 enclosing inset otherwise (adding the
1074 traversed text to the selection).
1075 * \li Syntax: inset-begin-select
1076 * \li Origin: lasgouttes, 16 Mar 2009
1079 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1081 * \var lyx::FuncCode lyx::LFUN_INSET_END
1082 * \li Action: Move the cursor to the end of the current inset
1083 if it is not already there, or at the end of the
1084 enclosing inset otherwise
1085 * \li Syntax: inset-end
1086 * \li Origin: lasgouttes, 16 Mar 2009
1089 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1091 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1092 * \li Action: Move the cursor to the end of the current inset
1093 if it is not already there, or at the end of the
1094 enclosing inset otherwise (adding the
1095 traversed text to the selection).
1096 * \li Syntax: inset-end-select
1097 * \li Origin: lasgouttes, 16 Mar 2009
1100 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1103 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1104 * \li Action: Selects all contents of an inset.
1105 * \li Syntax: inset-select-all
1106 * \li Origin: vfr, 22 Aug 2009
1109 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1112 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1113 * \li Action: Selects the whole section.
1114 * \li Notion: The cursor should be in a section heading
1115 before calling this lfun.
1116 * \li Syntax: section-select
1117 * \li Origin: vfr, 05 May 2009
1120 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1123 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1124 * \li Action: Move the cursor to the begining of the (screen) line.
1125 * \li Syntax: line-begin
1128 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1130 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1131 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1132 traversed text to the selection.
1133 * \li Syntax: line-begin-select
1136 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1138 * \var lyx::FuncCode lyx::LFUN_LINE_END
1139 * \li Action: Move the cursor to the end of the (screen) line.
1140 * \li Syntax: line-end
1143 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1145 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1146 * \li Action: Move the cursor to the end of the (screen) line adding the
1147 traversed text to the selection.
1148 * \li Syntax: line-end-select
1151 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1153 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1154 * \li Action: Deletes the letters to the end of the (screen) line or
1155 deletes the selection.
1156 * \li Syntax: line-delete-forward
1159 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1161 * \var lyx::FuncCode lyx::LFUN_COPY
1162 * \li Action: Copies to the clipboard the last edit.
1166 { LFUN_COPY, "copy", ReadOnly, Edit },
1168 * \var lyx::FuncCode lyx::LFUN_CUT
1169 * \li Action: Cuts to the clipboard.
1173 { LFUN_CUT, "cut", Noop, Edit },
1175 * \var lyx::FuncCode lyx::LFUN_PASTE
1176 * \li Action: Pastes material (text or picture) from the active clipboard.
1177 * \li Syntax: paste [<TYPE>|<NUM>]
1178 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1179 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1182 { LFUN_PASTE, "paste", Noop, Edit },
1184 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1185 * \li Action: Pastes text from the active clipboard.
1186 * \li Syntax: clipboard-paste [<ARG>]
1187 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1188 * \li Origin: Georg, 10 Jul 2006
1191 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1193 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1194 * \li Action: Pastes the currently selected text.
1195 * \li Notion: Primary selection mechanism is linux-only thing.
1196 * \li Syntax: primary-selection-paste [<ARG>]
1197 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1200 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1202 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1203 * \li Action: Pastes the the internal selection text in permanent selection.
1204 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
1205 command-alternatives selection-paste ; primary-selection-paste paragraph).
1206 * \li Syntax: selection-paste
1207 * \li Origin: lasgouttes, 14 Jan 2009
1210 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1212 * \var lyx::FuncCode lyx::LFUN_UNDO
1213 * \li Action: Undoes the last edit.
1217 { LFUN_UNDO, "undo", ReadOnly, Edit },
1219 * \var lyx::FuncCode lyx::LFUN_REDO
1220 * \li Action: Redoes the last thing undone.
1224 { LFUN_REDO, "redo", ReadOnly, Edit },
1226 * \var lyx::FuncCode lyx::LFUN_REPEAT
1227 * \li Action: Repeat the given command.
1228 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1229 * \li Origin: Andre, 27 Oct 2003
1232 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1234 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1235 * \li Action: Transposes the character at the cursor with the one before it.
1236 * \li Syntax: chars-transpose
1237 * \li Origin: Lgb, 25 Apr 2001
1240 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1243 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1244 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1246 * \li Syntax: depth-decrement
1249 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1251 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1252 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1254 * \li Syntax: depth-increment
1257 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1260 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1261 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1262 * \li Syntax: font-bold
1265 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1268 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1269 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1270 * \li Syntax: font-boldsymbol
1273 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1275 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1276 * \li Action: Toggles the typewriter family font (selection-wise).
1277 * \li Syntax: font-typewriter
1280 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1282 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1283 * \li Action: Toggles underline in the font (selection-wise).
1284 * \li Syntax: font-underline
1287 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1289 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1290 * \li Action: Toggles double underline in the font (selection-wise).
1291 * \li Syntax: font-underunderline
1292 * \li Origin: sanda, 5 May 2009
1295 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1297 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1298 * \li Action: Toggles wavy underline in the font (selection-wise).
1299 * \li Syntax: font-underwave
1300 * \li Origin: sanda, 5 May 2009
1303 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1305 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1306 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1307 * \li Syntax: font-strikeout
1308 * \li Origin: sanda, 3 May 2009
1311 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1313 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1314 * \li Action: Toggles the emphasis font style (selection-wise).
1315 * \li Syntax: font-emph
1318 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1320 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1321 * \li Action: Toggles Noun text style font (selection-wise).
1322 * \li Syntax: font-noun
1325 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1327 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1328 * \li Action: Toggles Roman family font (selection-wise).
1329 * \li Syntax: font-roman
1332 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1334 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1335 * \li Action: Toggles Sans Serif family font (selection-wise).
1336 * \li Syntax: font-sans
1339 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1341 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1342 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1343 * \li Syntax: font-frak
1344 * \li Origin: vermeer, 10 Jan 2002
1347 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1349 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1350 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1351 * \li Syntax: font-ital
1352 * \li Origin: vermeer, 10 Jan 2002
1355 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1357 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1358 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1359 * \li Syntax: font-default
1362 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1364 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1365 * \li Action: Sets font size according to lyx format string.
1366 * \li Syntax: font-size <SIZE>
1367 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1368 largest|huge|giant|increase|decrease|default
1371 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1373 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1374 * \li Action: Toggle user-defined (=last-time used) text style.
1375 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1376 automatically trigerred when using Text Style dialog.
1377 * \li Syntax: textstyle-apply
1378 * \li Origin: leeming, 12 Mar 2003
1381 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1383 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1384 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1385 * \li Syntax: textstyle-update <FONT_INFO>
1386 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1387 size, emph, noun, underbar, number, color, language,
1389 Use lyx -dbg action for exact syntax of text-style
1391 * \li Origin: leeming, 12 Mar 2003
1394 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1396 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1397 * \li Action: Update fonts and its metrics.
1398 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1399 * \li Syntax: screen-font-update
1400 * \li Origin: ARRae, 13 Aug 2000
1403 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1405 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1406 * \li Action: Returns the info about the current font.
1407 * \li Syntax: font-state
1410 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1413 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1414 * \li Action: Inserts citation from loaded citation database.
1415 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1416 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1417 <TEXT_BEFORE>: text which should appear before citation.
1418 * \li Origin: AAS, 97-02-23
1421 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1423 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1424 * \li Action: Adds database, which will be used for bibtex citations.
1425 * \li Notion: Databases are added to the first BibTeX inset
1426 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1427 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1428 * \li Origin: Ale, 30 May 1997
1431 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1433 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1434 * \li Action: Adds database, which will be used for bibtex citations.
1435 * \li Notion: Databases are deleted from the first BibTeX inset
1436 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1437 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1438 * \li Origin: Ale, 30 May 1997
1441 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1444 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1445 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1446 * \li Syntax: layout <LAYOUT>
1447 * \li Params: <LAYOUT>: the layout to use
1450 { LFUN_LAYOUT, "layout", Noop, Layout },
1452 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1453 * \li Action: Launches the paragraph settings dialog.
1454 * \li Syntax: layout-paragraph
1457 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1459 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1460 * \li Action: Launches the tabular settings dialog.
1461 * \li Syntax: layout-tabular
1462 * \li Origin: Jug, 31 Jul 2000
1465 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1467 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1468 * \li Action: Displays list of layout choices.
1469 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1470 dropbox allowing for choice of layout.
1471 * \li Syntax: drop-layouts-choice
1474 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1476 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1477 * \li Action: Clears the module list.
1478 * \li Notion: Clears the list of included modules for the current buffer.
1479 * \li Syntax: layout-modules-clear
1480 * \li Origin: rgh, 25 August 2007
1483 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1485 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1486 * \li Action: Adds a module.
1487 * \li Notion: Adds a module to the list of included modules for the current buffer.
1488 * \li Syntax: layout-module-add <MODULE>
1489 * \li Params: <MODULE>: the module to be added
1490 * \li Origin: rgh, 25 August 2007
1493 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1495 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1496 * \li Action: Reloads layout information.
1497 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1498 recognizing any changes that have been made to layout files on the fly.
1499 This is intended to be used only by layout developers and should not be
1500 used when one is trying to do actual work.
1501 * \li Syntax: layout-reload
1502 * \li Origin: rgh, 3 September 2007
1505 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1507 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1508 * \li Action: Sets the text class for the current buffer.
1509 * \li Syntax: textclass-apply <TEXTCLASS>
1510 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1511 the filename, minus the ".layout" extension.
1514 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1516 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1517 * \li Action: Loads information for a textclass from disk.
1518 * \li Syntax: textclass-load <TEXTCLASS>
1519 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1520 the filename, minus the ".layout" extension.
1523 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1526 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1527 * \li Action: Disable selecting of text-region.
1528 * \li Syntax: mark-off
1531 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1533 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1534 * \li Action: Enable selecting of text-region.
1535 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1536 * \li Syntax: mark-on
1539 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1541 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1542 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1543 * \li Syntax: mark-toggle
1544 * \li Origin: Andre, May 5 2006
1547 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1550 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1551 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1552 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1553 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1554 either a LaTeX name or a valid character.
1555 ( is the default letter.
1556 * \li Sample: math-delim { rangle
1557 * \li Origin: Alejandro, 18 Jun 1996
1560 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1562 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1563 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1564 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1565 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1566 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1567 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1568 * \li Origin: Enrico & Georg, 7 May 2006
1571 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1573 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1574 * \li Action: Creates a new displayed equation in text mode.
1575 Toggles inlined/display formula in math mode.
1576 * \li Syntax: math-display [<ARG>]
1577 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1578 new equation from the text mode.
1579 * \li Origin: Alejandro, 18 Jun 1996
1582 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1584 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1585 * \li Action: Inserts math objects and symbols.
1586 * \li Syntax: math-insert <ARG>
1587 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1588 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1589 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1590 replaced by the current selection (only works if the selection
1591 is in mathed). As an example, if "abc" is selected in mathed,
1592 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1593 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1594 If nothing is selected (or the selection is not in mathed),
1595 math-insert works as expected.
1598 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1600 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1601 * \li Action: Enters subscript expression in math expression.
1602 * \li Syntax: math-subscript
1603 * \li Origin: vermeer, 12 Dec 2001
1606 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1608 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1609 * \li Action: Enters superscript expression in math expression.
1610 * \li Syntax: math-superscript
1611 * \li Origin: vermeer, 12 Dec 2001
1614 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1616 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1617 * \li Action: Toggles the position of the limits from above/below to the right
1618 side an vice versa in integral symbol, a limit, a summation, etc.
1619 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1621 * \li Syntax: math-limits [<STATE>]
1622 * \li Params: <STATE>: limits|nolimits
1625 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1627 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1628 * \li Action: Inserts a math macro definition at the cursor position in the text.
1629 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1630 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1631 <NARGS>: The number of parameters of the macro. Default is 0.
1632 "def": Has no effect anymore, just for compatibility with former LyX versions.
1633 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1636 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1638 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1639 * \li Action: Mutates the type of math inset to the newly selected one.
1640 * \li Syntax: math-mutate <TYPE>
1641 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1642 multline|gather|flalign
1643 * \li Origin: Andre, 23 May 2001
1646 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1648 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1649 * \li Action: Inserts space into math expression.
1650 * \li Notion: Use spacebar after entering this space to change type of space.
1651 * \li Syntax: math-space [<TYPE>] [<LEN>]
1652 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1653 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1654 custom space: hspace \n
1655 "," used by default.\n
1656 Note that ! is equivalent to negthinspace, , = thinspace,
1657 : = medspace, and ; = thickspace.\n
1658 <LEN>: length for custom spaces (hspace)
1659 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1662 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1664 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1665 * \li Action: Inserts a matrix.
1666 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1667 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1668 (b, c or t) (i.e. 1 char) and the horizontal alignments
1669 (l, c or r) (i.e. <COL> chars).
1670 * \li Sample: math-matrix 3 3 bccc
1673 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1675 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1676 * \li Action: Inserts a matrix.
1677 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1678 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1679 that should be created.
1680 * \li Sample: math-ams-matrix 3 3 bmatrix
1683 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1685 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1686 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1687 cursor position), in math mode enters text mode inside math expression.
1688 * \li Notion: If there is some selected text, it puts the text inside created math box.
1689 * \li Syntax: math-mode [on|<ARG>]
1690 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1691 "on": allow only entering of math mode from text mode.
1692 * \li Origin: Alejandro, 4 Jun 1996
1695 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1697 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1698 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1699 cursor position). Used by the advanced search dialog.
1700 * \li Notion: If there is any selected text, then it is moved inside the created
1702 * \li Syntax: regexp-mode [<ARG>]
1703 * \li Params: <ARG>: eventual argument (regular expression).
1704 * \li Origin: Tommaso, 4 Oct 2008
1707 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1709 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1710 * \li Action: Toggles numbering of the current formula line.
1711 * \li Notion: Must be in display formula mode.
1712 * \li Syntax: math-number-line-toggle
1713 * \li Origin: Alejandro, 18 Jun 1996
1716 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1718 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1719 * \li Action: Toggles numbering/labeling of the current formula.
1720 * \li Notion: Must be in display formula mode.
1721 * \li Syntax: math-number-toggle
1722 * \li Origin: Alejandro, 4 Jun 1996
1725 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1727 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1728 * \li Action: Calls external program and passes the current expression/equation
1729 as an argument for the calculation in the format appropriate to the
1731 * \li Notion: Selection can be used to determine the input for the external program.
1732 * \li Syntax: math-extern <LANG> [<COMMAND>]
1733 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1734 where "script" stands fot the external script (normalized
1735 expression will be passed)
1736 * \li Origin: Andre, 24 Apr 2001
1737 * \li Sample: math-extern maple simplify
1740 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1742 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1743 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1744 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1745 * \li Syntax: math-size <STYLE>
1746 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1747 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1750 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1752 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1753 * \li Action: Changes the text style used in math.
1754 * \li Syntax: math-font-style <STYLE>
1755 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
1756 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
1757 * \li Origin: vfr, 9 jan 2009
1760 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1762 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1763 * \li Action: Unfold a Math Macro.
1764 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1766 * \li Syntax: math-macro-unfold
1767 * \li Origin: sts, 06 January 2008
1770 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1772 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1773 * \li Action: Fold a Math Macro.
1774 * \li Notion: Fold the Math Macro the cursor is in if it was
1775 unfolded, i.e. displayed as \foo before.
1776 * \li Syntax: math-macro-fold
1777 * \li Origin: sts, 06 January 2008
1780 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1782 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1783 * \li Action: Add a parameter.
1784 * \li Notion: Add a parameter to a Math Macro.
1785 * \li Params: <NUM>: The number of the parameter behind which the new one
1786 will be added (1 for the first, i.e. use 0 for add a
1787 parameter at the left), defaults to the last one.
1788 * \li Syntax: math-macro-add-param <NUM>
1789 * \li Origin: sts, 06 January 2008
1792 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1794 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1795 * \li Action: Remove the last parameter.
1796 * \li Notion: Remove the last parameter of a Math Macro and
1797 remove its value in all instances of the macro
1799 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1800 the first), defaults to the last one.
1801 * \li Syntax: math-macro-remove-param <NUM>
1802 * \li Origin: sts, 06 January 2008
1805 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1807 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1808 * \li Action: Append a greedy parameter.
1809 * \li Notion: Append a greedy parameter to a Math Macro which
1810 eats the following mathed cell in every instance of
1811 the macro in the buffer.
1812 * \li Syntax: math-macro-append-greedy-param
1813 * \li Origin: sts, 06 January 2008
1816 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1818 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1819 * \li Action: Remove a greedy parameter.
1820 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1821 out the values of it in every instance of the macro
1822 in the buffer. If it is an optional parameter the [valud]
1824 * \li Syntax: math-macro-remove-greedy-param
1825 * \li Origin: sts, 06 January 2008
1828 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1830 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1831 * \li Action: Make a parameter optional.
1832 * \li Notion: Turn the first non-optional parameter of a Math Macro
1833 into an optional parameter with a default value.
1834 * \li Syntax: math-macro-make-optional
1835 * \li Origin: sts, 06 January 2008
1838 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1840 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1841 * \li Action: Make a parameter non-optional.
1842 * \li Notion: Turn the last optional parameter of a Math Macro
1843 into a non-optional parameter. The default value is
1844 remembered to be reused later if the user changes his mind.
1845 * \li Syntax: math-macro-make-nonoptional
1846 * \li Origin: sts, 06 January 2008
1849 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1851 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1852 * \li Action: Add an optional parameter.
1853 * \li Notion: Insert an optional parameter just behind the
1854 already existing optional parameters.
1855 * \li Syntax: math-macro-add-optional-param
1856 * \li Origin: sts, 06 January 2008
1859 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1861 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1862 * \li Action: Remove the last optional parameter.
1863 * \li Notion: Remove the last optional parameter of a Math Macro and
1864 remove it in all the instances of the macro in the buffer.
1865 * \li Syntax: math-macro-remove-optional-param
1866 * \li Origin: sts, 06 January 2008
1869 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1871 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1872 * \li Action: Add a greedy optional parameter.
1873 * \li Notion: Add a greedy optional parameter which eats the value
1874 from the following cells in mathed which are in the [value]
1876 * \li Syntax: math-macro-add-greedy-optional-param
1877 * \li Origin: sts, 06 January 2008
1880 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1882 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1883 * \li Action: Only active in Math Macro definition.
1884 * \li Notion: Dummy function which is only active in a Math Macro definition.
1885 It's used to toggle the Math Macro toolbar if the cursor moves
1886 into a Math Macro definition.
1887 * \li Syntax: in-mathmacrotemplate
1888 * \li Origin: sts, 06 January 2008
1891 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1894 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1895 * \li Action: Moves the current paragraph downwards in the document.
1896 * \li Syntax: paragraph-move-down
1897 * \li Origin: Edwin, 8 Apr 2006
1900 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1902 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1903 * \li Action: Moves the current paragraph upwards in the document.
1904 * \li Syntax: paragraph-move-up
1905 * \li Origin: Edwin, 8 Apr 2006
1908 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1911 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1912 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1913 in upward direction.
1914 * \li Syntax: paragraph-up
1915 * \li Origin: Asger, 1 Oct 1996
1918 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1920 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1921 * \li Action: Move the cursor and select the text to the next paragraph (or
1922 begining of the current one) in upward direction.
1923 * \li Syntax: paragraph-up-select
1924 * \li Origin: Asger, 1 Oct 1996
1927 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1929 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1930 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1931 in downward direction.
1932 * \li Syntax: paragraph-down
1933 * \li Origin: Asger, 1 Oct 1996
1936 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1938 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1939 * \li Action: Move the cursor and select the text to the next paragraph (or
1940 begining of the current one) in downward direction.
1941 * \li Syntax: paragraph-down-select
1942 * \li Origin: Asger, 1 Oct 1996
1945 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1947 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1948 * \li Action: Jump to a paragraph given by its id number and optionally the
1949 desired position within the paragraph.
1950 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1951 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1952 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1953 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1954 <POSITION_IN_PAR>: desired position within the paragraph
1955 * \li Origin: Dekel, 26 Aug 2000
1958 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
1960 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1961 * \li Action: Breaks the current paragraph at the current location.
1962 * \li Notion: Removes the selection.
1963 * \li Syntax: break-paragraph [<LAYOUT>]
1964 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1965 to default layout) when the cursor is at the end of
1969 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1971 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1972 * \li Action: Change paragraph settings.
1973 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1974 This function only modifies, and does not override, existing settings.
1975 Note that the "leftindent" indent setting is deprecated.
1976 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1977 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
1978 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
1979 <ALIGN>: \align block|left|right|center|default\n
1980 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
1981 * \li Origin: rgh, Aug 15 2007
1984 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1986 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1987 * \li Action: Change paragraph settings.
1988 * \li Notion: Overwrite all nonspecified settings to the default ones.
1989 Use paragraph-params lfun if you don't want to overwrite others settings.
1990 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1991 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1992 * \li Origin: leeming, 30 Mar 2004
1995 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1997 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
1998 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
1999 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2000 by #LFUN_DIALOG_UPDATE.
2001 * \li Origin: leeming, 13 Mar 2003
2004 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2007 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2008 * \li Action: Move the current group in the upward direction in the
2009 structure of the document.
2010 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2011 the whole substructure of the group.
2012 * \li Syntax: outline-up
2013 * \li Origin: Vermeer, 23 Mar 2006
2016 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2018 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2019 * \li Action: Move the current group in the downward direction in the
2020 structure of the document.
2021 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2022 the whole substructure of the group.
2023 * \li Syntax: outline-down
2024 * \li Origin: Vermeer, 23 Mar 2006
2027 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2029 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2030 * \li Action: Moves the current group in the downward direction in the
2031 hierarchy of the document structure.
2032 * \li Notion: Part -> Chapter -> Section -> etc.
2033 * \li Syntax: outline-in
2034 * \li Origin: Vermeer, 23 Mar 2006
2037 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2039 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2040 * \li Action: Moves the current group in the upward direction in the
2041 hierarchy of the document structure.
2042 * \li Notion: Part <- Chapter <- Section <- etc.
2043 * \li Syntax: outline-out
2044 * \li Origin: Vermeer, 23 Mar 2006
2047 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2050 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2051 * \li Action: Edit the inset at cursor with an external application,
2052 if one is attributed.
2053 * \li Syntax: inset-edit [<INSET_PARAMS>]
2054 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2055 Currently only the filename will be considered.
2056 * \li Origin: JSpitzm, 27 Apr 2006
2059 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2062 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2063 * \li Action: Inserts table into the document.
2064 * \li Notion: See #LFUN_INSET_MODIFY for some more details
2065 about tabular modifications.
2066 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2067 * \li Params: In case no arguments are given show insert dialog.
2068 * \li Origin: Jug, 12 Apr 2000
2071 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2074 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2075 * \li Action: Moves the cursor to the previous cell inside the table.
2076 * \li Syntax: cell-backward
2077 * \li Origin: Jug, 22 May 2000
2080 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2082 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2083 * \li Action: Moves the cursor to the next cell inside the table.
2084 * \li Syntax: cell-forward
2087 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2089 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2090 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2091 * \li Syntax: cell-split
2092 * \li Origin: Ale, 15 May 1997
2095 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2098 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2099 * \li Action: Register the document as an file inside version control system.
2100 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2101 of cvs/svn/rcs entries in the document's directory. \n
2102 See LyX Additional Features Manual (Version Control Chapter) for additional
2104 * \li Syntax: vc-register
2105 * \li Origin: Lgb, 1 Jul 1997
2108 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2110 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2111 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2112 * \li Notion: In RCS case this also unlocks the file.
2113 * \li Syntax: vc-check-in
2114 * \li Origin: Lgb, 1 Jul 1997
2117 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2119 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2120 * \li Action: Checks-out the document for edit (and locks it in some cases).
2121 * \li Syntax: vc-check-out
2122 * \li Origin: Lgb, 1 Jul 1997
2125 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2127 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2128 * \li Action: Reverts the document to the last check-in/commit in VCS.
2129 * \li Syntax: vc-revert
2130 * \li Origin: Lgb, 1 Jul 1997
2133 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2135 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2136 * \li Action: Undo last check-in.
2137 * \li Notion: This is currently implemented only for RCS.
2138 * \li Syntax: vc-check-out
2139 * \li Origin: Lgb, 1 Jul 1997
2142 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2144 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2145 * \li Action: Executes external command. This command is intended to support
2146 additional VCS commands.
2147 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2148 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2149 U - dUmmy - no flags \n
2150 D - Doc - need document loaded to proceed \n
2151 I - dIrty - mark document dirty \n
2152 R - Reload - ensure that the document is saved and reload it after command execution \n
2153 M - Message - ask for input string (commit message)\n
2154 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2155 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2156 document(with absolute path)/path/message.
2157 * \li Sample: vc-command DR $$p "svn up"
2158 * \li Origin: sanda, 13 Jan 2009
2161 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2163 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2164 * \li Action: Toggles the locking property of the edited file.
2165 * \li Notion: This is currently implemented only for SVN.
2166 * \li Syntax: vc-locking-toggle
2167 * \li Origin: sanda, 25 Jun 2009
2170 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2172 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2173 * \li Action: Update the local archive directory in which resides
2174 the current document with the remote repository.
2175 * \li Syntax: vc-repo-update
2176 * \li Origin: sanda, 16 Oct 2009
2179 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2181 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2182 * \li Action: Compares two revisions of the same file under version control.
2183 * \li Syntax: vc-compare [<REV1>] [<REV2>]
2184 * \li Params: Revision number either points directly to commit in history
2185 or if negative number -x it points to (last commit - x).\n
2186 In RCS we subtract only in the last number of revision specification.
2187 Special case "0" is reserved for the last committed revision.\n
2188 <REV1>: Older file.\n
2189 <REV2>: Newer file. Used only if REV1 > 0.\n
2190 If no parameter is given, interactive dialog will be shown.
2191 * \li Sample: Compare current document against last commit\n
2193 Compare current document against current revision - 5 commits\n
2195 Compare revisions 120 and 155\n
2197 * \li Origin: sanda, 12 Feb 2010
2200 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2203 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2204 * \li Action: Toggles change tracking to on/off.
2205 * \li Syntax: changes-track
2206 * \li Origin: levon, 1 Oct 2002
2209 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2211 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2212 * \li Action: Toggles showing of change tracking in typesetted output.
2213 * \li Syntax: changes-output
2214 * \li Origin: jspitzm, 21 Jan 2005
2217 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2219 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2220 * \li Action: Moves the cursor to the position of the next change
2221 of the change tracking records.
2222 * \li Syntax: change-next
2223 * \li Origin: schmitt, 4 Oct 2006
2226 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2228 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2229 * \li Action: Moves the cursor to the position of the previous change
2230 of the change tracking records.
2231 * \li Syntax: change-previous
2232 * \li Origin: vfr, 4 Apr 2009
2235 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2237 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2238 * \li Action: Open change tracking dialog for merging and moves the cursor
2239 to the position of the next change.
2240 * \li Syntax: changes-merge
2241 * \li Origin: Levon, 16 Oct 2002
2244 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2246 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2247 * \li Action: Accepts tracked change inside the selection.
2248 * \li Syntax: change-accept
2249 * \li Origin: Levon, 16 Oct 2002
2252 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2254 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2255 * \li Action: Rejects tracked change inside the selection.
2256 * \li Syntax: change-reject
2257 * \li Origin: Levon, 16 Oct 2002
2260 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2262 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2263 * \li Action: Accepts all tracked changes in the document.
2264 * \li Syntax: all-changes-accept
2265 * \li Origin: Levon, 16 Oct 2002
2268 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2270 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2271 * \li Action: Rejects all tracked changes in the document.
2272 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2273 * \li Syntax: all-changes-reject
2274 * \li Origin: Levon, 16 Oct 2002
2277 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2280 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2281 * \li Action: Apply data for an inset.
2282 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2283 be applied. This is either changed to #LFUN_INSET_MODIFY or
2284 #LFUN_INSET_INSERT depending on the context where it is called.
2285 * \li Syntax: inset-apply <ARGS>
2286 * \li Params: See #LFUN_INSET_INSERT .
2289 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2291 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2292 * \li Action: Dissolve the current inset into text.
2293 * \li Syntax: inset-dissolve [<INSET>]
2294 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2295 is dissolved. For example "dissolve" entry in the charstyles
2296 sub-menu should only dissolve the charstyle inset, even if the
2297 cursor is inside several nested insets of different type.\n
2298 For values see #lyx::InsetLayout::lyxtype_ .
2299 * \li Origin: JSpitz, 7 Aug 2006
2302 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2304 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2305 * \li Action: Insert new inset (type given by the parameters).
2306 * \li Syntax: inset-insert <INSET> <ARGS>
2307 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|tabular|\n
2308 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2309 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2310 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2311 where <label name> is the name of the referenced label and
2312 <Format> is one of the following: \n
2313 ref -- <reference> \n
2314 eqref -- (<reference>) \n
2315 pageref -- <page> \n
2316 vpageref -- on <page> \n
2317 vref -- <reference> on <page> \n
2318 formatted -- Formatted reference
2321 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2323 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2324 * \li Action: Modify some properties of an inset.
2325 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2326 floats, graphics, include, index, info, label,
2327 listings, newline, newpage, nomencl, note, phantom,
2328 ref, space, tabular, vspace, wrap insets.
2329 * \li Syntax: inset-modify <INSET> <ARGS>
2330 * \li Syntax: inset-modify changetype <TYPE>
2331 * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
2332 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2333 In case that <INSET> is "tabular" various math-environment features
2334 are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
2335 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2336 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2337 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2338 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2339 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2340 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2341 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
2342 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2343 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2344 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2345 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2346 set-special-column|set-special-multicolumn|set-special-multirow|
2347 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2348 set-interline-space|set-border-lines|tabular-valign-top|
2349 tabular-valign-middle|tabular-valign-bottom|set-tabular-width \n
2350 <ARG>: additional argument for some commands, use debug mode to explore its values.
2351 * \li Sample: inset-modify note Note Comment \n
2352 inset-modify changetype Ovalbox
2355 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2357 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2358 * \li Action: Updates the values inside the dialog from the inset.
2359 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2360 by #LFUN_DIALOG_UPDATE
2361 * \li Params: <DIALOG-NAME>
2362 * \li Origin: leeming, 25 Feb 2003
2365 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2367 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2368 * \li Action: Open the inset's properties dialog.
2369 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2370 float, graphics, href, include, index, index_print, label, line,
2371 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2372 * \li Syntax: inset-settings <INSET>
2373 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2374 graphics|href|include|index|index_print|label|line|
2375 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2378 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2380 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2381 * \li Action: Toggles the collapsable inset at cursor position,
2382 or the inset we are currently in.
2383 * \li Syntax: inset-toggle [<ARG>]
2384 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2385 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2386 assign synchronize the branch-inset with activation status of the branch.
2387 Used for global toggling when changed activation.
2388 * \li Origin: lasgouttes, 19 Jul 2001
2391 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2393 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2394 * \li Action: Apply the given commands on insets of a given name.
2395 * \li Notion: WARNING: use at your own risks; this function gives
2396 you too many ways of shooting yourself in the foot.
2397 A typical example is
2398 inset-forall Note note-insert
2399 which starts an infinite loop. This is mitigated by the fact
2400 that the number of actions is arbitrarily limited to 10000.
2401 Note also that inset-forall does not update metrics between
2402 iterations, which can lead to bugs. This has to be eventually
2404 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2405 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2406 The name is used like for InsetLayout in layout files: "Note"
2407 matches all note insets, while "Note:Note" only matches LyX
2409 * \li Sample: Remove all index insets: \n
2410 inset-forall Index delete-char-forward \n
2411 Close all Notes (also works for a particular branch, for example): \n
2412 inset-forall Note inset-toggle close \n
2413 Transform all yellow notes to comments \n
2414 inset-forall Note:Note inset-modify note Note Comment \n
2415 Try to put LyX in an infinite loop if there is at least a Note: \n
2416 inset-forall Note char-backward
2417 * \li Origin: lasgouttes, 27 Nov 2009
2420 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2423 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2424 * \li Action: Reloads the image if necessary.
2425 * \li Syntax: graphics-reload
2426 * \li Origin: vfr, 10 Aug 2009
2429 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2431 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2432 * \li Action: Set the group for the graphics inset on the cursor position.
2433 * \li Syntax: set-graphics-group [<GROUP>]
2434 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2435 the graphics inset is removed from the current group.
2436 * \li Origin: sanda, 6 May 2008
2439 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2442 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2443 * \li Action: Moves the cursor out of the current slice, going forward.
2444 * \li Notion: Cursor movement within an inset may be different than cursor
2445 movement in the surrounding text. This action should be called
2446 automatically by the cursor movement within the inset, when
2447 movement within the inset has ceased (reached the end of the
2448 last paragraph, for example), in order to move correctly
2449 back into the surrounding text.
2452 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2454 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2455 * \li Action: Moves the cursor out of the current slice, going backwards.
2456 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2459 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2461 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2462 * \li Action: Moves the cursor out of the current slice, going right.
2463 * \li Notion: See also #LFUN_FINISHED_FORWARD
2466 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2468 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2469 * \li Action: Moves the cursor out of the current slice, going left.
2470 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2473 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2476 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2477 * \li Action: Set language from the current cursor position.
2478 * \li Syntax: language <LANG>
2479 * \li Params: <LANG>: Requested language. Look in lib/languages for
2481 * \li Origin: Dekel, 2 Mar 2000
2484 { LFUN_LANGUAGE, "language", Noop, Edit },
2487 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2488 * \li Action: Goto a label.
2489 * \li Syntax: label-goto [<LABEL>]
2490 * \li Params: <LABEL>: Requested label. If no label is given and reference
2491 is on cursor position, Bookmark 0 is saved and
2492 cursor moves to the position of referenced label.
2493 * \li Origin: Ale, 6 Aug 1997
2496 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2498 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2499 * \li Action: Inserts label to text or displayed formula.
2500 * \li Syntax: label-insert [<LABEL>]
2501 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2502 name will be opened.
2505 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2507 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2508 * \li Action: Go to the next label or cross-reference.
2509 * \li Syntax: reference-next
2510 * \li Origin: Dekel, 14 Jan 2001
2513 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2516 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2517 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2518 if necessary. Note that bookmarsk are saved per-session, not
2520 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2521 1. to the paragraph you are currently editing \n
2522 2. to the paragraph from where you are jumping to the last-edited
2523 position (jump-back feature) \n
2524 3. when jumping from crossreference to the requested label by
2526 * \li Syntax: bookmark-goto <NUMBER>
2527 * \li Params: <NUMBER>: the number of the bookmark to restore.
2528 * \li Origin: Dekel, 27 January 2001
2531 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2533 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2534 * \li Action: Save a bookmark.
2535 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2536 must be between 1 and 9, inclusive. Note that bookmarks are
2537 saved per-session, not per file.
2538 * \li Syntax: bookmark-save <NUMBER>
2539 * \li Params: <NUMBER>: the number of the bookmark to save.
2540 * \li Origin: Dekel, 27 January 2001
2543 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2545 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2546 * \li Action: Clears the list of saved bookmarks.
2547 * \li Syntax: bookmark-clear
2548 * \li Origin: bpeng, 31 October 2006
2551 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2554 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2555 * \li Action: Open the given help file according to the language setting.
2556 * \li Syntax: help-open <FILE>[.lyx]
2557 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2558 * \li Origin: Jug, 27 Jun 1999
2561 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2563 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2564 * \li Action: Terminates the current LyX instance.
2565 * \li Notion: Terminates the current LyX instance, asking whether to save
2566 modified documents, etc.
2567 * \li Syntax: lyx-quit
2570 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2572 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2573 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2574 * \li Notion: Skipping "auto" when allowauto is false.
2575 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2576 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
2577 minibuffer|review|view/update|math_panels|vcs|
2578 view-others|update-others
2579 * \li Origin: Edwin, 21 May 2007
2582 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2584 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2585 * \li Action: Opens the menu given by its name.
2586 * \li Syntax: menu-open <NAME>
2587 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2590 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2592 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2593 * \li Action: Various UI visibility-toggling actions.
2594 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2595 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2596 menubar : Toggle visibility of the menubar.\n
2597 scrollbar : Toggle visibility of the scrollbar.\n
2598 frame : Toggle visibility of the frames around editing window.\n
2599 fullscreen : Toggle fullscreen mode. This also covers calling the
2600 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2601 custom tweaks of the toolbars should be used.
2602 * \li Origin: sanda, 9 Feb 2007
2605 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2608 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2609 * \li Action: Creates new empty LyX window.
2610 * \li Notion: Already opened documents from the previous window can be found under View menu.
2611 * \li Syntax: window-new [<GEOMETRY>]
2612 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2613 accepted only on Windows platform.
2614 * \li Origin: Abdel, 21 Oct 2006
2617 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2619 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2620 * \li Action: Closes the current LyX window.
2621 * \li Syntax: window-close
2622 * \li Origin: Abdel, 23 Oct 2006
2625 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2628 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2629 * \li Action: Creates another split view of current buffer.
2630 * \li Notion: All split views act in the same way indpendently.
2631 * \li Syntax: split-view <vertical|horizontal>
2632 * \li Params: horizontal : The work areas are laid out side by side.\n
2633 vertical : The work areas laid out vertically.
2634 * \li Origin: Abdel, 20 Feb 2008
2637 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2640 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2641 * \li Action: Close the current tab group.
2642 * \li Notion: This only closes the work areas, not the buffer themselves.
2643 The still opened buffers can be visualized in another tab group.
2644 * \li Syntax: close-tab-group
2645 * \li Origin: Abdel, 21 Feb 2008
2648 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2650 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2651 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2652 * \li Syntax: dialog-show <NAME> [<DATA>]
2653 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2654 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2655 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2656 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2657 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2658 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2659 <SPECIAL>: latexlog|vclog \n
2660 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2662 * \li Origin: leeming, 17 Jun 2003
2665 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2667 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2668 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2669 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2670 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2671 * \li Params: See #LFUN_DIALOG_SHOW .
2672 * \li Origin: leeming, 25 Feb 2003
2675 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2677 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2678 * \li Action: Updates the dialog values from the inset/paragraph/document.
2679 * \li Syntax: dialog-update <NAME>
2680 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2682 * \li Origin: leeming, 25 Feb 2003
2685 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2687 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2688 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2689 * \li Syntax: dialog-hide <NAME>
2690 * \li Params: See #LFUN_DIALOG_SHOW .
2691 * \li Origin: leeming, 25 Feb 2003
2694 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2696 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2697 * \li Action: Toggles dialog between showed/hidden state.
2698 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2699 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2700 * \li Params: See #LFUN_DIALOG_SHOW .
2701 * \li Origin: JSpitzm, 30 Apr 2007
2704 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2706 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2707 * \li Action: Closes opened connection to opened inset.
2708 * \li Notion: Connection is used for apply functions.
2709 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2710 * \li Origin: leeming, 25 Feb 2003
2713 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2716 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2717 * \li Action: This function is called when mouse button is pressed (inside workarea).
2718 Action depends on the context.
2719 * \li Notion: This is internal LFUN, not to be used by users.
2720 * \li Origin: Andre, 9 Aug 2002
2723 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2725 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2726 * \li Action: This function is called when double click on mouse button is
2727 pressed (inside workarea). Action depends on the context.
2728 * \li Notion: This is internal LFUN, not to be used by users.
2729 * \li Origin: Andre, 9 Aug 2002
2732 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2734 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2735 * \li Action: This function is called when triple click on mouse button is
2736 pressed (inside workarea). Action depends on the context.
2737 * \li Notion: This is internal LFUN, not to be used by users.
2738 * \li Origin: Andre, 9 Aug 2002
2741 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2743 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2744 * \li Action: This function is called when mouse cursor is moving over the text.
2745 Action depends on the context.
2746 * \li Notion: This is internal LFUN, not to be used by users.
2747 * \li Origin: Andre, 9 Aug 2002
2750 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2752 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2753 * \li Action: This function is called when mouse button is released (inside workarea).
2754 Action depends on the context.
2755 * \li Notion: This is internal LFUN, not to be used by users.
2756 * \li Origin: Andre, 9 Aug 2002
2759 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2762 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2763 * \li Action: Turn off the loaded keyboard map.
2764 * \li Syntax: keymap-off
2767 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2769 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2770 * \li Action: Turn on the primary keyboard map.
2771 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2772 keyboard support. They can be still used to maintain uniform keyboard
2773 layout across the various plaforms.\n
2774 The language is to be set in the Preferences dialog.
2775 * \li Syntax: keymap-primary
2778 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2780 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2781 * \li Action: Turn on the secondary keyboard map.
2782 * \li Syntax: keymap-secondary
2785 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2787 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2788 * \li Action: Toggles keyboard maps (first/second/off).
2789 * \li Syntax: keymap-toggle
2790 * \li Origin: leeming, 30 Mar 2004
2793 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2796 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2797 * \li Action: Returns the current layout (that is environment) name
2798 on the cursor position.
2799 * \li Syntax: server-get-layout
2802 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2804 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2805 * \li Action: Returns path and file name of the currently edited document.
2806 * \li Syntax: server-get-filename
2809 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2811 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2812 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
2813 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2814 line from LaTeX compilation. Note that before this function can be used
2815 export to LaTeX output must occur (in order to map the row numbers).
2816 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2817 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
2818 In case this LFUN does not work make sure you are giving correct
2820 If the file is located inside LyX temporary directory it will be
2821 mapped back into the appropriate opened buffer (e.g. for the case
2822 of generated .tex file).\n
2823 .ext: extensions will be automatically replaced by .lyx.\n
2824 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2825 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
2826 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
2827 * \li Origin: Edmar, 23 Dec 1998
2830 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2832 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
2833 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
2834 number in LyX window.
2835 * \li Notion: The external program used for forward search call can be specified in
2836 LyX Output preferences. See Additional manual for details of these
2838 * \li Syntax: forward-search
2839 * \li Origin: sanda, 14 Apr 2010
2842 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
2844 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2845 * \li Action: Sends notify message about the last key-sequence to client.
2846 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2847 See also Debug extensions section in Additional features manual.
2848 * \li Syntax: server-notify
2851 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2853 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2854 * \li Action: Sets the cursor position based on the editing area coordinates
2855 (similar as clicking on that point with left mouse button).
2856 * \li Syntax: server-set-xy <X> <Y>
2859 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2861 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2862 * \li Action: Returns the coordinates of cursor position in the editing area.
2863 * \li Syntax: server-get-xy
2866 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2869 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2870 * \li Action: Generates the code (literate programming).
2871 * \li Notion: Latex file with extension \literate_extension is generated.
2872 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2873 \build_error_filter to process the compilation error messages. \n
2874 In case you want to process your literate file with a script, or some other program,
2875 just insert in your lyxrc file an entry with:\n
2876 \build_command "my_script my_arguments" \n
2877 The \build_error_filter differs from the \literate_error_filter only in that the
2878 former will identify error messages from your compiler.
2879 * \li Syntax: build-program
2882 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2885 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2886 * \li Action: Saves the current buffer to a temporary file.
2887 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2888 is called automatically by LyX, to "autosave" the current buffer.
2889 * \li Syntax: buffer-auto-save
2892 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2894 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2895 * \li Action: Loads the given child document.
2896 * \li Notion: The current document is treated as a parent.
2897 * \li Syntax: buffer-child-open <FILE>
2898 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2899 * \li Origin: Ale, 28 May 1997
2902 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2904 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2905 * \li Action: Runs chktex for the current document.
2906 * \li Syntax: buffer-chktex
2907 * \li Origin: Asger, 30 Oct 1997
2910 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2912 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2913 * \li Action: Toggles compression of the current document on/off.
2914 * \li Syntax: buffer-toggle-compression
2915 * \li Origin: bpeng, 27 Apr 2006
2918 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2920 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
2921 * \li Action: Toggles including of resources for forward/reverse search of the given document.
2922 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
2923 is used for DVI. Custom LaTeX macro can be defined in preferences.
2924 * \li Syntax: buffer-toggle-output-sync
2925 * \li Origin: sanda, 25 May 2010
2928 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
2930 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2931 * \li Action: Closes the current buffer.
2932 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2933 if the buffer has been modified.
2934 * \li Syntax: buffer-close
2937 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2939 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2940 * \li Action: Closes all buffers.
2941 * \li Notion: Closes all buffers, asking whether to save it, etc,
2942 if a buffer has been modified.
2943 * \li Syntax: buffer-close-all
2946 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2948 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2949 * \li Action: Exports the current buffer (document) to the given format.
2950 * \li Syntax: buffer-export <FORMAT>
2951 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2952 can find in Tools->Preferences->File formats->Format.
2953 Usual format you will enter is "pdf2" (pdflatex),
2954 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2955 In case of "custom" you will be asked for a format you
2956 want to start from and for the command that you want to
2957 apply to this format. Internally the control is then passed
2958 to #LFUN_BUFFER_EXPORT_CUSTOM.
2959 * \li Origin: Lgb, 29 Jul 1997
2962 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2964 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2965 * \li Action: Exports the current buffer (document) from the given format using
2966 the given command on it.
2967 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2968 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2969 intermediate file).\n
2970 <COMMAND> this command will be launched on the file. Note that you can
2971 use "$$FName" string to qualify the intermediate file.
2972 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2973 * \li Origin: leeming, 27 Mar 2004
2976 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
2978 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
2979 * \li Action: Prints the current document.
2980 * \li Notion: Many settings can be given via the preferences dialog.
2981 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
2982 * \li Params: <TARGET> is either "printer" or "file".\n
2983 <TARGER-NAME> is either "default" or file name or printer name.\n
2984 <COMMAND> command ensuring the printing job.
2985 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
2986 * \li Origin: leeming, 28 Mar 2004
2989 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
2991 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
2992 * \li Action: Import a given file as a lyx document.
2993 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
2994 defined convertors in preferences. Look into File->Import menu to get
2995 an idea of the currently active import formats.
2996 * \li Syntax: buffer-import <FORMAT> [<FILE>]
2997 * \li Origin: Asger, 24 Jul 1998
3000 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3002 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3003 * \li Action: Creates a new buffer (that is, document).
3004 * \li Notion: Implicit path can be set in Preferences dialog.
3005 * \li Syntax: buffer-new [<FILE>]
3006 * \li Params: <FILE>: filename of created file with absolute path.
3009 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3011 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3012 * \li Action: Creates a new buffer (that is, document) from a template.
3013 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3014 Template will be asked for via Open-dialog.
3015 * \li Syntax: buffer-new-template [<FILE>]
3016 * \li Params: <FILE>: filename of created file with absolute path.
3019 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3021 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3022 * \li Action: Reverts opened document.
3023 * \li Syntax: buffer-reload
3024 * \li Origin: Asger, 2 Feb 1997
3027 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3029 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3030 * \li Action: Display/switch to the given buffer.
3031 * \li Syntax: buffer-switch <BUFFER>
3032 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3033 document which is to be shown.
3036 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3038 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3039 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3040 * \li Notion: This function is not allowed if the file is under version control, since
3041 read-only flag is often used in version control file locking.
3042 * \li Syntax: buffer-toggle-read-only
3043 * \li Origin: Lgb, 27 May 1997
3046 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3048 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3049 * \li Action: Displays current buffer in chosen format.
3050 * \li Notion: Displays the contents of the current buffer in the chosen
3051 format, for example, PDF or DVI. This runs the necessary
3052 converter, calls the defined viewer, and so forth.
3053 * \li Syntax: buffer-view [<FORMAT>]
3054 * \li Params: <FORMAT>: The format to display, where this is one of the
3055 formats defined (in the current GUI) in the
3056 Tools>Preferences>File Formats dialog.
3057 If no format is given, the default format as
3058 specified in the same dialog is used.
3061 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3063 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3064 * \li Action: Exports the current document and put the result into the
3065 temporary directory.
3066 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3067 the output will be rewriten - updated. This is useful in case your viewer
3068 is able to detect such changes (e.g. ghostview for postscript).
3069 * \li Syntax: buffer-update [<FORMAT>]
3070 * \li Params: <FORMAT>: The format to display, where this is one of the
3071 formats defined (in the current GUI) in the
3072 Tools>Preferences>File Formats dialog.
3073 If no format is given, the default format as
3074 specified in the same dialog is used.
3075 * \li Origin: Dekel, 5 Aug 2000
3078 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3081 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3082 * \li Action: Saves the current buffer.
3083 * \li Notion: Saves the current buffer to disk, using the filename that
3084 is already associated with the buffer, asking for one if
3085 none is yet assigned.
3086 * \li Syntax: buffer-write
3089 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3091 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3092 * \li Action: Rename and save current buffer.
3093 * \li Syntax: buffer-write-as <FILENAME>
3094 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3095 is with respect to the original location of the buffer/file.
3098 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3100 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3101 * \li Action: Save all changed documents.
3102 * \li Syntax: buffer-write-all
3103 * \li Origin: rgh, gpothier 6 Aug 2007
3106 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3108 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3109 * \li Action: Switch to the next opened document.
3110 * \li Notion: Note that this does not necessarily mean next in tabbar
3111 (for full list see View menu).
3112 * \li Syntax: buffer-next
3115 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3117 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3118 * \li Action: Switch to the previous opened document.
3119 * \li Syntax: buffer-previous
3122 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3124 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3125 * \li Action: When run from a child document, this updates (exports) document built
3126 from the master buffer, if available.
3127 * \li Syntax: master-buffer-update [<FORMAT>]
3128 * \li Params: <FORMAT>: The format to display, where this is one of the
3129 formats defined (in the current GUI) in the
3130 Tools>Preferences>File Formats dialog.
3131 If no format is given, the default format as
3132 specified in the same dialog is used.
3133 * \li Origin: Tommaso, 20 Sep 2007
3136 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3138 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3139 * \li Action: When run from a child document, this command shows a preview built
3140 from the master buffer, if available.
3141 * \li Syntax: master-buffer-view [<FORMAT>]
3142 * \li Params: <FORMAT>: The format to display, where this is one of the
3143 formats defined (in the current GUI) in the
3144 Tools>Preferences>File Formats dialog.
3145 If no format is given, the default format as
3146 specified in the same dialog is used.
3147 * \li Origin: Tommaso, 20 Sep 2007
3150 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3152 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3153 * \li Action: Set language of the current document.
3154 * \li Syntax: buffer-language <LANG>
3155 * \li Params: <LANG>: language name. See lib/languages for list.
3156 * \li Origin: leeming, 30 Mar 2004
3159 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3161 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3162 * \li Action: Save the current document settings as default.
3163 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3164 * \li Syntax: buffer-save-as-default [<ARGS>]
3165 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3166 you can find in document header of usual .lyx file.
3167 * \li Origin: leeming, 30 Mar 2004
3170 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3172 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3173 * \li Action: Apply the given settings to the current document.
3174 * \li Syntax: buffer-params-apply [<ARGS>]
3175 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3176 you can find in document header of usual .lyx file.
3177 * \li Origin: leeming, 30 Mar 2004
3180 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3183 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3184 * \li Action: Inserts another LyX file.
3185 * \li Syntax: file-insert [<FILE>]
3186 * \li Params: <FILE>: Filename to be inserted.
3189 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3191 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3192 * \li Action: Inserts plain text file.
3193 * \li Syntax: file-insert-plaintext [<FILE>]
3194 * \li Params: <FILE>: Filename to be inserted.
3195 * \li Origin: CFO-G, 19 Nov 1997
3198 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3200 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3201 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3202 * \li Syntax: file-insert-plaintext-para [<FILE>]
3203 * \li Params: <FILE>: Filename to be inserted.
3204 * \li Origin: Levon, 14 Feb 2001
3207 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3209 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3210 * \li Action: Open LyX document.
3211 * \li Syntax: file-open [<FILE>]
3212 * \li Params: <FILE>: Filename to be opened.
3215 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3218 * \var lyx::FuncCode lyx::LFUN_CALL
3219 * \li Action: Executes a command defined in a .def file.
3220 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3221 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3222 where <NAME> is the name of the new command and <LFUN> is the lfun code
3223 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3224 \def_file "FileName" allows to include another .def file. \n
3225 This is particularly useful in connection with toolbar buttons:
3226 Since the name of the button image for this lfun is
3227 lib/images/commands/<NAME>.png this is the way to assign an image
3228 to a complex command-sequence.
3229 * \li Syntax: call <NAME>
3230 * \li Params: <NAME>: Name of the command that must be called.
3231 * \li Origin: broider, 2 Oct 2007
3234 { LFUN_CALL, "call", NoBuffer, System },
3236 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3237 * \li Action: Simulate halting Meta key (Alt key on PCs).
3238 * \li Notion: Used for buffer editation not for GUI control.
3239 * \li Syntax: meta-prefix
3242 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3244 * \var lyx::FuncCode lyx::LFUN_CANCEL
3245 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3246 * \li Syntax: cancel
3249 { LFUN_CANCEL, "cancel", NoBuffer, System },
3252 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3253 * \li Action: Switches the focus to the minibuffer so that the user can type
3254 in there. If necessary, it opens the minibuffer toolbar.
3255 * \li Notion: Usually bound to M-x shortcut.
3256 * \li Syntax: command-execute
3259 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3262 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3263 * \li Action: Return the current key sequence and available options as a string.
3264 * \li Notion: No options are added if no current map exists. \n
3265 This is probably usable only with connection to lyxserver.
3266 * \li Syntax: command-prefix
3269 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3271 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3272 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3273 * \li Syntax: command-sequence <CMDS>
3274 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3275 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3276 * \li Origin: Andre, 11 Nov 1999
3279 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3281 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3282 * \li Action: Runs the first listed command that is enabled.
3283 * \li Notion: This can be used to bind multiple functions to a single key,
3284 and then which one is used will depend upon the context.
3285 * \li Syntax: command-alternatives <CMDS>
3286 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3287 * \li Sample: command-alternatives completion-accept;cell-forward
3288 * \li Origin: rgh, 24 September 2008
3291 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3293 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3294 * \li Action: Shows message in statusbar (for script purposes).
3295 * \li Syntax: message <STRING>
3296 * \li Origin: Lgb, 8 Apr 2001
3299 { LFUN_MESSAGE, "message", NoBuffer, System },
3301 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3302 * \li Action: Set debug output level.
3303 * \li Syntax: debug-level-set <LEVEL>
3304 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3305 of their combination. 0 is equivalent to disabling all debug
3306 events. See lyx -dbg for the current list of debug levels
3308 * \li Origin: sanda, 28 Dec 2009
3311 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3314 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3315 * \li Action: Save user preferences.
3316 * \li Syntax: preferences-save
3317 * \li Origin: Lgb, 27 Nov 1999
3320 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3322 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3323 * \li Action: Reconfigure the automatic settings.
3324 * \li Syntax: reconfigure
3325 * \li Origin: Asger, 14 Feb 1997
3328 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3330 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3331 * \li Action: Apply the given settings to user preferences.
3332 * \li Syntax: lyxrc-apply <SETTINGS>
3333 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3334 to get an idea which commands to use and their syntax.
3335 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3338 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3340 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3341 * \li Action: Determine whether keep cursor inside the editing window regardless
3342 the scrollbar movement.
3343 * \li Syntax: toggle-cursor-follows-scrollbar
3344 * \li Origin: ARRae, 2 Dec 1997
3347 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3349 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3350 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3351 * \li Notion: A new color entry is created if the color is unknown.
3352 Color names can be stored as a part of user settings.
3353 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3354 * \li Origin: SLior, 11 Jun 2000
3357 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3359 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3360 * \li Action: Count the statistics (number of words and characters)
3361 in the document or in the given selection.
3362 * \li Notion: Note that this function gives the number of words/chars written,
3363 not the number of characters which will be typeset.
3364 * \li Syntax: statistics
3365 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3368 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3370 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3371 * \li Action: Show the inline completion at the cursor position.
3372 * \li Syntax: completion-inline
3373 * \li Origin: sts, Feb 19 2008
3376 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3378 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3379 * \li Action: Show the completion popup at the cursor position.
3380 * \li Syntax: completion-popup
3381 * \li Origin: sts, Feb 19 2008
3384 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3386 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3387 * \li Action: Try to complete the word or command at the cursor position.
3388 * \li Syntax: complete
3389 * \li Origin: sts, Feb 19 2008
3392 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3395 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3396 * \li Action: Try to cancel completion, either the popup or the inline completion.
3397 * \li Syntax: completion-cancel
3398 * \li Origin: sts, Sep 07 2008
3401 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3403 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3404 * \li Action: Accept suggested completion.
3405 * \li Syntax: completion-accept
3406 * \li Origin: sanda, Sep 08 2008
3409 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3413 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3414 * \li Action: Add a branch to the buffer's BranchList.
3415 * \li Syntax: branch-add <BRANCH>
3416 * \li Params: <BRANCH>: Name of the branch to add
3417 * \li Origin: spitz, 7 Jul 2009
3420 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3424 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3425 * \li Action: Activate the branch.
3426 * \li Syntax: branch-activate <BRANCH>
3427 * \li Params: <BRANCH>: The branch to activate
3428 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3429 could be used to export a pdf with the answers branch included
3430 without one's having to open LyX and activate the branch manually.
3431 * \li Origin: rgh, 27 May 2008
3434 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3436 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3437 * \li Action: De-activate the branch.
3438 * \li Syntax: branch-deactivate <BRANCH>
3439 * \li Params: <BRANCH>: The branch to deactivate
3440 * \li Origin: rgh, 27 May 2008
3443 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3446 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3447 * \li Action: Rename all branches of a given name in a document.
3448 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3449 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3450 * <NEWNAME>: New name of the branch
3451 * \li Origin: spitz, 9 Jul 2009
3454 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3456 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3457 * \li Action: Create new branch and directly put the branch inset into
3459 * \li Syntax: branch-add-insert [<NAME>]
3460 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3461 * \li Origin: sanda, 10 Jul 2009
3464 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3468 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3469 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3470 * \li Syntax: copy-label-as-reference <LABEL>
3471 * \li Params: <LABEL>: The label to copy (for multi-line math)
3472 * \li Origin: sts, 16 Nov 2008
3475 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference",
3476 ReadOnly | NoUpdate | AtPoint, Edit },
3479 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3480 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3481 * \li Syntax: label-insert-as-reference
3482 * \li Origin: vfr, 7 Apr 2009
3485 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3488 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3489 * \li Action: Increases the zoom of the screen fonts.
3490 * \li Syntax: buffer-zoom-in [<ZOOM>]
3491 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3492 * \li Origin: vfr, 30 Mar 2009
3495 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3498 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3499 * \li Action: Decreases the zoom of the screen fonts.
3500 * \li Syntax: buffer-zoom-out [<ZOOM>]
3501 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3502 * \li Origin: vfr, 30 Mar 2009
3505 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3508 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3509 * \li Action: Copies the inset to the clipboard as a certain type.
3510 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
3511 * \li Syntax: inset-copy-as
3512 * \li Origin: vfr, 18 Apr 2010
3515 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3517 { LFUN_NOACTION, "", Noop, Hidden }
3518 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3521 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3522 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3528 LyXAction::LyXAction()
3534 FuncRequest LyXAction::lookupFunc(string const & func) const
3536 string const func2 = trim(func);
3539 return FuncRequest(LFUN_NOACTION);
3542 string const arg = split(func2, cmd, ' ');
3544 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3546 return fit != lyx_func_map.end()
3547 ? FuncRequest(fit->second, arg)
3548 : FuncRequest(LFUN_UNKNOWN_ACTION);
3552 string const LyXAction::getActionName(FuncCode action) const
3554 InfoMap::const_iterator const it = lyx_info_map.find(action);
3555 return it != lyx_info_map.end() ? it->second.name : string();
3559 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3561 InfoMap::const_iterator const it = lyx_info_map.find(action);
3562 return it != lyx_info_map.end() ? it->second.type : Hidden;
3566 bool LyXAction::funcHasFlag(FuncCode action,
3567 LyXAction::FuncAttribs flag) const
3569 InfoMap::const_iterator ici = lyx_info_map.find(action);
3571 if (ici == lyx_info_map.end()) {
3572 LYXERR0("action: " << action << " is not known.");
3573 LASSERT(false, /**/);
3576 return ici->second.attrib & flag;
3580 LyXAction::const_iterator LyXAction::func_begin() const
3582 return lyx_func_map.begin();
3586 LyXAction::const_iterator LyXAction::func_end() const
3588 return lyx_func_map.end();
3592 LyXErr & operator<<(LyXErr & l, FuncCode code)
3595 l.stream() << lyxaction.getActionName(code);