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, visible, thin, quad, qquad, enspace,
479 enskip, negthinspace, negmedspace, negthickspace, hfill,
480 hfill*, dotfill, hrulefill, hspace, hspace* \n
481 Only in math mode: med and thick.\n
482 <LEN>: length for custom spaces (hspace, hspace* for protected)
483 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
486 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
488 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
489 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
490 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
491 * \li Syntax: href-insert [<TARGET>]
492 * \li Origin: CFO-G, 21 Nov 1997
495 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
497 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
498 * \li Action: Inserts various characters into the document.
499 * \li Syntax: specialchar-insert <CHAR>
500 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
501 end-of-sentence, menu-separator.
502 * \li Origin: JSpitzm, 6 Dec 2007
505 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
507 * \var lyx::FuncCode lyx::LFUN_SCRIPT_INSERT
508 * \li Action: Inserts a subscript or superscript inset.
509 * \li Syntax: script-insert <TYPE>
510 * \li Params: <TYPE>: subscript|superscript
511 * \li Origin: Georg, 23 Nov 2010
514 { LFUN_SCRIPT_INSERT, "script-insert", Noop, Edit },
516 * \var lyx::FuncCode lyx::LFUN_APPENDIX
517 * \li Action: Start (or remove) Appendix on the given cursor position.
518 * \li Syntax: appendix
519 * \li Origin: ettrich, 5 May 1998
522 { LFUN_APPENDIX, "appendix", Noop, Edit },
525 * \var lyx::FuncCode lyx::LFUN_INDEX_INSERT
526 * \li Action: Inserts Index entry.
527 * \li Notion: It automatically takes the word on the cursor position.
528 * \li Syntax: index-insert [<TYPE:Name>]
529 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
530 with an empty argument, the default index is selected.
531 * \li Origin: leeming, 3 Aug 2000
534 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
536 * \var lyx::FuncCode lyx::LFUN_INDEX_PRINT
537 * \li Action: Inserts list of Index entries on a new page.
538 * \li Syntax: index-print [<TYPE:Name>]
539 * \li Params: <TYPE:Name>: name of the index, if multiple indices are defined.
540 with an empty argument, the default index is selected.
541 * \li Origin: Lgb, 27 Feb 1997
544 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
546 * \var lyx::FuncCode lyx::LFUN_IPA_INSERT
547 * \li Action: Inserts an IPA inset.
548 * \li Syntax: ipa-insert
549 * \li Origin: spitz, 05 Mar 2012
552 { LFUN_IPA_INSERT, "ipa-insert", Noop, Edit },
555 * \var lyx::FuncCode lyx::LFUN_NOMENCL_INSERT
556 * \li Action: Inserts Nomenclature entry.
557 * \li Notion: It automatically takes the word on the cursor position if no symbol is given.
558 * \li Syntax: nomencl-insert [<SYMBOL>]
559 * \li Origin: Ugras, 4 Nov 2006
562 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
564 * \var lyx::FuncCode lyx::LFUN_NOMENCLATURE_PRINT
565 * \li Action: Inserts list of Nomenclature entries.
566 * \li Syntax: nomenclature-print
567 * \li Origin: Ugras, 4 Nov 2006
570 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
573 * \var lyx::FuncCode lyx::LFUN_NOTE_INSERT
574 * \li Action: Inserts Note on the current cursor postion,
575 move selection inside the inset.
576 * \li Syntax: note-insert [<TYPE>]
577 * \li Params: <TYPE>: <Note|Greyedout|Comment> default: Note
580 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
582 * \var lyx::FuncCode lyx::LFUN_NOTE_NEXT
583 * \li Action: Moves the cursor to the begining of next Note inset.
584 * \li Syntax: note-next
587 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
589 * \var lyx::FuncCode lyx::LFUN_PHANTOM_INSERT
590 * \li Action: Inserts phantom on the current cursor postion,
591 move selection inside the inset.
592 * \li Syntax: phantom-insert [<TYPE>]
593 * \li Params: <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
594 * \li Origin: uwestoehr, 30 Jan 2009
597 { LFUN_PHANTOM_INSERT, "phantom-insert", Noop, Edit },
599 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
600 * \li Action: Inserts a line break or new line.
601 * \li Syntax: newline-insert [<ARG>]
602 * \li Params: <ARG>: <newline|linebreak> default: newline
603 * \li Origin: JSpitzm, 25 Mar 2008
606 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
608 * \var lyx::FuncCode lyx::LFUN_ESCAPE
609 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
610 Inside math mode jumps out of the math inset.
612 * \li Origin: Lgb, 17 May 2001
615 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
617 * \var lyx::FuncCode lyx::LFUN_DOWN
618 * \li Action: Moves the cursor one line in downward direction.
622 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
624 * \var lyx::FuncCode lyx::LFUN_UP
625 * \li Action: Moves the cursor one line in upward direction.
629 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
631 * \var lyx::FuncCode lyx::LFUN_DOWN_SELECT
632 * \li Action: Moves the cursor one line in downward direction adding the current
633 position to the selection.
634 * \li Syntax: down-select
637 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
639 * \var lyx::FuncCode lyx::LFUN_UP_SELECT
640 * \li Action: Moves the cursor one line in upward direction adding the current
641 position to the selection.
642 * \li Syntax: up-select
645 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
647 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN
648 * \li Action: Moves the cursor one page in downward direction.
649 * \li Syntax: screen-down
652 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
654 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP
655 * \li Action: Moves the cursor one page in upward direction.
656 * \li Syntax: screen-up
659 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
661 * \var lyx::FuncCode lyx::LFUN_SCREEN_DOWN_SELECT
662 * \li Action: Moves the cursor one screen in downward direction adding the current
663 position to the selection.
664 * \li Syntax: screen-down-select
667 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
669 * \var lyx::FuncCode lyx::LFUN_SCREEN_UP_SELECT
670 * \li Action: Moves the cursor one page in upward direction adding the current
671 position to the selection.
672 * \li Syntax: screen-up-select
675 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
677 * \var lyx::FuncCode lyx::LFUN_SCROLL
678 * \li Action: Scroll the buffer view.
679 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
680 * \li Syntax: scroll <TYPE> <QUANTITY>
681 * \li Params: <TYPE>: line|page\n
682 <QUANTITY>: up|down|<number>
683 * \li Origin: Abdel, Dec 27 2007
686 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
688 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
689 * \li Action: Recenters the screen on the current cursor position.
690 * \li Syntax: screen-recenter
693 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
696 * \var lyx::FuncCode lyx::LFUN_SCREEN_SHOW_CURSOR
697 * \li Action: Repositions the screen such that the cursor is visible.
698 * \li Syntax: screen-show-cursor
699 * \li Origin: vfr, 25 Mar 2009
702 { LFUN_SCREEN_SHOW_CURSOR, "screen-show-cursor", ReadOnly, Edit },
705 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
706 * \li Action: Moves the cursor one position logically backwards.
707 * \li Notion: This is not the action which should be bound to the arrow keys,
708 because backwards may be left or right, depending on the
709 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
710 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
711 * \li Syntax: char-backward
714 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
716 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
717 * \li Action: Moves the cursor one position logically backwards, adding
718 traversed position to the selection.
719 * \li Notion: See also #LFUN_CHAR_BACKWARD.
720 * \li Syntax: char-backward-select
723 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
725 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_BACKWARD
726 * \li Action: Deletes one character in the backward direction (usually the "BackSpace" key).
727 * \li Syntax: char-delete-backward
730 { LFUN_CHAR_DELETE_BACKWARD, "char-delete-backward", SingleParUpdate, Edit },
732 * \var lyx::FuncCode lyx::LFUN_CHAR_DELETE_FORWARD
733 * \li Action: Deletes one character in the backward direction (usually the "Delete" key).
734 * \li Syntax: char-delete-forward
737 { LFUN_CHAR_DELETE_FORWARD, "char-delete-forward", SingleParUpdate, Edit },
739 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
740 * \li Action: Moves the cursor one position logically forward.
741 * \li Notion: This is not the action which should be bound to the arrow keys,
742 because forward may be left or right, depending on the language.
743 The arrow keys should be bound to #LFUN_CHAR_LEFT or
744 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
745 * \li Syntax: char-forward
748 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
750 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
751 * \li Action: Moves the cursor one position logically forward, adding
752 traversed position to the selection.
753 * \li Notion: See also #LFUN_CHAR_FORWARD.
754 * \li Syntax: char-forward-select
757 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
759 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
760 * \li Action: Moves the cursor one position "to the left".
761 * \li Notion: This is the action which should be taken when the "left" key
762 is pressed. Generally, it moves the cursor one position to the
763 left. However, in Bidi text this become slightly more
764 complicated, and there are different modes of cursor movement.
765 In "visual mode", this moves left, plain and simple. In "logical
766 mode", movement is logically forward in RTL paragraphs, and
767 logically backwards in LTR paragraphs.
768 * \li Syntax: char-left
771 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
773 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
774 * \li Action: Moves the cursor one position "to the left", adding
775 traversed position to the selection.
776 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
777 * \li Syntax: char-left-select
780 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
782 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
783 * \li Action: Moves the cursor one position "to the right".
784 * \li Notion: This is the action which should be taken when the "right" key
785 is pressed. Generally, it moves the cursor one position to the
786 right. However, in Bidi text this become slightly more
787 complicated, and there are different modes of cursor movement.
788 In "visual mode", this moves right, plain and simple. In "logical
789 mode", movement is logically forward in LTR paragraphs, and
790 logically backwards in RTL paragraphs.
791 * \li Syntax: char-right
794 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
796 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
797 * \li Action: Moves the cursor one position "to the right", adding
798 traversed position to the selection.
799 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
800 * \li Syntax: char-right-select
803 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
806 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
807 * \li Action: Moves the cursor to the logically previous beginning of a word.
808 * \li Notion: This is not the action which should be bound to the arrow keys,
809 because backwards may be left or right, depending on the
810 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
811 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
812 * \li Syntax: word-backward
815 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
817 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
818 * \li Action: Moves the cursor to the logically previous beginning of a word,
819 adding the logically traversed text to the selection.
820 * \li Notion: See also #LFUN_WORD_BACKWARD.
821 * \li Syntax: word-backward-select
824 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
826 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_BACKWARD
827 * \li Action: Deletes characters to the begining of the word (usually the "C+BackSpace" key).
828 * \li Syntax: word-delete-backward
831 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
833 * \var lyx::FuncCode lyx::LFUN_WORD_DELETE_FORWARD
834 * \li Action: Deletes characters to the end of the word (usually the "C+Delete" key).
835 * \li Syntax: word-delete-forward
838 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
840 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
841 * \li Action: Search for a given string in forward direction.
842 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
843 * \li Syntax: word-find-forward [<STRING>]
844 * \li Origin: Etienne, 16 Feb 1998
847 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
849 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
850 * \li Action: Search for a given string in backward direction.
851 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
852 * \li Syntax: word-find-backward [<STRING>]
853 * \li Origin: Etienne, 20 Feb 1998
856 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
858 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
859 * \li Action: Search for next occurence of a string.
860 * \li Syntax: word-find [<DATA>]
861 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
862 If no parameter is given, search with last find-dialog
863 data is used for search (i.e. find-next).
864 * \li Origin: Andre, Jan 7 2004
867 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
869 * \var lyx::FuncCode lyx::LFUN_WORD_REPLACE
870 * \li Action: Replace a string in the document.
871 * \li Syntax: word-replace [<DATA>]
872 * \li Params: <DATA>: data is of the form
875 <casesensitive> <matchword> <all> <forward> <findnext>"
876 * \li Origin: Andre, Jan 7 2004
879 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
881 * \var lyx::FuncCode lyx::LFUN_WORD_FINDADV
882 * \li Action: Search for next occurence of a pattern.
883 * \li Syntax: word-findadv [<DATA>]
884 * \li Params: <DATA>: data encoded from FindAdv dialog (see #lyx::findadv2string()).
885 If no parameter is given, search with last find-dialog
886 data is used for search (i.e. find-next).
887 * \li Origin: Tommaso, Nov 15 2007
890 { LFUN_WORD_FINDADV, "word-findadv", ReadOnly | NoBuffer, Edit },
892 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
893 * \li Action: Moves the cursor to the logically next beginning of a word.
894 * \li Notion: This is not the action which should be bound to the arrow keys,
895 because forward may be left or right, depending on the language.
896 The arrow keys should be bound to #LFUN_WORD_LEFT or
897 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
898 * \li Syntax: word-forward
901 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
903 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
904 * \li Action: Moves the cursor to the logically next beginning of a word,
905 adding the logically traversed text to the selection.
906 * \li Notion: See also #LFUN_WORD_FORWARD.
907 * \li Syntax: word-forward-select
910 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
912 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
913 * \li Action: Moves the cursor to the next beginning of a word "on the left".
914 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
915 "left" key is pressed. Generally, it moves the cursor to the
916 next beginning of a word on the left. However, in Bidi text this
917 become slightly more complicated, and there are different modes
918 of cursor movement. In "visual mode", this moves left, plain and
919 simple. In "logical mode", movement is logically forward in RTL
920 paragraphs, and logically backwards in LTR paragraphs.
921 * \li Syntax: word-left
922 * \li Origin: dov, 28 Oct 2007
925 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
927 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
928 * \li Action: Moves the cursor to the next beginning of a word "on the left",
929 adding *logically* traversed text to the selection.
930 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
931 * \li Syntax: word-left-select
932 * \li Origin: dov, 28 Oct 2007
935 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
937 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
938 * \li Action: Moves the cursor to the next beginning of a word "on the right".
939 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
940 "right" key is pressed. Generally, it moves the cursor to the
941 next beginning of a word on the right. However, in Bidi text
942 this become slightly more complicated, and there are different
943 modes of cursor movement. In "visual mode", this moves right,
944 plain and simple. In "logical mode", movement is logically
945 forward in LTR paragraphs, and logically backwards in RTL
947 * \li Syntax: word-right
948 * \li Origin: dov, 28 Oct 2007
951 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
953 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
954 * \li Action: Moves the cursor to the next beginning of a word "on the right",
955 adding *logically* traversed text to the selection.
956 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
957 * \li Syntax: word-right-select
958 * \li Origin: dov, 28 Oct 2007
961 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
963 * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
964 * \li Action: Puts the word where the cursor stands into the selection.
965 * \li Syntax: word-select
966 * \li Origin: Andre, 11 Sep 2002
969 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
971 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
972 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
973 or the letter on the cursor position.
974 * \li Syntax: word-capitalize
977 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
979 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
980 * \li Action: Change the words in the selection or from the cursor position
981 to the end of word to the upper case.
982 * \li Syntax: word-upcase
985 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
987 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
988 * \li Action: Change the words in the selection or from the cursor position
989 to the end of word to the lower case.
990 * \li Syntax: word-lowcase
993 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
995 * \var lyx::FuncCode lyx::LFUN_SPELLING_ADD
996 * \li Action: Add the word under the cursor to the respective
997 * spell checker dictionary.
998 * \li Syntax: spelling-add [<STRING>] [<LANG>]
999 * \li Params: <WORD>: word to add
1000 <LANG>: language name (see file languages)
1001 * \li Origin: JSpitzm, 18 Jan 2010
1004 { LFUN_SPELLING_ADD, "spelling-add", ReadOnly, Edit },
1006 * \var lyx::FuncCode lyx::LFUN_SPELLING_IGNORE
1007 * \li Action: Let the spell checker ignore the word under the cursor
1008 * in the current session for the given language.
1009 * \li Syntax: spelling-ignore [<WORD>] [<LANG>]
1010 * \li Params: <WORD>: word to ignore
1011 <LANG>: language name (see file languages)
1012 * \li Origin: JSpitzm, 18 Jan 2010
1015 { LFUN_SPELLING_IGNORE, "spelling-ignore", ReadOnly, Edit },
1017 * \var lyx::FuncCode lyx::LFUN_SPELLING_REMOVE
1018 * \li Action: Remove the word under the cursor from the respective
1019 * spell checker dictionary.
1020 * \li Syntax: spelling-remove [<STRING>] [<LANG>]
1021 * \li Params: <WORD>: word to remove
1022 <LANG>: language name (see file languages)
1023 * \li Origin: SWitt, 28 July 2010
1026 { LFUN_SPELLING_REMOVE, "spelling-remove", ReadOnly, Edit },
1028 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
1029 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
1030 * \li Syntax: thesaurus-entry [<STRING>] [lang=<LANG>]
1031 * \li Params: <STRING>: word to look up
1032 <LANG>: language (see file languages)
1033 * \li Origin: Levon, 20 Jul 2001
1036 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
1038 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN
1039 * \li Action: Move the cursor to the beginning of the document.
1040 * \li Syntax: buffer-begin
1043 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
1045 * \var lyx::FuncCode lyx::LFUN_BUFFER_BEGIN_SELECT
1046 * \li Action: Move the cursor to the beginning of the document adding the
1047 traversed text to the selection.
1048 * \li Syntax: buffer-begin-select
1051 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
1053 * \var lyx::FuncCode lyx::LFUN_BUFFER_END
1054 * \li Action: Move the cursor to the end of the document.
1055 * \li Syntax: buffer-end
1058 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
1060 * \var lyx::FuncCode lyx::LFUN_BUFFER_END_SELECT
1061 * \li Action: Move the cursor to the end of the document adding the
1062 traversed text to the selection.
1063 * \li Syntax: buffer-end-select
1066 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
1069 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN
1070 * \li Action: Move the cursor to the beginning of the current inset
1071 if it is not already there, or at the beginning of the
1072 enclosing inset otherwise
1073 * \li Syntax: inset-begin
1074 * \li Origin: lasgouttes, 16 Mar 2009
1077 { LFUN_INSET_BEGIN, "inset-begin", ReadOnly, Edit },
1079 * \var lyx::FuncCode lyx::LFUN_INSET_BEGIN_SELECT
1080 * \li Action: Move the cursor to the beginning of the current inset
1081 if it is not already there, or at the beginning of the
1082 enclosing inset otherwise (adding the
1083 traversed text to the selection).
1084 * \li Syntax: inset-begin-select
1085 * \li Origin: lasgouttes, 16 Mar 2009
1088 { LFUN_INSET_BEGIN_SELECT, "inset-begin-select", ReadOnly, Edit },
1090 * \var lyx::FuncCode lyx::LFUN_INSET_END
1091 * \li Action: Move the cursor to the end of the current inset
1092 if it is not already there, or at the end of the
1093 enclosing inset otherwise
1094 * \li Syntax: inset-end
1095 * \li Origin: lasgouttes, 16 Mar 2009
1098 { LFUN_INSET_END, "inset-end", ReadOnly, Edit },
1100 * \var lyx::FuncCode lyx::LFUN_INSET_END_SELECT
1101 * \li Action: Move the cursor to the end of the current inset
1102 if it is not already there, or at the end of the
1103 enclosing inset otherwise (adding the
1104 traversed text to the selection).
1105 * \li Syntax: inset-end-select
1106 * \li Origin: lasgouttes, 16 Mar 2009
1109 { LFUN_INSET_END_SELECT, "inset-end-select", ReadOnly, Edit },
1112 * \var lyx::FuncCode lyx::LFUN_INSET_SELECT_ALL
1113 * \li Action: Selects all contents of an inset.
1114 * \li Syntax: inset-select-all
1115 * \li Origin: vfr, 22 Aug 2009
1118 { LFUN_INSET_SELECT_ALL, "inset-select-all", ReadOnly, Edit },
1121 * \var lyx::FuncCode lyx::LFUN_SECTION_SELECT
1122 * \li Action: Selects the whole section.
1123 * \li Notion: The cursor should be in a section heading
1124 before calling this lfun.
1125 * \li Syntax: section-select
1126 * \li Origin: vfr, 05 May 2009
1129 { LFUN_SECTION_SELECT, "section-select", ReadOnly, Edit },
1132 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN
1133 * \li Action: Move the cursor to the begining of the (screen) line.
1134 * \li Syntax: line-begin
1137 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
1139 * \var lyx::FuncCode lyx::LFUN_LINE_BEGIN_SELECT
1140 * \li Action: Move the cursor to the beginning of the (screen) line adding the
1141 traversed text to the selection.
1142 * \li Syntax: line-begin-select
1145 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
1147 * \var lyx::FuncCode lyx::LFUN_LINE_END
1148 * \li Action: Move the cursor to the end of the (screen) line.
1149 * \li Syntax: line-end
1152 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
1154 * \var lyx::FuncCode lyx::LFUN_LINE_END_SELECT
1155 * \li Action: Move the cursor to the end of the (screen) line adding the
1156 traversed text to the selection.
1157 * \li Syntax: line-end-select
1160 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
1162 * \var lyx::FuncCode lyx::LFUN_LINE_DELETE
1163 * \li Action: Deletes the letters to the end of the (screen) line or
1164 deletes the selection.
1165 * \li Syntax: line-delete-forward
1168 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
1170 * \var lyx::FuncCode lyx::LFUN_COPY
1171 * \li Action: Copies to the clipboard the last edit.
1175 { LFUN_COPY, "copy", ReadOnly, Edit },
1177 * \var lyx::FuncCode lyx::LFUN_CUT
1178 * \li Action: Cuts to the clipboard.
1182 { LFUN_CUT, "cut", Noop, Edit },
1184 * \var lyx::FuncCode lyx::LFUN_PASTE
1185 * \li Action: Pastes material (text or picture) from the active clipboard.
1186 * \li Syntax: paste [<TYPE>|<NUM>]
1187 * \li Params: <TYPE>: emf|pdf|png|jpeg|linkback|wmf \n
1188 <NUM>: number of the selection in the internal clipboard stack to be pasted.
1191 { LFUN_PASTE, "paste", Noop, Edit },
1193 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE
1194 * \li Action: Pastes text from the active clipboard.
1195 * \li Syntax: clipboard-paste [<ARG>]
1196 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1197 * \li Origin: Georg, 10 Jul 2006
1200 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
1202 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
1203 * \li Action: Pastes the currently selected text.
1204 * \li Notion: Primary selection mechanism is linux-only thing.
1205 * \li Syntax: primary-selection-paste [<ARG>]
1206 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1209 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
1211 * \var lyx::FuncCode lyx::LFUN_SELECTION_PASTE
1212 * \li Action: Pastes the internal selection text in permanent selection.
1213 * \li Notion: Created in order to have middle mouse button pasting correct (bound to
1214 command-alternatives selection-paste ; primary-selection-paste paragraph).
1215 * \li Syntax: selection-paste
1216 * \li Origin: lasgouttes, 14 Jan 2009
1219 { LFUN_SELECTION_PASTE, "selection-paste", Noop, Edit },
1221 * \var lyx::FuncCode lyx::LFUN_CLIPBOARD_PASTE_SIMPLE
1222 * \li Action: Pastes simple unformatted text from the active clipboard.
1223 * \li Syntax: clipboard-paste-simple [<ARG>]
1224 * \li Params: <ARG>: "paragraph" will cause pasting as one paragraph, i.e. "Join lines".
1227 { LFUN_CLIPBOARD_PASTE_SIMPLE, "clipboard-paste-simple", Noop, Edit },
1229 * \var lyx::FuncCode lyx::LFUN_UNDO
1230 * \li Action: Undoes the last edit.
1234 { LFUN_UNDO, "undo", ReadOnly, Edit },
1236 * \var lyx::FuncCode lyx::LFUN_REDO
1237 * \li Action: Redoes the last thing undone.
1241 { LFUN_REDO, "redo", ReadOnly, Edit },
1243 * \var lyx::FuncCode lyx::LFUN_REPEAT
1244 * \li Action: Repeat the given command.
1245 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
1246 * \li Origin: Andre, 27 Oct 2003
1249 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
1251 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
1252 * \li Action: Transposes the character at the cursor with the one before it.
1253 * \li Syntax: chars-transpose
1254 * \li Origin: Lgb, 25 Apr 2001
1257 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
1260 * \var lyx::FuncCode lyx::LFUN_DEPTH_DECREMENT
1261 * \li Action: Decrease the nesting depth of the (selected) paragraph(s)
1263 * \li Syntax: depth-decrement
1266 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
1268 * \var lyx::FuncCode lyx::LFUN_DEPTH_INCREMENT
1269 * \li Action: Increase the nesting depth of the (selected) paragraph(s)
1271 * \li Syntax: depth-increment
1274 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
1277 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
1278 * \li Action: Toggles the bold font (selection-wise) using mathbf in math.
1279 * \li Syntax: font-bold
1282 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
1285 * \var lyx::FuncCode lyx::LFUN_FONT_BOLDSYMBOL
1286 * \li Action: Toggles the bold font (selection-wise) using boldsymbol in math.
1287 * \li Syntax: font-boldsymbol
1290 { LFUN_FONT_BOLDSYMBOL, "font-boldsymbol", Noop, Layout },
1292 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
1293 * \li Action: Toggles the typewriter family font (selection-wise).
1294 * \li Syntax: font-typewriter
1297 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
1299 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
1300 * \li Action: Toggles underline in the font (selection-wise).
1301 * \li Syntax: font-underline
1304 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
1306 * \var lyx::FuncCode lyx::LFUN_FONT_UULINE
1307 * \li Action: Toggles double underline in the font (selection-wise).
1308 * \li Syntax: font-underunderline
1309 * \li Origin: sanda, 5 May 2009
1312 { LFUN_FONT_UULINE, "font-underunderline", Noop, Layout },
1314 * \var lyx::FuncCode lyx::LFUN_FONT_UWAVE
1315 * \li Action: Toggles wavy underline in the font (selection-wise).
1316 * \li Syntax: font-underwave
1317 * \li Origin: sanda, 5 May 2009
1320 { LFUN_FONT_UWAVE, "font-underwave", Noop, Layout },
1322 * \var lyx::FuncCode lyx::LFUN_FONT_STRIKEOUT
1323 * \li Action: Toggles strikeout (strike-through) in the font (selection-wise).
1324 * \li Syntax: font-strikeout
1325 * \li Origin: sanda, 3 May 2009
1328 { LFUN_FONT_STRIKEOUT, "font-strikeout", Noop, Layout },
1330 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
1331 * \li Action: Toggles the emphasis font style (selection-wise).
1332 * \li Syntax: font-emph
1335 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
1337 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
1338 * \li Action: Toggles Noun text style font (selection-wise).
1339 * \li Syntax: font-noun
1342 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
1344 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
1345 * \li Action: Toggles Roman family font (selection-wise).
1346 * \li Syntax: font-roman
1349 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
1351 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
1352 * \li Action: Toggles Sans Serif family font (selection-wise).
1353 * \li Syntax: font-sans
1356 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
1358 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
1359 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1360 * \li Syntax: font-frak
1361 * \li Origin: vermeer, 10 Jan 2002
1364 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1366 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1367 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1368 * \li Syntax: font-ital
1369 * \li Origin: vermeer, 10 Jan 2002
1372 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1374 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1375 * \li Action: Reverts the settings of the font to the default values (selection-wise).
1376 * \li Syntax: font-default
1379 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1381 * \var lyx::FuncCode lyx::LFUN_FONT_SIZE
1382 * \li Action: Sets font size according to lyx format string.
1383 * \li Syntax: font-size <SIZE>
1384 * \li Params: <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|\n
1385 largest|huge|giant|increase|decrease|default
1388 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1390 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_APPLY
1391 * \li Action: Toggle user-defined (=last-time used) text style.
1392 * \li Notion: This style is set via #LFUN_TEXTSTYLE_UPDATE, which is
1393 automatically trigerred when using Text Style dialog.
1394 * \li Syntax: textstyle-apply
1395 * \li Origin: leeming, 12 Mar 2003
1398 { LFUN_TEXTSTYLE_APPLY, "textstyle-apply", Noop, Layout },
1400 * \var lyx::FuncCode lyx::LFUN_TEXTSTYLE_UPDATE
1401 * \li Action: Apply text style and update the settings to be used by #LFUN_TEXTSTYLE_APPLY.
1402 * \li Syntax: textstyle-update <FONT_INFO>
1403 * \li Params: <FONT_INFO>: specifies font atributes, e.g. family, series, shape,
1404 size, emph, noun, underbar, number, color, language,
1406 Use lyx -dbg action for exact syntax of text-style
1408 * \li Origin: leeming, 12 Mar 2003
1411 { LFUN_TEXTSTYLE_UPDATE, "textstyle-update", Noop, Layout },
1413 * \var lyx::FuncCode lyx::LFUN_SCREEN_FONT_UPDATE
1414 * \li Action: Update fonts and its metrics.
1415 * \li Notion: Automatically called after zoom, dpi, font names, or norm change.
1416 * \li Syntax: screen-font-update
1417 * \li Origin: ARRae, 13 Aug 2000
1420 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1422 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1423 * \li Action: Returns the info about the current font.
1424 * \li Syntax: font-state
1427 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1430 * \var lyx::FuncCode lyx::LFUN_CITATION_INSERT
1431 * \li Action: Inserts citation from loaded citation database.
1432 * \li Syntax: citation-insert [<KEY>[|<TEXT_BEFORE>]]
1433 * \li Params: <KEY>: Citation (shortcut listed in available citations). \n
1434 <TEXT_BEFORE>: text which should appear before citation.
1435 * \li Origin: AAS, 97-02-23
1438 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1440 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_ADD
1441 * \li Action: Adds database, which will be used for bibtex citations.
1442 * \li Notion: Databases are added to the first BibTeX inset
1443 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1444 * \li Syntax: bibtex-database-add <DATABASE-NAME>
1445 * \li Origin: Ale, 30 May 1997
1448 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1450 * \var lyx::FuncCode lyx::LFUN_BIBTEX_DATABASE_DEL
1451 * \li Action: Adds database, which will be used for bibtex citations.
1452 * \li Notion: Databases are deleted from the first BibTeX inset
1453 (Inset->List/TOC->BibTeX bibliography) found from the cursor postion.
1454 * \li Syntax: bibtex-database-del <DATABASE-NAME>
1455 * \li Origin: Ale, 30 May 1997
1458 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1461 * \var lyx::FuncCode lyx::LFUN_LAYOUT
1462 * \li Action: Sets the layout (that is, environment) for the current paragraph.
1463 * \li Syntax: layout <LAYOUT>
1464 * \li Params: <LAYOUT>: the layout to use
1467 { LFUN_LAYOUT, "layout", Noop, Layout },
1469 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1470 * \li Action: Launches the paragraph settings dialog.
1471 * \li Syntax: layout-paragraph
1474 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1476 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1477 * \li Action: Launches the tabular settings dialog.
1478 * \li Syntax: layout-tabular
1479 * \li Origin: Jug, 31 Jul 2000
1482 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1484 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1485 * \li Action: Displays list of layout choices.
1486 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1487 dropbox allowing for choice of layout.
1488 * \li Syntax: drop-layouts-choice
1491 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1493 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1494 * \li Action: Clears the module list.
1495 * \li Notion: Clears the list of included modules for the current buffer.
1496 * \li Syntax: layout-modules-clear
1497 * \li Origin: rgh, 25 August 2007
1500 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", NoInternal, Layout },
1502 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1503 * \li Action: Adds a module.
1504 * \li Notion: Adds a module to the list of included modules for the current buffer.
1505 * \li Syntax: layout-module-add <MODULE>
1506 * \li Params: <MODULE>: the module to be added
1507 * \li Origin: rgh, 25 August 2007
1510 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", NoInternal, Layout },
1512 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1513 * \li Action: Reloads layout information.
1514 * \li Notion: Reloads all layout information for the current buffer from disk, thus
1515 recognizing any changes that have been made to layout files on the fly.
1516 This is intended to be used only by layout developers and should not be
1517 used when one is trying to do actual work.
1518 * \li Syntax: layout-reload
1519 * \li Origin: rgh, 3 September 2007
1522 { LFUN_LAYOUT_RELOAD, "layout-reload", NoInternal, Layout },
1524 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1525 * \li Action: Sets the text class for the current buffer.
1526 * \li Syntax: textclass-apply <TEXTCLASS>
1527 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1528 the filename, minus the ".layout" extension.
1531 { LFUN_TEXTCLASS_APPLY, "textclass-apply", NoInternal, Layout },
1533 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1534 * \li Action: Loads information for a textclass from disk.
1535 * \li Syntax: textclass-load <TEXTCLASS>
1536 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1537 the filename, minus the ".layout" extension.
1540 { LFUN_TEXTCLASS_LOAD, "textclass-load", NoInternal, Layout },
1543 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1544 * \li Action: Disable selecting of text-region.
1545 * \li Syntax: mark-off
1548 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1550 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1551 * \li Action: Enable selecting of text-region.
1552 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1553 * \li Syntax: mark-on
1556 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1558 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1559 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1560 * \li Syntax: mark-toggle
1561 * \li Origin: Andre, May 5 2006
1564 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1567 * \var lyx::FuncCode lyx::LFUN_MATH_DELIM
1568 * \li Action: Inserts math delimiters (e.g. parentheses, brackets) enclosing expression.
1569 * \li Syntax: math-delim [<LEFT>] [<RIGHT>]
1570 * \li Params: <LEFT/RIGHT>: Delimiters to be used. Each delimiter can be specified by
1571 either a LaTeX name or a valid character.
1572 ( is the default letter.
1573 * \li Sample: math-delim { rangle
1574 * \li Origin: Alejandro, 18 Jun 1996
1577 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1579 * \var lyx::FuncCode lyx::LFUN_MATH_BIGDELIM
1580 * \li Action: Inserts math fixed size delimiters (e.g. parentheses, brackets) enclosing expression.
1581 * \li Syntax: math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
1582 * \li Params: <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r \n
1583 <L/RDELIM>: TeX code for delimiter. See Delimiter dialog for delimiters to be used.
1584 * \li Sample: math-bigdelim "Bigl" "\Downarrow" "Bigr" "\}"
1585 * \li Origin: Enrico & Georg, 7 May 2006
1588 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1590 * \var lyx::FuncCode lyx::LFUN_MATH_DISPLAY
1591 * \li Action: Creates a new displayed equation in text mode.
1592 Toggles inlined/display formula in math mode.
1593 * \li Syntax: math-display [<ARG>]
1594 * \li Params: <ARG>: this argument will be passed to #LFUN_MATH_INSERT when creating
1595 new equation from the text mode.
1596 * \li Origin: Alejandro, 18 Jun 1996
1599 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1601 * \var lyx::FuncCode lyx::LFUN_MATH_INSERT
1602 * \li Action: Inserts math objects and symbols.
1603 * \li Syntax: math-insert <ARG>
1604 * \li Params: <ARG>: Symbol or LaTeX code to be inserted.
1605 * \li Notion: When <ARG> is a _single_ math inset with more than one cell
1606 (such as "x_y^z" or "\frac{x}{y}"), the content of cell(0) is
1607 replaced by the current selection (only works if the selection
1608 is in mathed). As an example, if "abc" is selected in mathed,
1609 "math-insert \frac{x}{y}" replaces "abc" with "\frac{abc}{y}",
1610 and "math-insert x_y^z" replaces "abc" with "abc_y^z".
1611 If nothing is selected (or the selection is not in mathed),
1612 math-insert works as expected.
1615 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1617 * \var lyx::FuncCode lyx::LFUN_MATH_SUBSCRIPT
1618 * \li Action: Enters subscript expression in math expression.
1619 * \li Syntax: math-subscript
1620 * \li Origin: vermeer, 12 Dec 2001
1623 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1625 * \var lyx::FuncCode lyx::LFUN_MATH_SUPERSCRIPT
1626 * \li Action: Enters superscript expression in math expression.
1627 * \li Syntax: math-superscript
1628 * \li Origin: vermeer, 12 Dec 2001
1631 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1633 * \var lyx::FuncCode lyx::LFUN_MATH_LIMITS
1634 * \li Action: Toggles the position of the limits from above/below to the right
1635 side an vice versa in integral symbol, a limit, a summation, etc.
1636 * \li Notion: Put the cursor before the symbol with the limits and then invoke
1638 * \li Syntax: math-limits [<STATE>]
1639 * \li Params: <STATE>: limits|nolimits
1642 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1644 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO
1645 * \li Action: Inserts a math macro definition at the cursor position in the text.
1646 * \li Syntax: math-macro <NAME> [<NARGS>] [def]
1647 * \li Params: <NAME>: The name of the macro, e.g. "mymacro".\n
1648 <NARGS>: The number of parameters of the macro. Default is 0.
1649 "def": Has no effect anymore, just for compatibility with former LyX versions.
1650 * \li Origin: ale, 10 May 1997; sts, 21 Dec 2007
1653 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1655 * \var lyx::FuncCode lyx::LFUN_MATH_MUTATE
1656 * \li Action: Mutates the type of math inset to the newly selected one.
1657 * \li Syntax: math-mutate <TYPE>
1658 * \li Params: <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
1659 multline|gather|flalign
1660 * \li Origin: Andre, 23 May 2001
1663 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1665 * \var lyx::FuncCode lyx::LFUN_MATH_SPACE
1666 * \li Action: Inserts space into math expression.
1667 * \li Notion: Use spacebar after entering this space to change type of space.
1668 * \li Syntax: math-space [<TYPE>] [<LEN>]
1669 * \li Params: <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace \n
1670 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad \n
1671 custom space: hspace \n
1672 "," used by default.\n
1673 Note that ! is equivalent to negthinspace, , = thinspace,
1674 : = medspace, and ; = thickspace.\n
1675 <LEN>: length for custom spaces (hspace)
1676 * \li Origin: Andre, 25 Jul 2001; sanda, 16 Jun 2008
1679 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1681 * \var lyx::FuncCode lyx::LFUN_MATH_MATRIX
1682 * \li Action: Inserts a matrix.
1683 * \li Syntax: math-matrix <COLS> <ROWS> [<ALIGN>]
1684 * \li Params: <ALIGN>: Alignment is a word composed of the vertical alignment
1685 (b, c or t) (i.e. 1 char) and the horizontal alignments
1686 (l, c or r) (i.e. <COL> chars).
1687 * \li Sample: math-matrix 3 3 bccc
1690 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1692 * \var lyx::FuncCode lyx::LFUN_MATH_AMS_MATRIX
1693 * \li Action: Inserts a matrix.
1694 * \li Syntax: math-matrix <COLS> <ROWS> [<DECORATION>]
1695 * \li Params: <DECORATION>: Decoration determines the LaTeX name of the matrix
1696 that should be created.
1697 * \li Sample: math-ams-matrix 3 3 bmatrix
1700 { LFUN_MATH_AMS_MATRIX, "math-ams-matrix", Noop, Math },
1702 * \var lyx::FuncCode lyx::LFUN_MATH_MODE
1703 * \li Action: In text mode enters math mode (i.e. puts math insets on the current
1704 cursor position), in math mode enters text mode inside math expression.
1705 * \li Notion: If there is some selected text, it puts the text inside created math box.
1706 * \li Syntax: math-mode [on|<ARG>]
1707 * \li Params: <ARG>: eventual argument (LaTeX code) is passed to #LFUN_MATH_INSERT .\n
1708 "on": allow only entering of math mode from text mode.
1709 * \li Origin: Alejandro, 4 Jun 1996
1712 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1714 * \var lyx::FuncCode lyx::LFUN_REGEXP_MODE
1715 * \li Action: Enters regexp mode (i.e., puts regexp insets on the current
1716 cursor position). Used by the advanced search dialog.
1717 * \li Notion: If there is any selected text, then it is moved inside the created
1719 * \li Syntax: regexp-mode [<ARG>]
1720 * \li Params: <ARG>: eventual argument (regular expression).
1721 * \li Origin: Tommaso, 4 Oct 2008
1724 { LFUN_REGEXP_MODE, "regexp-mode", Noop, Math },
1726 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1727 * \li Action: Toggles numbering of the current formula line.
1728 * \li Notion: Must be in display formula mode.
1729 * \li Syntax: math-number-line-toggle
1730 * \li Origin: Alejandro, 18 Jun 1996
1733 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1735 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1736 * \li Action: Toggles numbering/labeling of the current formula.
1737 * \li Notion: Must be in display formula mode.
1738 * \li Syntax: math-number-toggle
1739 * \li Origin: Alejandro, 4 Jun 1996
1742 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1744 * \var lyx::FuncCode lyx::LFUN_MATH_EXTERN
1745 * \li Action: Calls external program and passes the current expression/equation
1746 as an argument for the calculation in the format appropriate to the
1748 * \li Notion: Selection can be used to determine the input for the external program.
1749 * \li Syntax: math-extern <LANG> [<COMMAND>]
1750 * \li Params: <LANG>: octave|maxima|maple|mathematica|script \n
1751 where "script" stands fot the external script (normalized
1752 expression will be passed)
1753 * \li Origin: Andre, 24 Apr 2001
1754 * \li Sample: math-extern maple simplify
1757 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1759 * \var lyx::FuncCode lyx::LFUN_MATH_SIZE
1760 * \li Action: Changes arbitrarily the size used by math fonts inside a context.
1761 * \li Notion: Provides an interface to the LaTeX math mode font size commands.
1762 * \li Syntax: math-size <STYLE>
1763 * \li Params: <STYLE>: \displaystyle|\textstyle|\scriptstyle|\scriptscriptstyle
1764 * \li Origin: Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
1767 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1769 * \var lyx::FuncCode lyx::LFUN_MATH_FONT_STYLE
1770 * \li Action: Changes the text style used in math.
1771 * \li Syntax: math-font-style <STYLE>
1772 * \li Params: <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf|textnormal\n
1773 |textrm|textsf|texttt|textbf|textmd|textit|textsc|textsl|textup
1774 * \li Origin: vfr, 9 jan 2009
1777 { LFUN_MATH_FONT_STYLE, "math-font-style", Noop, Math },
1779 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1780 * \li Action: Unfold a Math Macro.
1781 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1783 * \li Syntax: math-macro-unfold
1784 * \li Origin: sts, 06 January 2008
1787 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1789 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1790 * \li Action: Fold a Math Macro.
1791 * \li Notion: Fold the Math Macro the cursor is in if it was
1792 unfolded, i.e. displayed as \foo before.
1793 * \li Syntax: math-macro-fold
1794 * \li Origin: sts, 06 January 2008
1797 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1799 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1800 * \li Action: Add a parameter.
1801 * \li Notion: Add a parameter to a Math Macro.
1802 * \li Params: <NUM>: The number of the parameter behind which the new one
1803 will be added (1 for the first, i.e. use 0 for add a
1804 parameter at the left), defaults to the last one.
1805 * \li Syntax: math-macro-add-param <NUM>
1806 * \li Origin: sts, 06 January 2008
1809 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1811 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1812 * \li Action: Remove the last parameter.
1813 * \li Notion: Remove the last parameter of a Math Macro and
1814 remove its value in all instances of the macro
1816 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1817 the first), defaults to the last one.
1818 * \li Syntax: math-macro-remove-param <NUM>
1819 * \li Origin: sts, 06 January 2008
1822 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1824 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1825 * \li Action: Append a greedy parameter.
1826 * \li Notion: Append a greedy parameter to a Math Macro which
1827 eats the following mathed cell in every instance of
1828 the macro in the buffer.
1829 * \li Syntax: math-macro-append-greedy-param
1830 * \li Origin: sts, 06 January 2008
1833 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1835 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1836 * \li Action: Remove a greedy parameter.
1837 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1838 out the values of it in every instance of the macro
1839 in the buffer. If it is an optional parameter the [valud]
1841 * \li Syntax: math-macro-remove-greedy-param
1842 * \li Origin: sts, 06 January 2008
1845 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1847 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1848 * \li Action: Make a parameter optional.
1849 * \li Notion: Turn the first non-optional parameter of a Math Macro
1850 into an optional parameter with a default value.
1851 * \li Syntax: math-macro-make-optional
1852 * \li Origin: sts, 06 January 2008
1855 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1857 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1858 * \li Action: Make a parameter non-optional.
1859 * \li Notion: Turn the last optional parameter of a Math Macro
1860 into a non-optional parameter. The default value is
1861 remembered to be reused later if the user changes his mind.
1862 * \li Syntax: math-macro-make-nonoptional
1863 * \li Origin: sts, 06 January 2008
1866 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1868 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1869 * \li Action: Add an optional parameter.
1870 * \li Notion: Insert an optional parameter just behind the
1871 already existing optional parameters.
1872 * \li Syntax: math-macro-add-optional-param
1873 * \li Origin: sts, 06 January 2008
1876 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1878 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1879 * \li Action: Remove the last optional parameter.
1880 * \li Notion: Remove the last optional parameter of a Math Macro and
1881 remove it in all the instances of the macro in the buffer.
1882 * \li Syntax: math-macro-remove-optional-param
1883 * \li Origin: sts, 06 January 2008
1886 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1888 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1889 * \li Action: Add a greedy optional parameter.
1890 * \li Notion: Add a greedy optional parameter which eats the value
1891 from the following cells in mathed which are in the [value]
1893 * \li Syntax: math-macro-add-greedy-optional-param
1894 * \li Origin: sts, 06 January 2008
1897 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1899 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1900 * \li Action: Only active in Math Macro definition.
1901 * \li Notion: Dummy function which is only active in a Math Macro definition.
1902 It's used to toggle the Math Macro toolbar if the cursor moves
1903 into a Math Macro definition.
1904 * \li Syntax: in-mathmacrotemplate
1905 * \li Origin: sts, 06 January 2008
1908 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1911 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1912 * \li Action: Moves the current paragraph downwards in the document.
1913 * \li Syntax: paragraph-move-down
1914 * \li Origin: Edwin, 8 Apr 2006
1917 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1919 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1920 * \li Action: Moves the current paragraph upwards in the document.
1921 * \li Notion: Movement through the document will possibly break the paragraph-depth
1922 (e.g. itemize structure).
1923 * \li Syntax: paragraph-move-up
1924 * \li Origin: Edwin, 8 Apr 2006
1927 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1930 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1931 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1932 in upward direction.
1933 * \li Syntax: paragraph-up
1934 * \li Origin: Asger, 1 Oct 1996
1937 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1939 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1940 * \li Action: Move the cursor and select the text to the next paragraph (or
1941 begining of the current one) in upward direction.
1942 * \li Syntax: paragraph-up-select
1943 * \li Origin: Asger, 1 Oct 1996
1946 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1948 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1949 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1950 in downward direction.
1951 * \li Syntax: paragraph-down
1952 * \li Origin: Asger, 1 Oct 1996
1955 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1957 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1958 * \li Action: Move the cursor and select the text to the next paragraph (or
1959 begining of the current one) in downward direction.
1960 * \li Syntax: paragraph-down-select
1961 * \li Origin: Asger, 1 Oct 1996
1964 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1966 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1967 * \li Action: Jump to a paragraph given by its id number and optionally the
1968 desired position within the paragraph.
1969 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1970 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1971 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1972 * \li Params: <PAR_ID_NUMBER>: paragraph id \n
1973 <POSITION_IN_PAR>: desired position within the paragraph
1974 * \li Origin: Dekel, 26 Aug 2000
1977 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly | NoInternal, Edit },
1979 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1980 * \li Action: Breaks the current paragraph at the current location.
1981 * \li Notion: Removes the selection.
1982 * \li Syntax: break-paragraph [<LAYOUT>]
1983 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1984 to default layout) when the cursor is at the end of
1988 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1990 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1991 * \li Action: Change paragraph settings.
1992 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1993 This function only modifies, and does not override, existing settings.
1994 Note that the "leftindent" indent setting is deprecated.
1995 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1996 * \li Params: <INDENT>: \noindent|\indent|\indent-toggle|\leftindent LENGTH\n
1997 <SPACING>: \paragraph_spacing default|single|onehalf|double|other SIZE \n
1998 <ALIGN>: \align block|left|right|center|default\n
1999 <OTHERS>: \labelwidthstring WIDTH|\start_of_appendix
2000 * \li Origin: rgh, Aug 15 2007
2003 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
2005 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
2006 * \li Action: Change paragraph settings.
2007 * \li Notion: Overwrite all nonspecified settings to the default ones.
2008 Use paragraph-params lfun if you don't want to overwrite others settings.
2009 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
2010 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
2011 * \li Origin: leeming, 30 Mar 2004
2014 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
2016 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UPDATE
2017 * \li Action: Updates the values inside the paragraph dialog from the paragraph.
2018 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2019 by #LFUN_DIALOG_UPDATE.
2020 * \li Origin: leeming, 13 Mar 2003
2023 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
2026 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
2027 * \li Action: Move the current group in the upward direction in the
2028 structure of the document.
2029 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2030 the whole substructure of the group.
2031 * \li Syntax: outline-up
2032 * \li Origin: Vermeer, 23 Mar 2006
2035 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
2037 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
2038 * \li Action: Move the current group in the downward direction in the
2039 structure of the document.
2040 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
2041 the whole substructure of the group.
2042 * \li Syntax: outline-down
2043 * \li Origin: Vermeer, 23 Mar 2006
2046 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
2048 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
2049 * \li Action: Moves the current group in the downward direction in the
2050 hierarchy of the document structure.
2051 * \li Notion: Part -> Chapter -> Section -> etc.
2052 * \li Syntax: outline-in
2053 * \li Origin: Vermeer, 23 Mar 2006
2056 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
2058 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
2059 * \li Action: Moves the current group in the upward direction in the
2060 hierarchy of the document structure.
2061 * \li Notion: Part <- Chapter <- Section <- etc.
2062 * \li Syntax: outline-out
2063 * \li Origin: Vermeer, 23 Mar 2006
2066 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
2069 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
2070 * \li Action: Edit the inset at cursor with an external application,
2071 if one is attributed.
2072 * \li Syntax: inset-edit [<INSET_PARAMS>]
2073 * \li Params: <INSET_PARAMS>: Parameters for the inset. \n
2074 Currently only the filename will be considered.
2075 * \li Origin: JSpitzm, 27 Apr 2006
2078 { LFUN_INSET_EDIT, "inset-edit", ReadOnly | AtPoint, Edit },
2081 * \var lyx::FuncCode lyx::LFUN_TABULAR_INSERT
2082 * \li Action: Inserts table into the document.
2083 * \li Notion: See #LFUN_INSET_MODIFY for some more details
2084 about tabular modifications.
2085 * \li Syntax: tabular-insert [<ROWS> <COLUMNS>]
2086 * \li Params: In case no arguments are given show insert dialog.
2087 * \li Origin: Jug, 12 Apr 2000
2090 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
2093 * \var lyx::FuncCode lyx::LFUN_CELL_BACKWARD
2094 * \li Action: Moves the cursor to the previous cell inside the table.
2095 * \li Syntax: cell-backward
2096 * \li Origin: Jug, 22 May 2000
2099 { LFUN_CELL_BACKWARD, "cell-backward", ReadOnly | NoUpdate, Edit },
2101 * \var lyx::FuncCode lyx::LFUN_CELL_FORWARD
2102 * \li Action: Moves the cursor to the next cell inside the table.
2103 * \li Syntax: cell-forward
2106 { LFUN_CELL_FORWARD, "cell-forward", ReadOnly | NoUpdate, Edit },
2108 * \var lyx::FuncCode lyx::LFUN_CELL_SPLIT
2109 * \li Action: Splits cell and shifts right part to the next cell (inside the math grid).
2110 * \li Syntax: cell-split
2111 * \li Origin: Ale, 15 May 1997
2114 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
2117 * \var lyx::FuncCode lyx::LFUN_VC_REGISTER
2118 * \li Action: Register the document as an file inside version control system.
2119 * \li Notion: File is registered inside cvs, svn or rcs repository acording to the existence
2120 of cvs/svn/rcs entries in the document's directory. \n
2121 See LyX Additional Features Manual (Version Control Chapter) for additional
2123 * \li Syntax: vc-register
2124 * \li Origin: Lgb, 1 Jul 1997
2127 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
2129 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_IN
2130 * \li Action: Checks-in/commits the changes of the registered file to the repository.
2131 * \li Notion: In RCS case this also unlocks the file.
2132 * \li Syntax: vc-check-in
2133 * \li Origin: Lgb, 1 Jul 1997
2136 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
2138 * \var lyx::FuncCode lyx::LFUN_VC_CHECK_OUT
2139 * \li Action: Checks-out the document for edit (and locks it in some cases).
2140 * \li Syntax: vc-check-out
2141 * \li Origin: Lgb, 1 Jul 1997
2144 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
2146 * \var lyx::FuncCode lyx::LFUN_VC_REVERT
2147 * \li Action: Reverts the document to the last check-in/commit in VCS.
2148 * \li Syntax: vc-revert
2149 * \li Origin: Lgb, 1 Jul 1997
2152 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
2154 * \var lyx::FuncCode lyx::LFUN_VC_UNDO_LAST
2155 * \li Action: Undo last check-in.
2156 * \li Notion: This is currently implemented only for RCS.
2157 * \li Syntax: vc-check-out
2158 * \li Origin: Lgb, 1 Jul 1997
2161 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
2163 * \var lyx::FuncCode lyx::LFUN_VC_COMMAND
2164 * \li Action: Executes external command. This command is intended to support
2165 additional VCS commands.
2166 * \li Syntax: vc-command <FLAG> <PATH> <COMMAND>
2167 * \li Params: <FLAG>: Flags for the command can be combined together.\n
2168 U - dUmmy - no flags \n
2169 D - Doc - need document loaded to proceed \n
2170 I - dIrty - mark document dirty \n
2171 R - Reload - ensure that the document is saved and reload it after command execution \n
2172 M - Message - ask for input string (commit message)\n
2173 <PATH>: path where to start. $$p will be replaced by the current document path.\n
2174 <COMMAND>: command to execute. $$i/$$p/$$m will be replaced by the current
2175 document(with absolute path)/path/message.
2176 * \li Sample: vc-command DR $$p "svn up"
2177 * \li Origin: sanda, 13 Jan 2009
2180 { LFUN_VC_COMMAND, "vc-command", NoBuffer | ReadOnly, System },
2182 * \var lyx::FuncCode lyx::LFUN_VC_LOCKING_TOGGLE
2183 * \li Action: Toggles the locking property of the edited file.
2184 * \li Notion: This is currently implemented only for SVN.
2185 * \li Syntax: vc-locking-toggle
2186 * \li Origin: sanda, 25 Jun 2009
2189 { LFUN_VC_LOCKING_TOGGLE, "vc-locking-toggle", ReadOnly, System },
2191 * \var lyx::FuncCode lyx::LFUN_VC_REPO_UPDATE
2192 * \li Action: Update the local archive directory in which resides
2193 the current document with the remote repository.
2194 * \li Syntax: vc-repo-update
2195 * \li Origin: sanda, 16 Oct 2009
2198 { LFUN_VC_REPO_UPDATE, "vc-repo-update", ReadOnly, System },
2200 * \var lyx::FuncCode lyx::LFUN_VC_COMPARE
2201 * \li Action: Compares two revisions of the same file under version control.
2202 * \li Syntax: vc-compare [<REV1>] [<REV2>]
2203 * \li Params: Revision number either points directly to commit in history
2204 or if negative number -x it points to (last commit - x).\n
2205 In RCS we subtract only in the last number of revision specification.
2206 Special case "0" is reserved for the last committed revision.\n
2207 <REV1>: Older file.\n
2208 <REV2>: Newer file. Used only if REV1 > 0.\n
2209 If no parameter is given, interactive dialog will be shown.
2210 * \li Sample: Compare current document against last commit\n
2212 Compare current document against current revision - 5 commits\n
2214 Compare revisions 120 and 155\n
2216 * \li Origin: sanda, 12 Feb 2010
2219 { LFUN_VC_COMPARE, "vc-compare", ReadOnly, System },
2222 * \var lyx::FuncCode lyx::LFUN_CHANGES_TRACK
2223 * \li Action: Toggles change tracking to on/off.
2224 * \li Syntax: changes-track
2225 * \li Origin: levon, 1 Oct 2002
2228 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
2230 * \var lyx::FuncCode lyx::LFUN_CHANGES_OUTPUT
2231 * \li Action: Toggles showing of change tracking in typesetted output.
2232 * \li Syntax: changes-output
2233 * \li Origin: jspitzm, 21 Jan 2005
2236 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
2238 * \var lyx::FuncCode lyx::LFUN_CHANGE_NEXT
2239 * \li Action: Moves the cursor to the position of the next change
2240 of the change tracking records.
2241 * \li Syntax: change-next
2242 * \li Origin: schmitt, 4 Oct 2006
2245 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
2247 * \var lyx::FuncCode lyx::LFUN_CHANGE_PREVIOUS
2248 * \li Action: Moves the cursor to the position of the previous change
2249 of the change tracking records.
2250 * \li Syntax: change-previous
2251 * \li Origin: vfr, 4 Apr 2009
2254 { LFUN_CHANGE_PREVIOUS, "change-previous", ReadOnly, Edit },
2256 * \var lyx::FuncCode lyx::LFUN_CHANGES_MERGE
2257 * \li Action: Open change tracking dialog for merging and moves the cursor
2258 to the position of the next change.
2259 * \li Syntax: changes-merge
2260 * \li Origin: Levon, 16 Oct 2002
2263 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
2265 * \var lyx::FuncCode lyx::LFUN_CHANGE_ACCEPT
2266 * \li Action: Accepts tracked change inside the selection.
2267 * \li Syntax: change-accept
2268 * \li Origin: Levon, 16 Oct 2002
2271 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
2273 * \var lyx::FuncCode lyx::LFUN_CHANGE_REJECT
2274 * \li Action: Rejects tracked change inside the selection.
2275 * \li Syntax: change-reject
2276 * \li Origin: Levon, 16 Oct 2002
2279 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
2281 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_ACCEPT
2282 * \li Action: Accepts all tracked changes in the document.
2283 * \li Syntax: all-changes-accept
2284 * \li Origin: Levon, 16 Oct 2002
2287 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
2289 * \var lyx::FuncCode lyx::LFUN_ALL_CHANGES_REJECT
2290 * \li Action: Rejects all tracked changes in the document.
2291 * \li Notion: Reject does not work recursively; the user may have to repeat the operation.
2292 * \li Syntax: all-changes-reject
2293 * \li Origin: Levon, 16 Oct 2002
2296 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
2299 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
2300 * \li Action: Apply data for an inset.
2301 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
2302 be applied. This is either changed to #LFUN_INSET_MODIFY or
2303 #LFUN_INSET_INSERT depending on the context where it is called.
2304 * \li Syntax: inset-apply <ARGS>
2305 * \li Params: See #LFUN_INSET_INSERT .
2308 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
2310 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
2311 * \li Action: Dissolve the current inset into text.
2312 * \li Syntax: inset-dissolve [<INSET>]
2313 * \li Params: <INSET>: this can be used to make sure the right kind of inset
2314 is dissolved. For example "dissolve" entry in the charstyles
2315 sub-menu should only dissolve the charstyle inset, even if the
2316 cursor is inside several nested insets of different type.\n
2317 For values see #lyx::InsetLayout::lyxtype_ .
2318 * \li Origin: JSpitz, 7 Aug 2006
2321 { LFUN_INSET_DISSOLVE, "inset-dissolve", AtPoint, Edit },
2323 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
2324 * \li Action: Insert new inset (type given by the parameters).
2325 * \li Syntax: inset-insert <INSET> <ARGS>
2326 * \li Params: <INSET>: <bibitem|bibtex|citation|ert|listings|external|graphics|tabular|\n
2327 hyperlink|include|index|label|line|nomencl|vspace|ref|toc|script>\n
2328 <ARGS>: depends on the given inset. Use "lyx -dbg action" to explore.
2329 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
2330 where <label name> is the name of the referenced label and
2331 <Format> is one of the following: \n
2332 ref -- <reference> \n
2333 eqref -- (<reference>) \n
2334 pageref -- <page> \n
2335 vpageref -- on <page> \n
2336 vref -- <reference> on <page> \n
2337 formatted -- Formatted reference
2340 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
2342 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
2343 * \li Action: Modify some properties of an inset.
2344 * \li Notion: Used for bibitem, bibtex, box, branch, command, ert, external,
2345 floats, graphics, include, index, info, label,
2346 listings, newline, newpage, nomencl, note, phantom,
2347 ref, space, tabular, vspace, wrap insets.
2348 * \li Syntax: inset-modify <INSET> <ARGS>
2349 * \li Syntax: inset-modify changetype <TYPE>
2350 * \li Syntax: inset-modify tabular <FEATURE> [<ARG>]
2351 * \li Params: Generally see #LFUN_INSET_INSERT for further details.\n
2352 In case that <INSET> is "tabular" various math-environment features
2353 are handled as well, e.g. add-vline-left/right for the Grid/Array environment.\n
2354 <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|copy-column|
2355 toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
2356 align-left|align-right|align-center|align-block|align-decimal|set-decimal-point|
2357 valign-top|valign-bottom|valign-middle|longtabular-align-left|
2358 longtabular-align-center|longtabular-align-right|m-align-left|m-align-right|
2359 m-align-center|m-valign-top|m-valign-bottom|m-valign-middle|multicolumn|
2360 set-all-lines|unset-all-lines|set-longtabular|unset-longtabular|set-pwidth|
2361 set-mpwidth|set-rotate-tabular|unset-rotate-tabular|toggle-rotate-tabular|
2362 set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-usebox|set-lthead|
2363 unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-ltfoot|
2364 set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
2365 set-special-column|set-special-multicolumn|set-special-multirow|
2366 set-booktabs|unset-booktabs|set-top-space|set-bottom-space|
2367 set-interline-space|set-border-lines|tabular-valign-top|
2368 tabular-valign-middle|tabular-valign-bottom|set-tabular-width \n
2369 <ARG>: additional argument for some commands, use debug mode to explore its values.
2370 * \li Sample: inset-modify note Note Comment \n
2371 inset-modify changetype Ovalbox
2374 { LFUN_INSET_MODIFY, "inset-modify", AtPoint, Edit },
2376 * \var lyx::FuncCode lyx::LFUN_INSET_DIALOG_UPDATE
2377 * \li Action: Updates the values inside the dialog from the inset.
2378 * \li Notion: This is internal LFUN, not to be used by users. Called internally
2379 by #LFUN_DIALOG_UPDATE
2380 * \li Params: <DIALOG-NAME>
2381 * \li Origin: leeming, 25 Feb 2003
2384 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
2386 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
2387 * \li Action: Open the inset's properties dialog.
2388 * \li Notion: Used for bibitem, bibtex, box, branch, citation, ert, external,
2389 float, graphics, href, include, index, index_print, label, line,
2390 listings, note, phantom, ref, space, tabular, vspace, wrap insets.
2391 * \li Syntax: inset-settings <INSET>
2392 * \li Params: <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|\n
2393 graphics|href|include|index|index_print|label|line|
2394 listings|note|phantom|ref|space|tabular|vspace|wrap>.
2397 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly | AtPoint, Edit },
2399 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
2400 * \li Action: Toggles the collapsable inset at cursor position,
2401 or the inset we are currently in.
2402 * \li Syntax: inset-toggle [<ARG>]
2403 * \li Params: <ARG>: <open|close|toggle|assign>. \n
2404 open/close/toggle are for collapsable insets. toggle is used when no argument is given.\n
2405 assign synchronize the branch-inset with activation status of the branch.
2406 Used for global toggling when changed activation.
2407 * \li Origin: lasgouttes, 19 Jul 2001
2410 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly | AtPoint, Edit },
2412 * \var lyx::FuncCode lyx::LFUN_INSET_FORALL
2413 * \li Action: Apply the given commands on insets of a given name.
2414 * \li Notion: WARNING: use at your own risks; this function gives
2415 you too many ways of shooting yourself in the foot.
2416 A typical example is
2417 inset-forall Note note-insert
2418 which starts an infinite loop. This is mitigated by the fact
2419 that the number of actions is arbitrarily limited to 100000.
2420 Note also that inset-forall does not update metrics between
2421 iterations, which can lead to bugs. This has to be eventually
2423 * \li Syntax: inset-forall <NAME> <LFUN-COMMAND> \n
2424 <NAME>: Type of Inset. If <NAME> is *, all insets are matched.
2425 The name is used like for InsetLayout in layout files: "Note"
2426 matches all note insets, while "Note:Note" only matches LyX
2428 * \li Sample: Remove all index insets: \n
2429 inset-forall Index delete-char-forward \n
2430 Close all Notes (also works for a particular branch, for example): \n
2431 inset-forall Note inset-toggle close \n
2432 Transform all yellow notes to comments \n
2433 inset-forall Note:Note inset-modify note Note Comment \n
2434 Try to put LyX in an infinite loop if there is at least a Note: \n
2435 inset-forall Note char-backward
2436 * \li Origin: lasgouttes, 27 Nov 2009
2439 { LFUN_INSET_FORALL, "inset-forall", ReadOnly, Edit },
2442 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_RELOAD
2443 * \li Action: Reloads the image if necessary.
2444 * \li Syntax: graphics-reload
2445 * \li Origin: vfr, 10 Aug 2009
2448 { LFUN_GRAPHICS_RELOAD, "graphics-reload", ReadOnly | AtPoint, Edit },
2450 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
2451 * \li Action: Set the group for the graphics inset on the cursor position.
2452 * \li Syntax: set-graphics-group [<GROUP>]
2453 * \li Params: <GROUP>: Id for an existing group. In case the Id is an empty string,
2454 the graphics inset is removed from the current group.
2455 * \li Origin: sanda, 6 May 2008
2458 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", Noop, Edit },
2461 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
2462 * \li Action: Moves the cursor out of the current slice, going forward.
2463 * \li Notion: Cursor movement within an inset may be different than cursor
2464 movement in the surrounding text. This action should be called
2465 automatically by the cursor movement within the inset, when
2466 movement within the inset has ceased (reached the end of the
2467 last paragraph, for example), in order to move correctly
2468 back into the surrounding text.
2471 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
2473 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
2474 * \li Action: Moves the cursor out of the current slice, going backwards.
2475 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2478 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
2480 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
2481 * \li Action: Moves the cursor out of the current slice, going right.
2482 * \li Notion: See also #LFUN_FINISHED_FORWARD
2485 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
2487 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
2488 * \li Action: Moves the cursor out of the current slice, going left.
2489 * \li Notion: See also #LFUN_FINISHED_FORWARD.
2492 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
2495 * \var lyx::FuncCode lyx::LFUN_LANGUAGE
2496 * \li Action: Set language from the current cursor position.
2497 * \li Syntax: language <LANG>
2498 * \li Params: <LANG>: Requested language. Look in lib/languages for
2500 * \li Origin: Dekel, 2 Mar 2000
2503 { LFUN_LANGUAGE, "language", Noop, Edit },
2506 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
2507 * \li Action: Goto a label.
2508 * \li Syntax: label-goto [<LABEL>]
2509 * \li Params: <LABEL>: Requested label. If no label is given and reference
2510 is on cursor position, Bookmark 0 is saved and
2511 cursor moves to the position of referenced label.
2512 * \li Origin: Ale, 6 Aug 1997
2515 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
2517 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
2518 * \li Action: Inserts label to text or displayed formula.
2519 * \li Syntax: label-insert [<LABEL>]
2520 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
2521 name will be opened.
2524 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
2526 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
2527 * \li Action: Go to the next label or cross-reference.
2528 * \li Syntax: reference-next
2529 * \li Origin: Dekel, 14 Jan 2001
2532 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
2535 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
2536 * \li Action: Moves the cursor to the numbered bookmark, opening the file
2537 if necessary. Note that bookmarsk are saved per-session, not
2539 * \li Notion: Bookmark 0 has a special purpose. It is automatically set \n
2540 1. to the paragraph you are currently editing \n
2541 2. to the paragraph from where you are jumping to the last-edited
2542 position (jump-back feature) \n
2543 3. when jumping from crossreference to the requested label by
2545 * \li Syntax: bookmark-goto <NUMBER>
2546 * \li Params: <NUMBER>: the number of the bookmark to restore.
2547 * \li Origin: Dekel, 27 January 2001
2550 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
2552 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
2553 * \li Action: Save a bookmark.
2554 * \li Notion: Saves a numbered bookmark to the sessions file. The number
2555 must be between 1 and 9, inclusive. Note that bookmarks are
2556 saved per-session, not per file.
2557 * \li Syntax: bookmark-save <NUMBER>
2558 * \li Params: <NUMBER>: the number of the bookmark to save.
2559 * \li Origin: Dekel, 27 January 2001
2562 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
2564 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
2565 * \li Action: Clears the list of saved bookmarks.
2566 * \li Syntax: bookmark-clear
2567 * \li Origin: bpeng, 31 October 2006
2570 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
2573 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
2574 * \li Action: Open the given help file according to the language setting.
2575 * \li Syntax: help-open <FILE>[.lyx]
2576 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
2577 * \li Origin: Jug, 27 Jun 1999
2580 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
2582 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
2583 * \li Action: Terminates the current LyX instance.
2584 * \li Notion: Terminates the current LyX instance, asking whether to save
2585 modified documents, etc.
2586 * \li Syntax: lyx-quit
2589 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
2591 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
2592 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
2593 * \li Notion: Skipping "auto" when allowauto is false.
2594 * \li Syntax: toolbar-toggle <NAME> [allowauto]
2595 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|\n
2596 minibuffer|review|view/update|math_panels|vcs|
2597 view-others|update-others
2598 * \li Origin: Edwin, 21 May 2007
2601 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
2603 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
2604 * \li Action: Opens the menu given by its name.
2605 * \li Syntax: menu-open <NAME>
2606 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
2609 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
2611 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
2612 * \li Action: Various UI visibility-toggling actions.
2613 * \li Syntax: ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
2614 * \li Params: statusbar : Toggle visibility of the statusbar.\n
2615 menubar : Toggle visibility of the menubar.\n
2616 scrollbar : Toggle visibility of the scrollbar.\n
2617 frame : Toggle visibility of the frames around editing window.\n
2618 fullscreen : Toggle fullscreen mode. This also covers calling the
2619 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
2620 custom tweaks of the toolbars should be used.
2621 * \li Origin: sanda, 9 Feb 2007
2624 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
2627 * \var lyx::FuncCode lyx::LFUN_WINDOW_NEW
2628 * \li Action: Creates new empty LyX window.
2629 * \li Notion: Already opened documents from the previous window can be found under View menu.
2630 * \li Syntax: window-new [<GEOMETRY>]
2631 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
2632 accepted only on Windows platform.
2633 * \li Origin: Abdel, 21 Oct 2006
2636 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
2638 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
2639 * \li Action: Closes the current LyX window.
2640 * \li Syntax: window-close
2641 * \li Origin: Abdel, 23 Oct 2006
2644 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
2647 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
2648 * \li Action: Creates another split view of current buffer.
2649 * \li Notion: All split views act in the same way indpendently.
2650 * \li Syntax: split-view <vertical|horizontal>
2651 * \li Params: horizontal : The work areas are laid out side by side.\n
2652 vertical : The work areas laid out vertically.
2653 * \li Origin: Abdel, 20 Feb 2008
2656 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
2659 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
2660 * \li Action: Close the current tab group.
2661 * \li Notion: This only closes the work areas, not the buffer themselves.
2662 The still opened buffers can be visualized in another tab group.
2663 * \li Syntax: close-tab-group
2664 * \li Origin: Abdel, 21 Feb 2008
2667 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
2669 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW
2670 * \li Action: Shows hidden dialog or create new one for a given function/inset settings etc.
2671 * \li Syntax: dialog-show <NAME> [<DATA>]
2672 * \li Params: <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|\n
2673 compare|document|errorlist|ert|external|file|findreplace|findreplaceadv|float|\n
2674 graphics|href|include|index|index_print|info|label|line|listings|log|mathdelimiter|\n
2675 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|\n
2676 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|\n
2677 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL> \n
2678 <SPECIAL>: latexlog|vclog \n
2679 <DATA>: data, usually settings for the given dialog. Use debug mode for the
2681 * \li Origin: leeming, 17 Jun 2003
2684 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
2686 * \var lyx::FuncCode lyx::LFUN_DIALOG_SHOW_NEW_INSET
2687 * \li Action: Shows hidden dialog or create new one for a given inset settings etc.
2688 * \li Notion: Internally uses #LFUN_DIALOG_SHOW with processed data for a given inset.
2689 * \li Syntax: dialog-show-new-inset <NAME> [<DATA>]
2690 * \li Params: See #LFUN_DIALOG_SHOW .
2691 * \li Origin: leeming, 25 Feb 2003
2694 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
2696 * \var lyx::FuncCode lyx::LFUN_DIALOG_UPDATE
2697 * \li Action: Updates the dialog values from the inset/paragraph/document.
2698 * \li Syntax: dialog-update <NAME>
2699 * \li Params: <NAME>: paragraph|prefs|<INSET> \n
2701 * \li Origin: leeming, 25 Feb 2003
2704 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
2706 * \var lyx::FuncCode lyx::LFUN_DIALOG_HIDE
2707 * \li Action: Hides showed dialog. Counterpart to #LFUN_DIALOG_SHOW .
2708 * \li Syntax: dialog-hide <NAME>
2709 * \li Params: See #LFUN_DIALOG_SHOW .
2710 * \li Origin: leeming, 25 Feb 2003
2713 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
2715 * \var lyx::FuncCode lyx::LFUN_DIALOG_TOGGLE
2716 * \li Action: Toggles dialog between showed/hidden state.
2717 * \li Notion: Internally uses #LFUN_DIALOG_SHOW , #LFUN_DIALOG_HIDE .
2718 * \li Syntax: dialog-toggle <NAME> [<DATA>]
2719 * \li Params: See #LFUN_DIALOG_SHOW .
2720 * \li Origin: JSpitzm, 30 Apr 2007
2723 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
2725 * \var lyx::FuncCode lyx::LFUN_DIALOG_DISCONNECT_INSET
2726 * \li Action: Closes opened connection to opened inset.
2727 * \li Notion: Connection is used for apply functions.
2728 * \li Syntax: dialog-disconnect-inset <INSET-NAME>
2729 * \li Origin: leeming, 25 Feb 2003
2732 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
2735 * \var lyx::FuncCode lyx::LFUN_MOUSE_PRESS
2736 * \li Action: This function is called when mouse button is pressed (inside workarea).
2737 Action depends on the context.
2738 * \li Notion: This is internal LFUN, not to be used by users.
2739 * \li Origin: Andre, 9 Aug 2002
2742 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
2744 * \var lyx::FuncCode lyx::LFUN_MOUSE_DOUBLE
2745 * \li Action: This function is called when double click on mouse button is
2746 pressed (inside workarea). Action depends on the context.
2747 * \li Notion: This is internal LFUN, not to be used by users.
2748 * \li Origin: Andre, 9 Aug 2002
2751 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
2753 * \var lyx::FuncCode lyx::LFUN_MOUSE_TRIPLE
2754 * \li Action: This function is called when triple click on mouse button is
2755 pressed (inside workarea). Action depends on the context.
2756 * \li Notion: This is internal LFUN, not to be used by users.
2757 * \li Origin: Andre, 9 Aug 2002
2760 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
2762 * \var lyx::FuncCode lyx::LFUN_MOUSE_MOTION
2763 * \li Action: This function is called when mouse cursor is moving over the text.
2764 Action depends on the context.
2765 * \li Notion: This is internal LFUN, not to be used by users.
2766 * \li Origin: Andre, 9 Aug 2002
2769 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
2771 * \var lyx::FuncCode lyx::LFUN_MOUSE_RELEASE
2772 * \li Action: This function is called when mouse button is released (inside workarea).
2773 Action depends on the context.
2774 * \li Notion: This is internal LFUN, not to be used by users.
2775 * \li Origin: Andre, 9 Aug 2002
2778 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
2781 * \var lyx::FuncCode lyx::LFUN_KEYMAP_OFF
2782 * \li Action: Turn off the loaded keyboard map.
2783 * \li Syntax: keymap-off
2786 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
2788 * \var lyx::FuncCode lyx::LFUN_KEYMAP_PRIMARY
2789 * \li Action: Turn on the primary keyboard map.
2790 * \li Notion: Maps were widely used in past, when X-windows didn't have nowadays
2791 keyboard support. They can be still used to maintain uniform keyboard
2792 layout across the various plaforms.\n
2793 The language is to be set in the Preferences dialog.
2794 * \li Syntax: keymap-primary
2797 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
2799 * \var lyx::FuncCode lyx::LFUN_KEYMAP_SECONDARY
2800 * \li Action: Turn on the secondary keyboard map.
2801 * \li Syntax: keymap-secondary
2804 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
2806 * \var lyx::FuncCode lyx::LFUN_KEYMAP_TOGGLE
2807 * \li Action: Toggles keyboard maps (first/second/off).
2808 * \li Syntax: keymap-toggle
2809 * \li Origin: leeming, 30 Mar 2004
2812 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
2815 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_LAYOUT
2816 * \li Action: Returns the current layout (that is environment) name
2817 on the cursor position.
2818 * \li Syntax: server-get-layout
2821 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
2823 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_FILENAME
2824 * \li Action: Returns path and file name of the currently edited document.
2825 * \li Syntax: server-get-filename
2828 { LFUN_SERVER_GET_FILENAME, "server-get-filename", ReadOnly, System },
2830 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
2831 * \li Action: Sets the cursor position in LyX based on the row number of generated TeX file.
2832 * \li Notion: This can be useful for DVI inverse-search or detection of the problematic
2833 line from LaTeX compilation. Note that before this function can be used
2834 export to LaTeX output must occur (in order to map the row numbers).
2835 * \li Syntax: server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
2836 * \li Params: <FILE>: the path and filename. Environment variables are expanded in the path.
2837 In case this LFUN does not work make sure you are giving correct
2839 If the file is located inside LyX temporary directory it will be
2840 mapped back into the appropriate opened buffer (e.g. for the case
2841 of generated .tex file).\n
2842 .ext: extensions will be automatically replaced by .lyx.\n
2843 <ROW_NUMBER> The row number of the LaTeX file to which to go.
2844 * \li Sample: server-goto-file-row /home/user/example.lyx 41\n
2845 server-goto-file-row /tmp/lyx_tmpdir.XM3088/lyx_tmpbuf0/example.tex 41
2846 * \li Origin: Edmar, 23 Dec 1998
2849 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly | NoBuffer, System },
2851 * \var lyx::FuncCode lyx::LFUN_FORWARD_SEARCH
2852 * \li Action: Sets the cursor position in the previewed (dvi/pdf) file based on the row
2853 number in LyX window.
2854 * \li Notion: The external program used for forward search call can be specified in
2855 LyX Output preferences. See Additional manual for details of these
2857 * \li Syntax: forward-search
2858 * \li Origin: sanda, 14 Apr 2010
2861 { LFUN_FORWARD_SEARCH, "forward-search", ReadOnly, System },
2863 * \var lyx::FuncCode lyx::LFUN_SERVER_NOTIFY
2864 * \li Action: Sends notify message about the last key-sequence to client.
2865 * \li Notion: This can be used to grab last key-sequence used inside the LyX window.
2866 See also Debug extensions section in Additional features manual.
2867 * \li Syntax: server-notify
2870 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
2872 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
2873 * \li Action: Sets the cursor position based on the editing area coordinates
2874 (similar as clicking on that point with left mouse button).
2875 * \li Syntax: server-set-xy <X> <Y>
2878 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
2880 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
2881 * \li Action: Returns the coordinates of cursor position in the editing area.
2882 * \li Syntax: server-get-xy
2885 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
2888 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
2889 * \li Action: Generates the code (literate programming).
2890 * \li Notion: Latex file with extension \literate_extension is generated.
2891 Then LyX invokes \build_command (with a default of``make'') to generate the code and
2892 \build_error_filter to process the compilation error messages. \n
2893 In case you want to process your literate file with a script, or some other program,
2894 just insert in your lyxrc file an entry with:\n
2895 \build_command "my_script my_arguments" \n
2896 The \build_error_filter differs from the \literate_error_filter only in that the
2897 former will identify error messages from your compiler.
2898 * \li Syntax: build-program
2901 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
2904 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
2905 * \li Action: Saves the current buffer to a temporary file.
2906 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
2907 is called automatically by LyX, to "autosave" the current buffer.
2908 * \li Syntax: buffer-auto-save
2911 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
2913 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
2914 * \li Action: Loads the given child document.
2915 * \li Notion: The current document is treated as a parent.
2916 * \li Syntax: buffer-child-open <FILE>
2917 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
2918 * \li Origin: Ale, 28 May 1997
2921 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
2923 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
2924 * \li Action: Runs chktex for the current document.
2925 * \li Syntax: buffer-chktex
2926 * \li Origin: Asger, 30 Oct 1997
2929 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
2931 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
2932 * \li Action: Toggles compression of the current document on/off.
2933 * \li Syntax: buffer-toggle-compression
2934 * \li Origin: bpeng, 27 Apr 2006
2937 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
2939 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_OUTPUT_SYNC
2940 * \li Action: Toggles including of resources for forward/reverse search of the given document.
2941 * \li Notion: When toggled on, SyncTeX is invoked for PDF, while srcltx package
2942 is used for DVI. Custom LaTeX macro can be defined in preferences.
2943 * \li Syntax: buffer-toggle-output-sync
2944 * \li Origin: sanda, 25 May 2010
2947 { LFUN_BUFFER_TOGGLE_OUTPUT_SYNC, "buffer-toggle-output-sync", Noop, System },
2949 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
2950 * \li Action: Closes the current buffer.
2951 * \li Notion: Closes the current buffer, asking whether to save it, etc,
2952 if the buffer has been modified.
2953 * \li Syntax: buffer-close
2956 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
2958 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE_ALL
2959 * \li Action: Closes all buffers.
2960 * \li Notion: Closes all buffers, asking whether to save it, etc,
2961 if a buffer has been modified.
2962 * \li Syntax: buffer-close-all
2965 { LFUN_BUFFER_CLOSE_ALL, "buffer-close-all", ReadOnly, Buffer },
2967 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
2968 * \li Action: Exports the current buffer (document) to the given format.
2969 * \li Syntax: buffer-export <FORMAT> [<DEST>]
2970 * \li Params: <FORMAT> is either "custom" or one of the formats which you
2971 can find in Tools->Preferences->File formats->Format.
2972 Usual format you will enter is "pdf2" (pdflatex),
2973 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
2974 In case of "custom" you will be asked for a format you
2975 want to start from and for the command that you want to
2976 apply to this format. Internally the control is then passed
2977 to #LFUN_BUFFER_EXPORT_CUSTOM.
2978 <DEST> If present, this argument provides the export destination
2979 filename. Its containing folder will also be the destination
2980 folder, where all the needed external files will be copied.
2981 * \li Origin: Lgb, 29 Jul 1997
2984 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
2986 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
2987 * \li Action: Exports the current buffer (document) from the given format using
2988 the given command on it.
2989 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
2990 * \li Params: <FORMAT> format to start from (LyX will care to produce such
2991 intermediate file).\n
2992 <COMMAND> this command will be launched on the file. Note that you can
2993 use "$$FName" string to qualify the intermediate file.
2994 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
2995 * \li Origin: leeming, 27 Mar 2004
2998 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
3000 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_AS
3001 * \li Action: Pops up a dialog for exporting the current buffer.
3002 * \li Syntax: buffer-export-as
3003 * \li Origin: tommaso, 6 Oct 2011
3006 { LFUN_BUFFER_EXPORT_AS, "buffer-export-as", ReadOnly, Buffer },
3008 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
3009 * \li Action: Prints the current document.
3010 * \li Notion: Many settings can be given via the preferences dialog.
3011 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
3012 * \li Params: <TARGET> is either "printer" or "file".\n
3013 <TARGER-NAME> is either "default" or file name or printer name.\n
3014 <COMMAND> command ensuring the printing job.
3015 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
3016 * \li Origin: leeming, 28 Mar 2004
3019 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
3021 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
3022 * \li Action: Import a given file as a lyx document.
3023 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
3024 defined convertors in preferences. Look into File->Import menu to get
3025 an idea of the currently active import formats.
3026 * \li Syntax: buffer-import <FORMAT> [<FILE>]
3027 * \li Origin: Asger, 24 Jul 1998
3030 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
3032 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
3033 * \li Action: Creates a new buffer (that is, document).
3034 * \li Notion: Implicit path can be set in Preferences dialog.
3035 * \li Syntax: buffer-new [<FILE>]
3036 * \li Params: <FILE>: filename of created file with absolute path.
3039 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
3041 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
3042 * \li Action: Creates a new buffer (that is, document) from a template.
3043 * \li Notion: Path for new files and templates can be set in Preferences dialog.
3044 Template will be asked for via Open-dialog.
3045 * \li Syntax: buffer-new-template [<FILE>]
3046 * \li Params: <FILE>: filename of created file with absolute path.
3049 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
3051 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
3052 * \li Action: Reverts opened document.
3053 * \li Syntax: buffer-reload
3054 * \li Origin: Asger, 2 Feb 1997
3057 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
3059 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
3060 * \li Action: Display/switch to the given buffer.
3061 * \li Syntax: buffer-switch <BUFFER>
3062 * \li Params: <BUFFER>: path and filename of already opened (but possibly hidden)
3063 document which is to be shown.
3066 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
3068 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
3069 * \li Action: Toggle editing mode of the current document between read/write and read-only.
3070 * \li Notion: This function is not allowed if the file is under version control, since
3071 read-only flag is often used in version control file locking.
3072 * \li Syntax: buffer-toggle-read-only
3073 * \li Origin: Lgb, 27 May 1997
3076 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
3078 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
3079 * \li Action: Displays current buffer in chosen format.
3080 * \li Notion: Displays the contents of the current buffer in the chosen
3081 format, for example, PDF or DVI. This runs the necessary
3082 converter, calls the defined viewer, and so forth.
3083 * \li Syntax: buffer-view [<FORMAT>]
3084 * \li Params: <FORMAT>: The format to display, where this is one of the
3085 formats defined (in the current GUI) in the
3086 Tools>Preferences>File Formats dialog.
3087 If no format is given, the default format as
3088 specified in the same dialog is used.
3091 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
3093 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
3094 * \li Action: Exports the current document and put the result into the
3095 temporary directory.
3096 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
3097 the output will be rewriten - updated. This is useful in case your viewer
3098 is able to detect such changes (e.g. ghostview for postscript).
3099 * \li Syntax: buffer-update [<FORMAT>]
3100 * \li Params: <FORMAT>: The format to display, where this is one of the
3101 formats defined (in the current GUI) in the
3102 Tools>Preferences>File Formats dialog.
3103 If no format is given, the default format as
3104 specified in the same dialog is used.
3105 * \li Origin: Dekel, 5 Aug 2000
3108 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
3111 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
3112 * \li Action: Saves the current buffer.
3113 * \li Notion: Saves the current buffer to disk, using the filename that
3114 is already associated with the buffer, asking for one if
3115 none is yet assigned.
3116 * \li Syntax: buffer-write
3119 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
3121 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
3122 * \li Action: Rename and save current buffer.
3123 * \li Syntax: buffer-write-as <FILENAME>
3124 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
3125 is with respect to the original location of the buffer/file.
3128 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
3130 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
3131 * \li Action: Save all changed documents.
3132 * \li Syntax: buffer-write-all
3133 * \li Origin: rgh, gpothier 6 Aug 2007
3136 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
3138 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
3139 * \li Action: Switch to the next opened document.
3140 * \li Notion: Note that this does not necessarily mean next in tabbar
3141 (for full list see View menu).
3142 * \li Syntax: buffer-next
3145 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
3147 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
3148 * \li Action: Switch to the previous opened document.
3149 * \li Syntax: buffer-previous
3152 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
3154 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
3155 * \li Action: When run from a child document, this updates (exports) document built
3156 from the master buffer, if available.
3157 * \li Syntax: master-buffer-update [<FORMAT>]
3158 * \li Params: <FORMAT>: The format to display, where this is one of the
3159 formats defined (in the current GUI) in the
3160 Tools>Preferences>File Formats dialog.
3161 If no format is given, the default format as
3162 specified in the same dialog is used.
3163 * \li Origin: Tommaso, 20 Sep 2007
3166 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
3168 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
3169 * \li Action: When run from a child document, this command shows a preview built
3170 from the master buffer, if available.
3171 * \li Syntax: master-buffer-view [<FORMAT>]
3172 * \li Params: <FORMAT>: The format to display, where this is one of the
3173 formats defined (in the current GUI) in the
3174 Tools>Preferences>File Formats dialog.
3175 If no format is given, the default format as
3176 specified in the same dialog is used.
3177 * \li Origin: Tommaso, 20 Sep 2007
3180 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
3182 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
3183 * \li Action: Set language of the current document.
3184 * \li Syntax: buffer-language <LANG>
3185 * \li Params: <LANG>: language name. See lib/languages for list.
3186 * \li Origin: leeming, 30 Mar 2004
3189 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
3191 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
3192 * \li Action: Save the current document settings as default.
3193 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
3194 * \li Syntax: buffer-save-as-default [<ARGS>]
3195 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3196 you can find in document header of usual .lyx file.
3197 * \li Origin: leeming, 30 Mar 2004
3200 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
3202 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
3203 * \li Action: Apply the given settings to the current document.
3204 * \li Syntax: buffer-params-apply [<ARGS>]
3205 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
3206 you can find in document header of usual .lyx file.
3207 * \li Origin: leeming, 30 Mar 2004
3210 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", NoInternal, Buffer },
3213 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
3214 * \li Action: Inserts another LyX file.
3215 * \li Syntax: file-insert [<FILE>]
3216 * \li Params: <FILE>: Filename to be inserted.
3219 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
3221 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
3222 * \li Action: Inserts plain text file.
3223 * \li Syntax: file-insert-plaintext [<FILE>]
3224 * \li Params: <FILE>: Filename to be inserted.
3225 * \li Origin: CFO-G, 19 Nov 1997
3228 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
3230 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
3231 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
3232 * \li Syntax: file-insert-plaintext-para [<FILE>]
3233 * \li Params: <FILE>: Filename to be inserted.
3234 * \li Origin: Levon, 14 Feb 2001
3237 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
3239 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
3240 * \li Action: Open LyX document.
3241 * \li Syntax: file-open [<FILE>]
3242 * \li Params: <FILE>: Filename to be opened.
3245 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
3248 * \var lyx::FuncCode lyx::LFUN_CALL
3249 * \li Action: Executes a command defined in a .def file.
3250 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
3251 A .def file allows to define a command with \define "<NAME>" "<LFUN>"
3252 where <NAME> is the name of the new command and <LFUN> is the lfun code
3253 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
3254 \def_file "FileName" allows to include another .def file. \n
3255 This is particularly useful in connection with toolbar buttons:
3256 Since the name of the button image for this lfun is
3257 lib/images/commands/<NAME>.png this is the way to assign an image
3258 to a complex command-sequence.
3259 * \li Syntax: call <NAME>
3260 * \li Params: <NAME>: Name of the command that must be called.
3261 * \li Origin: broider, 2 Oct 2007
3264 { LFUN_CALL, "call", NoBuffer, System },
3266 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
3267 * \li Action: Simulate halting Meta key (Alt key on PCs).
3268 * \li Notion: Used for buffer editation not for GUI control.
3269 * \li Syntax: meta-prefix
3272 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
3274 * \var lyx::FuncCode lyx::LFUN_CANCEL
3275 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
3276 * \li Syntax: cancel
3279 { LFUN_CANCEL, "cancel", NoBuffer, System },
3282 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
3283 * \li Action: Switches the focus to the minibuffer so that the user can type
3284 in there. If necessary, it opens the minibuffer toolbar.
3285 * \li Notion: Usually bound to M-x shortcut.
3286 * \li Syntax: command-execute
3289 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
3292 * \var lyx::FuncCode lyx::LFUN_COMMAND_PREFIX
3293 * \li Action: Return the current key sequence and available options as a string.
3294 * \li Notion: No options are added if no current map exists. \n
3295 This is probably usable only with connection to lyxserver.
3296 * \li Syntax: command-prefix
3299 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
3301 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
3302 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
3303 * \li Syntax: command-sequence <CMDS>
3304 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3305 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
3306 * \li Origin: Andre, 11 Nov 1999
3309 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
3311 * \var lyx::FuncCode lyx::LFUN_COMMAND_ALTERNATIVES
3312 * \li Action: Runs the first listed command that is enabled.
3313 * \li Notion: This can be used to bind multiple functions to a single key,
3314 and then which one is used will depend upon the context.
3315 * \li Syntax: command-alternatives <CMDS>
3316 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
3317 * \li Sample: command-alternatives completion-accept;cell-forward
3318 * \li Origin: rgh, 24 September 2008
3321 { LFUN_COMMAND_ALTERNATIVES, "command-alternatives", NoBuffer, System },
3323 * \var lyx::FuncCode lyx::LFUN_MESSAGE
3324 * \li Action: Shows message in statusbar (for script purposes).
3325 * \li Syntax: message <STRING>
3326 * \li Origin: Lgb, 8 Apr 2001
3329 { LFUN_MESSAGE, "message", NoBuffer, System },
3331 * \var lyx::FuncCode lyx::LFUN_DEBUG_LEVEL_SET
3332 * \li Action: Set debug output level.
3333 * \li Syntax: debug-level-set <LEVEL>
3334 * \li Params: <LEVEL>: comma separated list of levels or the correspondent number
3335 of their combination. 0 is equivalent to disabling all debug
3336 events. See lyx -dbg for the current list of debug levels
3338 * \li Origin: sanda, 28 Dec 2009
3341 { LFUN_DEBUG_LEVEL_SET, "debug-level-set", NoBuffer, System },
3344 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
3345 * \li Action: Save user preferences.
3346 * \li Syntax: preferences-save
3347 * \li Origin: Lgb, 27 Nov 1999
3350 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
3352 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
3353 * \li Action: Reconfigure the automatic settings.
3354 * \li Syntax: reconfigure
3355 * \li Origin: Asger, 14 Feb 1997
3358 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
3360 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
3361 * \li Action: Apply the given settings to user preferences.
3362 * \li Syntax: lyxrc-apply <SETTINGS>
3363 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
3364 to get an idea which commands to use and their syntax.
3365 #lyx::LyXRC::LyXRCTags has the list of possible commands.
3368 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
3370 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
3371 * \li Action: Determine whether keep cursor inside the editing window regardless
3372 the scrollbar movement.
3373 * \li Syntax: toggle-cursor-follows-scrollbar
3374 * \li Origin: ARRae, 2 Dec 1997
3377 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
3379 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
3380 * \li Action: Set the given LyX color to the color defined by the X11 name given.
3381 * \li Notion: A new color entry is created if the color is unknown.
3382 Color names can be stored as a part of user settings.
3383 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
3384 * \li Origin: SLior, 11 Jun 2000
3387 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
3389 * \var lyx::FuncCode lyx::LFUN_STATISTICS
3390 * \li Action: Count the statistics (number of words and characters)
3391 in the document or in the given selection.
3392 * \li Notion: Note that this function gives the number of words/chars written,
3393 not the number of characters which will be typeset.
3394 * \li Syntax: statistics
3395 * \li Origin: lasgouttes, Jan 27 2004; sanda, Jan 8 2008
3398 { LFUN_STATISTICS, "statistics", ReadOnly, System },
3400 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
3401 * \li Action: Show the inline completion at the cursor position.
3402 * \li Syntax: completion-inline
3403 * \li Origin: sts, Feb 19 2008
3406 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
3408 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
3409 * \li Action: Show the completion popup at the cursor position.
3410 * \li Syntax: completion-popup
3411 * \li Origin: sts, Feb 19 2008
3414 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
3416 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
3417 * \li Action: Try to complete the word or command at the cursor position.
3418 * \li Syntax: complete
3419 * \li Origin: sts, Feb 19 2008
3422 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
3425 * \var lyx::FuncCode lyx::LFUN_COMPLETION_CANCEL
3426 * \li Action: Try to cancel completion, either the popup or the inline completion.
3427 * \li Syntax: completion-cancel
3428 * \li Origin: sts, Sep 07 2008
3431 { LFUN_COMPLETION_CANCEL, "completion-cancel", SingleParUpdate, Edit },
3433 * \var lyx::FuncCode lyx::LFUN_COMPLETION_ACCEPT
3434 * \li Action: Accept suggested completion.
3435 * \li Syntax: completion-accept
3436 * \li Origin: sanda, Sep 08 2008
3439 { LFUN_COMPLETION_ACCEPT, "completion-accept", SingleParUpdate, Edit },
3443 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD
3444 * \li Action: Add a branch to the buffer's BranchList.
3445 * \li Syntax: branch-add <BRANCH>
3446 * \li Params: <BRANCH>: Name of the branch to add
3447 * \li Origin: spitz, 7 Jul 2009
3450 { LFUN_BRANCH_ADD, "branch-add", Noop, Buffer },
3454 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
3455 * \li Action: Activate the branch.
3456 * \li Syntax: branch-activate <BRANCH>
3457 * \li Params: <BRANCH>: The branch to activate
3458 * \li Sample: lyx -x "branch-activate answers" -e pdf2 finalexam.lyx \n
3459 could be used to export a pdf with the answers branch included
3460 without one's having to open LyX and activate the branch manually.
3461 * \li Origin: rgh, 27 May 2008
3464 { LFUN_BRANCH_ACTIVATE, "branch-activate", AtPoint, Buffer },
3466 * \var lyx::FuncCode lyx::LFUN_BRANCH_DEACTIVATE
3467 * \li Action: De-activate the branch.
3468 * \li Syntax: branch-deactivate <BRANCH>
3469 * \li Params: <BRANCH>: The branch to deactivate
3470 * \li Origin: rgh, 27 May 2008
3473 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", AtPoint, Buffer },
3476 * \var lyx::FuncCode lyx::LFUN_BRANCHES_RENAME
3477 * \li Action: Rename all branches of a given name in a document.
3478 * \li Syntax: branches-rename <OLDNAME> <NEWNAME>
3479 * \li Params: <OLDNAME>: Current name of the branch to be renamed
3480 * <NEWNAME>: New name of the branch
3481 * \li Origin: spitz, 9 Jul 2009
3484 { LFUN_BRANCHES_RENAME, "branches-rename", Noop, Buffer },
3486 * \var lyx::FuncCode lyx::LFUN_BRANCH_ADD_INSERT
3487 * \li Action: Create new branch and directly put the branch inset into
3489 * \li Syntax: branch-add-insert [<NAME>]
3490 * \li Params: <NAME>: Branch name. If it is not specified, you will be asked.
3491 * \li Origin: sanda, 10 Jul 2009
3494 { LFUN_BRANCH_ADD_INSERT, "branch-add-insert", Noop, Buffer },
3498 * \var lyx::FuncCode lyx::LFUN_LABEL_COPY_AS_REF
3499 * \li Action: Copies the label at the cursor as a cross-reference to be pasted elsewhere.
3500 * \li Syntax: copy-label-as-reference <LABEL>
3501 * \li Params: <LABEL>: The label to copy (for multi-line math)
3502 * \li Origin: sts, 16 Nov 2008
3505 { LFUN_LABEL_COPY_AS_REF, "copy-label-as-reference",
3506 ReadOnly | NoUpdate | AtPoint, Edit },
3509 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT_AS_REF
3510 * \li Action: Inserts the label as a cross-reference at the position of the cursor.
3511 * \li Syntax: label-insert-as-reference
3512 * \li Origin: vfr, 7 Apr 2009
3515 { LFUN_LABEL_INSERT_AS_REF, "label-insert-as-reference", Noop, Edit},
3518 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_IN
3519 * \li Action: Increases the zoom of the screen fonts.
3520 * \li Syntax: buffer-zoom-in [<ZOOM>]
3521 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3522 * \li Origin: vfr, 30 Mar 2009
3525 { LFUN_BUFFER_ZOOM_IN, "buffer-zoom-in", ReadOnly, Buffer },
3528 * \var lyx::FuncCode lyx::LFUN_BUFFER_ZOOM_OUT
3529 * \li Action: Decreases the zoom of the screen fonts.
3530 * \li Syntax: buffer-zoom-out [<ZOOM>]
3531 * \li Params: <ZOOM>: The zoom in %, the default is 20.
3532 * \li Origin: vfr, 30 Mar 2009
3535 { LFUN_BUFFER_ZOOM_OUT, "buffer-zoom-out", ReadOnly, Buffer },
3538 * \var lyx::FuncCode lyx::LFUN_INSET_COPY_AS
3539 * \li Action: Copies the inset to the clipboard as a certain type.
3540 * \li Notion: Currently used only for InsetInfo where its content is copied as a text.
3541 * \li Syntax: inset-copy-as
3542 * \li Origin: vfr, 18 Apr 2010
3545 { LFUN_INSET_COPY_AS, "inset-copy-as", ReadOnly | NoUpdate | AtPoint, Edit },
3547 { LFUN_NOACTION, "", Noop, Hidden }
3548 #ifndef DOXYGEN_SHOULD_SKIP_THIS
3551 for (int i = 0; items[i].action != LFUN_NOACTION; ++i)
3552 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
3558 LyXAction::LyXAction()
3564 FuncRequest LyXAction::lookupFunc(string const & func) const
3566 string const func2 = trim(func);
3569 return FuncRequest(LFUN_NOACTION);
3572 string const arg = split(func2, cmd, ' ');
3574 FuncMap::const_iterator const fit = lyx_func_map.find(cmd);
3576 return fit != lyx_func_map.end()
3577 ? FuncRequest(fit->second, arg)
3578 : FuncRequest(LFUN_UNKNOWN_ACTION);
3582 string const LyXAction::getActionName(FuncCode action) const
3584 InfoMap::const_iterator const it = lyx_info_map.find(action);
3585 return it != lyx_info_map.end() ? it->second.name : string();
3589 LyXAction::FuncType LyXAction::getActionType(FuncCode action) const
3591 InfoMap::const_iterator const it = lyx_info_map.find(action);
3592 return it != lyx_info_map.end() ? it->second.type : Hidden;
3596 bool LyXAction::funcHasFlag(FuncCode action,
3597 LyXAction::FuncAttribs flag) const
3599 InfoMap::const_iterator ici = lyx_info_map.find(action);
3601 if (ici == lyx_info_map.end()) {
3602 LYXERR0("action: " << action << " is not known.");
3603 LASSERT(false, /**/);
3606 return ici->second.attrib & flag;
3610 LyXAction::const_iterator LyXAction::func_begin() const
3612 return lyx_func_map.begin();
3616 LyXAction::const_iterator LyXAction::func_end() const
3618 return lyx_func_map.end();
3622 LyXErr & operator<<(LyXErr & l, FuncCode code)
3625 l.stream() << lyxaction.getActionName(code);