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
11 * Full author contact details are available in file CREDITS.
16 #include "LyXAction.h"
18 #include "FuncRequest.h"
20 #include "support/debug.h"
21 #include "support/lstrings.h"
23 #include "support/lassert.h"
26 using namespace lyx::support;
31 NAMING RULES FOR USER-COMMANDS
32 Here's the set of rules to apply when a new command name is introduced:
34 1) Use the object.event order. That is, use `word-forward'
35 instead of `forward-word'.
36 2) Don't introduce an alias for an already named object. Same for events.
37 3) Forward movement or focus is called `forward' (not `right').
38 4) Backward movement or focus is called `backward' (not `left').
39 5) Upward movement of focus is called `up'.
40 6) Downward movement is called `down'.
41 7) The begin of an object is called `begin' (not `start').
42 8) The end of an object is called `end'.
44 (May 19 1996, 12:04, RvdK)
47 /* LFUN documentation (a start at least, Chr 2007-08-12)
49 * The documentation below is primarily notes about restrictions and
50 * oddities relating to the different LFUNs.
52 * Try to find an appropriate (thematical) place when adding the new LFUN.
54 * Doxygen template below. Some notes: Parameters should be set in uppercase
55 * and put in <BRACKETS>, as so.
59 * \var lyx::FuncCode lyx::LFUN_
72 void LyXAction::newFunc(FuncCode action, string const & name,
73 unsigned int attrib, LyXAction::func_type type)
75 lyx_func_map[name] = action;
78 tmpinfo.attrib = attrib;
80 lyx_info_map[action] = tmpinfo;
84 // Needed for LFUNs documentation to be accepted, since doxygen won't take
85 // \var inside functions.
86 #ifndef DOXYGEN_SHOULD_SKIP_THIS
87 void LyXAction::init()
89 // This function was changed to use the array below in initalization
90 // instead of calling newFunc numerous times because of compilation
91 // times. Since the array is not static we get back the memory it
92 // occupies after the init is completed. It compiles several
105 ev_item const items[] = {
108 * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
109 * \li Action: Adds an acute accent \htmlonly (á)\endhtmlonly
110 to the next character typed.
111 * \li Syntax: accent-acute
114 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
116 * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
117 * \li Action: Adds a breve accent \htmlonly (ă)\endhtmlonly
118 to the next character typed.
119 * \li Syntax: accent-breve
122 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
124 * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
125 * \li Action: Adds a caron \htmlonly (ǎ)\endhtmlonly
126 to the next character typed.
127 * \li Syntax: accent-caron
130 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
132 * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
133 * \li Action: Adds a cedilla \htmlonly (ç)\endhtmlonly
134 to the next character typed.
135 * \li Syntax: accent-cedilla
138 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
140 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
141 * \li Action: Adds a circle accent \htmlonly (å)\endhtmlonly
142 to the next character typed.
143 * \li Syntax: accent-circle
146 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
148 * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
149 * \li Action: Adds a circumflex \htmlonly (ê)\endhtmlonly
150 to the next character typed.
151 * \li Syntax: accent-circumflex
154 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
156 * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
157 * \li Action: Adds a dot accent \htmlonly (ż)\endhtmlonly
158 to the next character typed.
159 * \li Syntax: accent-dot
162 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
164 * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
165 * \li Action: Adds a grave accent \htmlonly (è)\endhtmlonly
166 to the next character typed.
167 * \li Syntax: accent-grave
170 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
172 * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
173 * \li Action: Adds a Hungarian umlaut \htmlonly (ő)\endhtmlonly
174 to the next character typed.
175 * \li Syntax: accent-grave
178 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
180 * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
181 * \li Action: Adds a macron \htmlonly (ā)\endhtmlonly
182 to the next character typed.
183 * \li Syntax: accent-macron
186 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
188 * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
189 * \li Action: Adds an ogonek accent \htmlonly (ą)\endhtmlonly
190 to the next character typed.
191 * \li Syntax: accent-ogonek
194 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
196 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
197 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
198 over the next two character typed.
199 * \li Notion: the following char will finish the tie.
200 * \li Syntax: accent-tie
203 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
205 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
206 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
207 over the next character typed.
208 * \li Syntax: accent-tilde
211 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
213 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
214 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
215 over the next character typed.
216 * \li Syntax: accent-umlaut
219 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
221 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
222 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
223 under the next character typed.
224 * \li Syntax: accent-underbar
227 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
229 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
230 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
231 under the next character typed.
232 * \li Syntax: accent-underdot
235 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
238 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
239 * \li Action: Inserts a caption inset.
240 * \li Syntax: caption-insert
241 * \li Origin: Lgb, 18 Jul 2000
244 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
246 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
247 * \li Action: Inserts the current date.
248 * \li Syntax: date-insert [<ARG>]
249 * \li Params: <ARG>: Format of date. The default value (%x) can be set
250 in Preferences->Date format. For possible formats
251 see manual page of strftime function.
252 * \li Origin: jdblair, 31 Jan 2000
255 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
257 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
258 * \li Action: Inserts a footnote inset.
259 * \li Syntax: footnote-insert
260 * \li Origin: Jug, 7 Mar 2000
263 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
265 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
266 * \li Action: Inserts an ERT inset.
267 * \li Syntax: ert-insert
268 * \li Origin: Jug, 18 Feb 2000
271 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
273 * \var lyx::FuncCode lyx::LFUN_FLOAT_INSERT
274 * \li Action: Inserts a float inset.
275 * \li Syntax: float-insert <TYPE>
276 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
277 "algorithm", "table", "figure" parameters can be given.
278 * \li Origin: Lgb, 27 Jun 2000
281 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
282 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
283 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
285 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
286 * \li Action: Inserts an optional-argument (short title) inset.
287 * \li Syntax: optional-insert
288 * \li Origin: Martin, 12 Aug 2002
291 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
293 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
294 * \li Action: Inserts a horizontal line.
295 * \li Syntax: line-insert
296 * \li Origin: poenitz, Oct 27 2003
299 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
302 * \li Action: Inserts a new page.
303 * \li Syntax: newpage-insert<ARG>
304 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
305 * \li Origin: uwestoehr, 24 Nov 2007
308 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
310 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
311 * \li Action: Inserts a marginal note.
312 * \li Syntax: marginalnote-insert
313 * \li Origin: Lgb, 26 Jun 2000
316 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
318 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
319 * \li Action: Inserts a single unicode character.
320 * \li Syntax: unicode-insert <CHAR>
321 * \li Params: <CHAR>: The character to insert, given as its code
322 point, in hexadecimal, e.g.: unicode-insert 0x0100.
323 * \li Origin: Lgb, 22 Oct 2006
326 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
328 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
329 * \li Action: Inserts a new listings inset.
330 * \li Syntax: listing-insert
331 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
334 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
336 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
337 * \li Action: Inserts quotes according to the type and quote-language preference.
338 * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
340 * \li Syntax: quote-insert [<TYPE>]
341 * \li Params: TYPE: 'single' for single quotes, otherwise double quotes will be used.
344 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
346 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
347 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
348 information in a non-editable boxed InsetText.
349 * \li Notion: Apart from lfun arguments you can use the following method: \n
350 1. input the type and argument of this inset, e.g. "menu paste", in
352 2. select the text and run info-insert lfun.\n
353 * \li Syntax: info-insert <TYPE> <ARG>
354 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
355 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
357 * \li Origin: bpeng, 7 Oct 2007
360 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
362 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
363 * \li Action: Inserts branch inset.
364 * \li Syntax: branch-insert <BRANCH-NAME>
365 * \li Origin: vermeer, 17 Aug 2003
368 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
370 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
371 * \li Action: Inserts Box inset.
372 * \li Syntax: box-insert [<TYPE>]
373 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
374 Framed is the default one.
375 * \li Origin: vermeer, 7 Oct 2003
378 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
380 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
381 * \li Action: Inserts CharStyle, Custom inset or XML short element.
382 * \li Notion: Look into the Customization manual for more information about
384 For dissolving the element see #LFUN_INSET_DISSOLVE.
385 * \li Syntax: flex-insert <TYPE:Name>
386 * \li Params: TYPE: CharStyle|Custom|Element|Standard
387 Identifies whether this is a Character Style, a
388 Custom Inset or an XML Element, and which dynamical
389 sub-menu this flex inset is in on the LyX menu tree.
390 If Standard (currently unused): none of these.
391 Name: This name must be defined either in your layout file
392 or imported by some module. The definition is\n
393 InsetLayout <TYPE:Name>
394 * \li Sample: flex-insert CharStyle:Code
397 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
399 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
400 * \li Action: Inserts the given string (accordingly to the correct keymap).
401 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
402 settings "auto_region_delete".
403 * \li Syntax: self-insert <STRING>
406 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
408 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
409 * \li Action: Inserts one of horizontal space insets.
410 * \li Syntax: space-insert <NAME> [<LEN>]
411 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
412 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
414 <LEN>: length for custom spaces (hspace, hspace* for protected)
415 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
418 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
420 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
421 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
422 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
423 * \li Syntax: href-insert [<TARGET>]
424 * \li Origin: CFO-G, 21 Nov 1997
427 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
429 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
430 * \li Action: Inserts various characters into the document.
431 * \li Syntax: specialchar-insert <CHAR>
432 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
433 end-of-sentence, menu-separator.
434 * \li Origin: JSpitzm, 6 Dec 2007
437 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
439 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
440 * \li Action: Inserts table of contents.
441 * \li Syntax: toc-insert
442 * \li Origin: Lgb, 27 May 97
445 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
447 * \var lyx::FuncCode lyx::LFUN_APPENDIX
448 * \li Action: Start (or remove) Appendix on the given cursor position.
449 * \li Syntax: appendix
450 * \li Origin: ettrich, 5 May 1998
453 { LFUN_APPENDIX, "appendix", Noop, Edit },
455 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
456 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
458 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
459 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
461 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
462 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
464 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
465 * \li Action: Inserts a line break or new line.
466 * \li Syntax: newline-insert <ARG>
467 * \li Params: <ARG>: <newline|linebreak> default: newline
468 * \li Origin: JSpitzm, 25 Mar 2008
471 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
475 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
479 * \var lyx::FuncCode lyx::LFUN_ESCAPE
480 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
482 * \li Origin: Lgb, 17 May 2001
485 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
486 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
487 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
488 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
489 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
490 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
491 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
492 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
493 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
495 * \var lyx::FuncCode lyx::LFUN_SCROLL
496 * \li Action: Scroll the buffer view.
497 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
498 * \li Syntax: scroll <TYPE> <QUANTITY>
499 * \li Params: <TYPE>: line|page\n
500 <QUANTITY>: up|down|<number>
501 * \li Origin: Abdelrazak Younes, Dec 27 2007
504 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
506 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
507 * \li Action: Recenters the screen on the current cursor position.
508 * \li Syntax: screen-recenter
511 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
512 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
513 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
515 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
517 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
518 * \li Action: Moves the cursor one position logically backwards.
519 * \li Notion: This is not the action which should be bound to the arrow keys,
520 because backwards may be left or right, depending on the
521 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
522 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
523 * \li Syntax: char-backward
526 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
528 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
529 * \li Action: Moves the cursor one position logically backwards, adding
530 traversed position to the selection.
531 * \li Notion: See also #LFUN_CHAR_BACKWARD.
532 * \li Syntax: char-backward-select
535 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
536 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
537 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
539 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
540 * \li Action: Moves the cursor one position logically forward.
541 * \li Notion: This is not the action which should be bound to the arrow keys,
542 because forward may be left or right, depending on the language.
543 The arrow keys should be bound to #LFUN_CHAR_LEFT or
544 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
545 * \li Syntax: char-forward
548 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
550 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
551 * \li Action: Moves the cursor one position logically forward, adding
552 traversed position to the selection.
553 * \li Notion: See also #LFUN_CHAR_FORWARD.
554 * \li Syntax: char-forward-select
557 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
559 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
560 * \li Action: Moves the cursor one position "to the left".
561 * \li Notion: This is the action which should be taken when the "left" key
562 is pressed. Generally, it moves the cursor one position to the
563 left. However, in Bidi text this become slightly more
564 complicated, and there are different modes of cursor movement.
565 In "visual mode", this moves left, plain and simple. In "logical
566 mode", movement is logically forward in RTL paragraphs, and
567 logically backwards in LTR paragraphs.
568 * \li Syntax: char-left
571 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
573 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
574 * \li Action: Moves the cursor one position "to the left", adding
575 traversed position to the selection.
576 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
577 * \li Syntax: char-left-select
580 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
582 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
583 * \li Action: Moves the cursor one position "to the right".
584 * \li Notion: This is the action which should be taken when the "right" key
585 is pressed. Generally, it moves the cursor one position to the
586 right. However, in Bidi text this become slightly more
587 complicated, and there are different modes of cursor movement.
588 In "visual mode", this moves right, plain and simple. In "logical
589 mode", movement is logically forward in LTR paragraphs, and
590 logically backwards in RTL paragraphs.
591 * \li Syntax: char-right
594 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
596 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
597 * \li Action: Moves the cursor one position "to the right", adding
598 traversed position to the selection.
599 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
600 * \li Syntax: char-right-select
603 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
606 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
607 * \li Action: Moves the cursor to the logically previous beginning of a word.
608 * \li Notion: This is not the action which should be bound to the arrow keys,
609 because backwards may be left or right, depending on the
610 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
611 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
612 * \li Syntax: word-backward
615 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
617 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
618 * \li Action: Moves the cursor to the logically previous beginning of a word,
619 adding the logically traversed text to the selection.
620 * \li Notion: See also #LFUN_WORD_BACKWARD.
621 * \li Syntax: word-backward-select
624 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
625 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
626 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
628 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
629 * \li Action: Search for a given string in forward direction.
630 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
631 * \li Syntax: word-find-forward [<STRING>]
632 * \li Origin: Etienne, 16 Feb 1998
635 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
637 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
638 * \li Action: Search for a given string in backward direction.
639 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
640 * \li Syntax: word-find-backward [<STRING>]
641 * \li Origin: Etienne, 20 Feb 1998
644 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
646 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
647 * \li Action: Search for next occurence of a string.
648 * \li Syntax: word-find [<DATA>]
649 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
650 If no parameter is given, search with last find-dialog
651 data is used for search (i.e. find-next).
652 * \li Origin: poenitz, Jan 7 2004
655 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
656 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
658 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
659 * \li Action: Moves the cursor to the logically next beginning of a word.
660 * \li Notion: This is not the action which should be bound to the arrow keys,
661 because forward may be left or right, depending on the language.
662 The arrow keys should be bound to #LFUN_WORD_LEFT or
663 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
664 * \li Syntax: word-forward
667 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
669 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
670 * \li Action: Moves the cursor to the logically next beginning of a word,
671 adding the logically traversed text to the selection.
672 * \li Notion: See also #LFUN_WORD_FORWARD.
673 * \li Syntax: word-forward-select
676 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
678 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
679 * \li Action: Moves the cursor to the next beginning of a word "on the left".
680 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
681 "left" key is pressed. Generally, it moves the cursor to the
682 next beginning of a word on the left. However, in Bidi text this
683 become slightly more complicated, and there are different modes
684 of cursor movement. In "visual mode", this moves left, plain and
685 simple. In "logical mode", movement is logically forward in RTL
686 paragraphs, and logically backwards in LTR paragraphs.
687 * \li Syntax: word-left
688 * \li Origin: dov, 28 Oct 2007
691 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
693 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
694 * \li Action: Moves the cursor to the next beginning of a word "on the left",
695 adding *logically* traversed text to the selection.
696 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
697 * \li Syntax: word-left-select
698 * \li Origin: dov, 28 Oct 2007
701 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
703 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
704 * \li Action: Moves the cursor to the next beginning of a word "on the right".
705 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
706 "right" key is pressed. Generally, it moves the cursor to the
707 next beginning of a word on the right. However, in Bidi text
708 this become slightly more complicated, and there are different
709 modes of cursor movement. In "visual mode", this moves right,
710 plain and simple. In "logical mode", movement is logically
711 forward in LTR paragraphs, and logically backwards in RTL
713 * \li Syntax: word-right
714 * \li Origin: dov, 28 Oct 2007
717 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
719 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
720 * \li Action: Moves the cursor to the next beginning of a word "on the right",
721 adding *logically* traversed text to the selection.
722 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
723 * \li Syntax: word-right-select
724 * \li Origin: dov, 28 Oct 2007
727 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
728 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
730 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
731 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
732 or the letter on the cursor position.
733 * \li Syntax: word-capitalize
736 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
738 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
739 * \li Action: Change the words in the selection or from the cursor position
740 to the end of word to the upper case.
741 * \li Syntax: word-upcase
744 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
746 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
747 * \li Action: Change the words in the selection or from the cursor position
748 to the end of word to the lower case.
749 * \li Syntax: word-lowcase
752 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
754 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
755 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
756 * \li Syntax: thesaurus-entry
757 * \li Origin: Levon, 20 Jul 2001
760 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
761 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
762 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
763 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
764 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
766 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
767 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
768 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
769 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
770 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
772 * \var lyx::FuncCode lyx::LFUN_COPY
773 * \li Action: Copies to the clipboard the last edit.
777 { LFUN_COPY, "copy", ReadOnly, Edit },
779 * \var lyx::FuncCode lyx::LFUN_CUT
780 * \li Action: Cuts to the clipboard.
784 { LFUN_CUT, "cut", Noop, Edit },
786 * \var lyx::FuncCode lyx::LFUN_PASTE
787 * \li Action: Pastes from the active clipboard.
791 { LFUN_PASTE, "paste", Noop, Edit },
792 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
794 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
795 * \li Action: Pastes the material currently selected.
796 * \li Syntax: primary-selection-paste
799 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
801 * \var lyx::FuncCode lyx::LFUN_UNDO
802 * \li Action: Undoes the last edit.
806 { LFUN_UNDO, "undo", Noop, Edit },
808 * \var lyx::FuncCode lyx::LFUN_REDO
809 * \li Action: Redoes the last thing undone.
813 { LFUN_REDO, "redo", Noop, Edit },
815 * \var lyx::FuncCode lyx::LFUN_REPEAT
816 * \li Action: Repeat the given command.
817 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
818 * \li Author: poenitz, 27 Oct 2003
821 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
823 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
824 * \li Action: Transposes the character at the cursor with the one before it.
825 * \li Syntax: chars-transpose
826 * \li Author: Lgb, 25 Apr 2001
829 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
831 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
832 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
833 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
836 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
837 * \li Action: Toggles the bold font (selection-wise).
838 * \li Syntax: font-bold
841 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
843 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
844 * \li Action: Toggles the typewriter family font (selection-wise).
845 * \li Syntax: font-typewriter
848 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
850 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
851 * \li Action: Toggles underline in the font (selection-wise).
852 * \li Syntax: font-underline
855 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
857 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
858 * \li Action: Toggles the emphasis font style (selection-wise).
859 * \li Syntax: font-emph
862 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
864 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
865 * \li Action: Toggles Noun text style font (selection-wise).
866 * \li Syntax: font-noun
869 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
871 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
872 * \li Action: Toggles Roman family font (selection-wise).
873 * \li Syntax: font-roman
876 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
878 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
879 * \li Action: Toggles Sans Serif family font (selection-wise).
880 * \li Syntax: font-sans
883 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
885 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
886 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
887 * \li Syntax: font-frak
888 * \li Origin: vermeer, 10 Jan 2002
891 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
893 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
894 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
895 * \li Syntax: font-ital
896 * \li Origin: vermeer, 10 Jan 2002
899 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
901 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
902 * \li Action: Reverts the settings of the font to the default values (selection-wise).
903 * \li Syntax: font-default
906 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
907 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
908 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
909 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
910 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
912 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
913 * \li Action: Returns the info about the current font.
914 * \li Syntax: font-state
917 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
919 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
920 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
921 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
922 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
925 * \var lyx::FuncCode lyx::LFUN_LAYOUT
926 * \li Action: Sets the layout (that is, environment) for the current paragraph.
927 * \li Syntax: layout <LAYOUT>
928 * \li Params: <LAYOUT>: the layout to use
931 { LFUN_LAYOUT, "layout", Noop, Layout },
933 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
934 * \li Action: Launches the paragraph settings dialog.
935 * \li Syntax: layout-paragraph
938 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
940 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
941 * \li Action: Launches the tabular settings dialog.
942 * \li Syntax: layout-tabular
943 * \li Origin: Jug, 31 Jul 2000
946 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
948 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
949 * \li Action: Displays list of layout choices.
950 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
951 dropbox allowing for choice of layout.
952 * \li Syntax: drop-layouts-choice
955 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
957 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
958 * \li Action: Clears the module list.
959 * \li Notion: Clears the list of included modules for the current buffer.
960 * \li Syntax: layout-modules-clear
961 * \li Origin: rgh, 25 August 2007
964 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
966 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
967 * \li Action: Adds a module.
968 * \li Notion: Adds a module to the list of included modules for the current buffer.
969 * \li Syntax: layout-module-add <MODULE>
970 * \li Params: <MODULE>: the module to be added
971 * \li Origin: rgh, 25 August 2007
974 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
976 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
977 * \li Action: Reloads layout information.
978 * \li Notion: Reloads all layout information for the current buffer from disk, thus
979 recognizing any changes that have been made to layout files on the fly.
980 This is intended to be used only by layout developers and should not be
981 used when one is trying to do actual work.
982 * \li Syntax: layout-reload
983 * \li Origin: rgh, 3 September 2007
986 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
988 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
989 * \li Action: Sets the text class for the current buffer.
990 * \li Syntax: textclass-apply <TEXTCLASS>
991 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
992 the filename, minus the ".layout" extension.
995 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
997 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
998 * \li Action: Loads information for a textclass from disk.
999 * \li Syntax: textclass-load <TEXTCLASS>
1000 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1001 the filename, minus the ".layout" extension.
1004 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1007 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1008 * \li Action: Disable selecting of text-region.
1009 * \li Syntax: mark-off
1012 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1014 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1015 * \li Action: Enable selecting of text-region.
1016 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1017 * \li Syntax: mark-on
1020 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1022 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1023 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1024 * \li Syntax: mark-toggle
1025 * \li Origin: poenitz, May 5 2006
1028 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1030 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1031 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1032 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1033 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1034 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1035 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1036 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1037 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1038 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1039 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1040 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1041 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1042 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1044 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1045 * \li Action: Toggles numbering of the current formula line.
1046 * \li Notion: Must be in display formula mode.
1047 * \li Syntax: math-number-line-toggle
1048 * \li Origin: Alejandro 18 Jun 1996
1051 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1053 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1054 * \li Action: Toggles numbering/labeling of the current formula.
1055 * \li Notion: Must be in display formula mode.
1056 * \li Syntax: math-number-toggle
1057 * \li Origin: Alejandro 4 Jun 1996
1060 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1061 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1062 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1064 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1065 * \li Action: Unfold a Math Macro.
1066 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1068 * \li Syntax: math-macro-unfold
1069 * \li Origin: sts, 06 January 2008
1072 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1074 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1075 * \li Action: Fold a Math Macro.
1076 * \li Notion: Fold the Math Macro the cursor is in if it was
1077 unfolded, i.e. displayed as \foo before.
1078 * \li Syntax: math-macro-fold
1079 * \li Origin: sts, 06 January 2008
1082 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1084 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1085 * \li Action: Add a parameter.
1086 * \li Notion: Add a parameter to a Math Macro.
1087 * \li Params: <NUM>: The number of the parameter behind which the new one
1088 will be added (1 for the first, i.e. use 0 for add a
1089 parameter at the left), defaults to the last one.
1090 * \li Syntax: math-macro-add-param <NUM>
1091 * \li Origin: sts, 06 January 2008
1094 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1096 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1097 * \li Action: Remove the last parameter.
1098 * \li Notion: Remove the last parameter of a Math Macro and
1099 remove its value in all instances of the macro
1101 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1102 the first), defaults to the last one.
1103 * \li Syntax: math-macro-remove-param <NUM>
1104 * \li Origin: sts, 06 January 2008
1107 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1109 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1110 * \li Action: Append a greedy parameter.
1111 * \li Notion: Append a greedy parameter to a Math Macro which
1112 eats the following mathed cell in every instance of
1113 the macro in the buffer.
1114 * \li Syntax: math-macro-append-greedy-param
1115 * \li Origin: sts, 06 January 2008
1118 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1120 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1121 * \li Action: Remove a greedy parameter.
1122 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1123 out the values of it in every instance of the macro
1124 in the buffer. If it is an optional parameter the [valud]
1126 * \li Syntax: math-macro-remove-greedy-param
1127 * \li Origin: sts, 06 January 2008
1130 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1132 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1133 * \li Action: Make a parameter optional.
1134 * \li Notion: Turn the first non-optional parameter of a Math Macro
1135 into an optional parameter with a default value.
1136 * \li Syntax: math-macro-make-optional
1137 * \li Origin: sts, 06 January 2008
1140 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1142 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1143 * \li Action: Make a parameter non-optional.
1144 * \li Notion: Turn the last optional parameter of a Math Macro
1145 into a non-optional parameter. The default value is
1146 remembered to be reused later if the user changes his mind.
1147 * \li Syntax: math-macro-make-nonoptional
1148 * \li Origin: sts, 06 January 2008
1151 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1153 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1154 * \li Action: Add an optional parameter.
1155 * \li Notion: Insert an optional parameter just behind the
1156 already existing optional parameters.
1157 * \li Syntax: math-macro-add-optional-param
1158 * \li Origin: sts, 06 January 2008
1161 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1163 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1164 * \li Action: Remove the last optional parameter.
1165 * \li Notion: Remove the last optional parameter of a Math Macro and
1166 remove it in all the instances of the macro in the buffer.
1167 * \li Syntax: math-macro-remove-optional-param
1168 * \li Origin: sts, 06 January 2008
1171 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1173 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1174 * \li Action: Add a greedy optional parameter.
1175 * \li Notion: Add a greedy optional parameter which eats the value
1176 from the following cells in mathed which are in the [value]
1178 * \li Syntax: math-macro-add-greedy-optional-param
1179 * \li Origin: sts, 06 January 2008
1182 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1184 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1185 * \li Action: Only active in Math Macro definition.
1186 * \li Notion: Dummy function which is only active in a Math Macro definition.
1187 It's used to toggle the Math Macro toolbar if the cursor moves
1188 into a Math Macro definition.
1189 * \li Syntax: in-mathmacrotemplate
1190 * \li Origin: sts, 06 January 2008
1193 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1196 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1197 * \li Action: Moves the current paragraph downwards in the document.
1198 * \li Syntax: paragraph-move-down
1199 * \li Origin: Edwin, 8 Apr 2006
1202 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1204 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1205 * \li Action: Moves the current paragraph upwards in the document.
1206 * \li Syntax: paragraph-move-up
1207 * \li Origin: Edwin, 8 Apr 2006
1210 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1213 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1214 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1215 in upward direction.
1216 * \li Syntax: paragraph-up
1217 * \li Origin: Asger, 1 Oct 1996
1220 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1222 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1223 * \li Action: Move the cursor and select the text to the next paragraph (or
1224 begining of the current one) in upward direction.
1225 * \li Syntax: paragraph-up-select
1226 * \li Origin: Asger, 1 Oct 1996
1229 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1231 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1232 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1233 in downward direction.
1234 * \li Syntax: paragraph-down
1235 * \li Origin: Asger, 1 Oct 1996
1238 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1240 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1241 * \li Action: Move the cursor and select the text to the next paragraph (or
1242 begining of the current one) in downward direction.
1243 * \li Syntax: paragraph-down-select
1244 * \li Origin: Asger, 1 Oct 1996
1247 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1249 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1250 * \li Action: Jump to a paragraph given by its id number and optionally the
1251 desired position within the paragraph.
1252 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1253 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1254 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1255 * \li Params: <PAR_ID_NUMBER>: paragraph id
1256 <POSITION_IN_PAR>: desired position within the paragraph
1257 * \li Origin: Dekel, 26 Aug 2000
1260 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1262 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1263 * \li Action: Breaks the current paragraph at the current location.
1264 * \li Syntax: break-paragraph
1267 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1269 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1270 * \li Action: Breaks the current paragraph at the current location.
1271 * \li Notion: Removes the selection.
1272 * \li Syntax: break-paragraph [<LAYOUT>]
1273 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1274 to default layout) when the cursor is at the end of
1278 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1280 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1281 * \li Action: Breaks the current paragraph at the current location,
1282 unless used at the beginning of a line, where it sets
1283 the label width string to empty.
1284 * \li Syntax: break-paragraph-skip
1287 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1289 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1290 * \li Action: Change paragraph settings.
1291 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1292 This function only modifies, and does not override, existing settings.
1293 Note that the "leftindent" indent setting is deprecated.
1294 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1295 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1296 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1297 <ALIGN>: \\align block|left|right|center|default\n
1298 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1299 * \li Origin: rgh, Aug 15 2007
1302 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1304 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1305 * \li Action: Change paragraph settings.
1306 * \li Notion: Overwrite all nonspecified settings to the default ones.
1307 Use paragraph-params lfun if you don't want to overwrite others settings.
1308 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1309 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1310 * \li Origin: leeming, 30 Mar 2004
1313 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1314 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1317 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1318 * \li Action: Move the current group in the upward direction in the
1319 structure of the document.
1320 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1321 the whole substructure of the group.
1322 * \li Syntax: outline-up
1323 * \li Origin: Vermeer, 23 Mar 2006
1326 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1328 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1329 * \li Action: Move the current group in the downward direction in the
1330 structure of the document.
1331 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1332 the whole substructure of the group.
1333 * \li Syntax: outline-down
1334 * \li Origin: Vermeer, 23 Mar 2006
1337 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1339 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1340 * \li Action: Moves the current group in the downward direction in the
1341 hierarchy of the document structure.
1342 * \li Notion: Part -> Chapter -> Section -> etc.
1343 * \li Syntax: outline-in
1344 * \li Origin: Vermeer, 23 Mar 2006
1347 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1349 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1350 * \li Action: Moves the current group in the upward direction in the
1351 hierarchy of the document structure.
1352 * \li Notion: Part <- Chapter <- Section <- etc.
1353 * \li Syntax: outline-out
1354 * \li Origin: Vermeer, 23 Mar 2006
1357 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1359 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1360 * \li Action: Edit the inset at cursor with an external application,
1361 * if one is attributed.
1362 * \li Syntax: inset-edit [<INSET_PARAMS>]
1363 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1364 Currently only the filename will be considered.
1365 * \li Origin: JSpitzm, 27 Apr 2006
1368 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1370 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1371 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1372 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1373 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1374 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1376 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1377 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1378 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1379 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1380 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1382 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1383 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1384 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1385 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1386 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1387 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1388 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1389 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1392 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1393 * \li Action: Apply data for an inset.
1394 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1395 be applied. This is either changed to #LFUN_INSET_MODIFY or
1396 #LFUN_INSET_INSERT depending on the context where it is called.
1397 * \li Syntax: inset-apply <ARGS>
1398 * \li Params: See #LFUN_INSET_INSERT .
1401 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1403 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1404 * \li Action: Dissolve the current inset into text.
1405 * \li Syntax: inset-dissolve [<INSET>]
1406 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1407 is dissolved. For example "dissolve" entry in the charstyles
1408 sub-menu should only dissolve the charstyle inset, even if the
1409 cursor is inside several nested insets of different type.\n
1410 For values see #lyx::InsetLayout::lyxtype_ .
1411 * \li Author: JSpitz, 7 Aug 2006
1414 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1416 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1417 * \li Action: Insert new inset (type given by the parameters).
1418 * \li Syntax: inset-insert <INSET> <ARGS>
1419 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1420 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1421 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1423 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1424 where <label name> is the name of the referenced label and
1425 <Format> is one of the following: \n
1426 ref -- <reference> \n
1427 eqref -- (<reference>) \n
1428 pageref -- <page> \n
1429 vpageref -- on <page> \n
1430 vref -- <reference> on <page> \n
1431 prettyref -- Formatted reference
1434 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1436 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1437 * \li Action: Modify existing inset.
1438 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1439 bibtex, ert, command, graphics, note, space, vspace, tabular,
1440 bibitem, inlude, ref insets.
1441 * \li Syntax: inset-modify <INSET> <ARGS>
1442 * \li Params: See #LFUN_INSET_INSERT for further details.
1445 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1447 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1448 * \li Action: Modify the inset at cursor position, if there is one.
1449 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1450 bibtex, ert, command, graphics, note, space, vspace, tabular,
1451 bibitem, inlude, ref insets.
1452 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1453 * \li Params: See #LFUN_INSET_INSERT for further details.
1454 * \li Origin: JSpitzm, 23 Mar 2008
1457 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1458 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1460 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1461 * \li Action: Open the inset's properties dialog.
1462 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1463 * \li Syntax: inset-settings <INSET>
1464 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1467 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1469 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1470 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1471 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1472 be entered. Also cf. #LFUN_INSET_SETTINGS.
1473 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1474 bibtex, ert, command, graphics, note, space, vspace, tabular,
1475 bibitem, inlude, ref insets.
1476 * \li Syntax: next-inset-toggle <ARG>
1477 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1478 * \li Origin: leeming, 30 Mar 2004
1481 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1483 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1484 * \li Action: Toggles the collapsable inset we are currently in.
1485 * \li Syntax: inset-toggle [<ARG>]
1486 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1487 open/close/toggle are for collapsable insets. close can be currently used
1488 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1489 assign is for branch inset.
1490 * \li Origin: lasgouttes, 19 Jul 2001
1493 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1495 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1496 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1497 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1498 * \li Syntax: all-insets-toggle <STATE> <INSET>
1499 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1500 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1501 * \li Origin: leeming, 30 Mar 2004
1504 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1506 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1507 * \li Action: Unify all graphics insets with the one given as an parameter.
1508 * \li Notion: This is internally used for synchronize certain group of graphics insets.
1509 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1510 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1511 (syntax can be seen in .lyx files).
1512 * \li Origin: sanda, 6 May 2008
1515 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1517 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1518 * \li Action: Set the group for the graphics inset on the cursor position.
1519 * \li Syntax: set-graphics-group [<GROUP>]
1520 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1521 the graphics inset is removed from the current group.
1522 * \li Origin: sanda, 6 May 2008
1525 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1528 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1529 * \li Action: Moves the cursor out of the current slice, going forward.
1530 * \li Notion: Cursor movement within an inset may be different than cursor
1531 movement in the surrounding text. This action should be called
1532 automatically by the cursor movement within the inset, when
1533 movement within the inset has ceased (reached the end of the
1534 last paragraph, for example), in order to move correctly
1535 back into the surrounding text.
1538 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1540 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1541 * \li Action: Moves the cursor out of the current slice, going backwards.
1542 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1545 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1547 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1548 * \li Action: Moves the cursor out of the current slice, going right.
1549 * \li Notion: See also #LFUN_FINISHED_FORWARD
1552 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1554 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1555 * \li Action: Moves the cursor out of the current slice, going left.
1556 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1559 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1561 { LFUN_LANGUAGE, "language", Noop, Edit },
1564 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1565 * \li Action: Goto a label.
1566 * \li Syntax: label-goto [<LABEL>]
1567 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1568 is on cursor position, Bookmark 0 is saved and
1569 cursor moves to the position of referenced label.
1570 * \li Origin: Ale, 6 Aug 1997
1573 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1575 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1576 * \li Action: Inserts label to text or displayed formula.
1577 * \li Syntax: label-insert [<LABEL>]
1578 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1579 name will be opened.
1582 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1584 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1585 * \li Action: Go to the next label or cross-reference.
1586 * \li Syntax: reference-next
1587 * \li Origin: Dekel, 14 Jan 2001
1590 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1593 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1594 * \li Action: Goto a bookmark.
1595 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1596 if necessary. Note that bookmarsk are saved per-session, not
1598 * \li Syntax: bookmark-goto <NUMBER>
1599 * \li Params: <NUMBER>: the number of the bookmark to restore.
1600 * \li Origin: Dekel, 27 January 2001
1603 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1605 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1606 * \li Action: Save a bookmark.
1607 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1608 must be between 1 and 9, inclusive. Note that bookmarks are
1609 saved per-session, not per file.
1610 * \li Syntax: bookmark-save <NUMBER>
1611 * \li Params: <NUMBER>: the number of the bookmark to save.
1612 * \li Origin: Dekel, 27 January 2001
1615 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1617 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1618 * \li Action: Clears the list of saved bookmarks.
1619 * \li Syntax: bookmark-clear
1620 * \li Origin: bpeng, 31 October 2006
1623 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1626 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1627 * \li Action: Open the given help file according to the language setting.
1628 * \li Syntax: help-open <FILE>[.lyx]
1629 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1630 * \li Author: Jug, 27 Jun 1999
1633 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1635 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1636 * \li Action: Terminates the current LyX instance.
1637 * \li Notion: Terminates the current LyX instance, asking whether to save
1638 modified documents, etc.
1639 * \li Syntax: lyx-quit
1642 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1644 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1645 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1646 * \li Notion: Skiping "auto" when allowauto is false.
1647 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1648 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1649 minibuffer|review|view/update|math_panels
1650 * \li Origin: Edwin, 21 May 2007
1653 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1655 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1656 * \li Action: Opens the menu given by its name.
1657 * \li Syntax: menu-open <NAME>
1658 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1661 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1663 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1664 * \li Action: Various UI visibility-toggling actions.
1665 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1666 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1667 menubar : Toggle visibility of the menubar.\n
1668 scrollbar : Toggle visibility of the scrollbar.\n
1669 frame : Toggle visibility of the frames around editing window.\n
1670 fullscreen : Toggle fullscreen mode. This also covers calling the
1671 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1672 custom tweaks of the toolbars should be used.
1673 * \li Origin: ps, 9 Feb 2007
1676 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1679 * \var lyx::FuncCode lyx::WINDOW_NEW
1680 * \li Action: Creates new empty LyX window.
1681 * \li Notion: Already opened documents from the previous window can be found under View menu.
1682 * \li Syntax: window-new [<GEOMETRY>]
1683 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1684 accepted only on Windows platform.
1685 * \li Origin: Abdel, 21 Oct 2006
1688 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1690 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1691 * \li Action: Closes the current LyX window.
1692 * \li Syntax: window-close
1693 * \li Origin: Abdel, 23 Oct 2006
1696 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1699 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1700 * \li Action: Creates another split view of current buffer.
1701 * \li Notion: All split views act in the same way indpendently.
1702 * \li Syntax: split-view <vertical|horizontal>
1703 * \li Params: horizontal : The work areas are laid out side by side.\n
1704 vertical : The work areas laid out vertically.\n
1705 * \li Origin: abdel, 20 Feb 2008
1708 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1711 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1712 * \li Action: Close the current tab group.
1713 * \li Notion: This only closes the work areas, not the buffer themselves.
1714 The still opened buffers can be visualized in another tab group.
1715 * \li Syntax: close-tab-group
1716 * \li Origin: abdel, 21 Feb 2008
1719 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1720 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1721 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1722 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1723 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1724 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1725 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1727 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1728 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1729 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1730 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1731 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1733 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1734 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1735 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1736 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1738 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1740 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1741 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1742 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1744 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1745 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1746 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1747 * \li Origin: Edmar, 23 Dec 1998
1750 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1751 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1753 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1754 * \li Action: Sets the cursor position based on the editing area coordinates
1755 (similar as clicking on that point with left mouse button).
1756 * \li Syntax: server-set-xy <X> <Y>
1759 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1761 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1762 * \li Action: Returns the coordinates of cursor position in the editing area.
1763 * \li Syntax: server-get-xy
1766 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1769 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1770 * \li Action: Generates the code (literate programming).
1771 * \li Notion: Latex file with extension \literate_extension is generated.
1772 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1773 \build_error_filter to process the compilation error messages. \n
1774 In case you want to process your literate file with a script, or some other program,
1775 just insert in your lyxrc file an entry with:\n
1776 \build_command "my_script my_arguments" \n
1777 The \build_error_filter differs from the \literate_error_filter only in that the
1778 former will identify error messages from your compiler.
1779 * \li Syntax: build-program
1782 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1785 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1786 * \li Action: Saves the current buffer to a temporary file.
1787 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1788 is called automatically by LyX, to "autosave" the current buffer.
1789 * \li Syntax: buffer-auto-save
1792 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1794 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1795 * \li Action: Loads the given child document.
1796 * \li Notion: The current document is treated as a parent.
1797 * \li Syntax: buffer-child-open <FILE>
1798 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1799 * \li Origin: Ale, 28 May 1997
1802 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1804 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1805 * \li Action: Runs chktex for the current document.
1806 * \li Syntax: buffer-chktex
1807 * \li Origin: Asger, 30 Oct 1997
1810 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1812 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1813 * \li Action: Toggles compression of the current document on/off.
1814 * \li Syntax: buffer-toggle-compression
1815 * \li Origin: bpeng, 27 Apr 2006
1818 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1820 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1821 * \li Action: Closes the current buffer.
1822 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1823 if the buffer has been modified.
1824 * \li Syntax: buffer-close
1827 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1829 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1830 * \li Action: Exports the current buffer (document) to the given format.
1831 * \li Syntax: buffer-export <FORMAT>
1832 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1833 can find in Tools->Preferences->File formats->Format.
1834 Usual format you will enter is "pdf2" (pdflatex),
1835 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1836 In case of "custom" you will be asked for a format you
1837 want to start from and for the command that you want to
1838 apply to this format. Internally the control is then passed
1839 to #LFUN_BUFFER_EXPORT_CUSTOM.
1840 * \li Origin: Lgb, 29 Jul 1997
1843 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1845 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1846 * \li Action: Exports the current buffer (document) from the given format using
1847 the given command on it.
1848 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1849 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1850 intermediate file).\n
1851 <COMMAND> this command will be launched on the file. Note that you can
1852 use "$$FName" string to qualify the intermediate file.
1853 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1854 * \li Origin: leeming, 27 Mar 2004
1857 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1859 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1860 * \li Action: Prints the current document.
1861 * \li Notion: Many settings can be given via the preferences dialog.
1862 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1863 * \li Params: <TARGET> is either "printer" or "file".\n
1864 <TARGER-NAME> is either "default" or file name or printer name.\n
1865 <COMMAND> command ensuring the printing job.
1866 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1867 * \li Origin: leeming, 28 Mar 2004
1870 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1872 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1873 * \li Action: Import a given file as a lyx document.
1874 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1875 defined convertors in preferences. Look into File->Import menu to get
1876 an idea of the currently active import formats.
1877 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1878 * \li Origin: Asger, 24 Jul 1998
1881 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1883 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1884 * \li Action: Creates a new buffer (that is, document).
1885 * \li Notion: Implicit path can be set in Preferences dialog.
1886 * \li Syntax: buffer-new [<FILE>]
1887 * \li Params: <FILE>: filename of created file with absolute path.
1890 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1892 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1893 * \li Action: Creates a new buffer (that is, document) from a template.
1894 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1895 Template will be asked for via Open-dialog.
1896 * \li Syntax: buffer-new-template [<FILE>]
1897 * \li Params: <FILE>: filename of created file with absolute path.
1900 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1902 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1903 * \li Action: Reverts opened document.
1904 * \li Syntax: buffer-reload
1905 * \li Origin: Asger, 2 Feb 1997
1908 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1910 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1911 * \li Action: Switch to the given buffer.
1912 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1913 document in different LyX windows.
1914 * \li Syntax: buffer-new-template <BUFFER>
1915 * \li Params: <BUFFER>: already opened document which is to be shown.
1918 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1920 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1921 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1922 * \li Syntax: buffer-toggle-read-only
1923 * \li Origin: Lgb, 27 May 1997
1926 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1928 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1929 * \li Action: Displays current buffer in chosen format.
1930 * \li Notion: Displays the contents of the current buffer in the chosen
1931 format, for example, PDF or DVI. This runs the necessary
1932 converter, calls the defined viewer, and so forth.
1933 * \li Syntax: buffer-view <FORMAT>
1934 * \li Params: <FORMAT>: The format to display, where this is one of the
1935 formats defined (in the current GUI) in the
1936 Tools>Preferences>File Formats dialog.
1939 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1941 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1942 * \li Action: Exports the current document and put the result into the
1943 temporary directory.
1944 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1945 the output will be rewriten - updated. This is useful in case your viewer
1946 is able to detect such changes (e.g. ghostview for postscript).
1947 * \li Syntax: buffer-update <FORMAT>
1948 * \li Params: <FORMAT>: The format to display, where this is one of the
1949 formats defined (in the current GUI) in the
1950 Tools>Preferences>File Formats dialog.
1951 * \li Origin: Dekel, 5 Aug 2000
1954 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1957 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1958 * \li Action: Saves the current buffer.
1959 * \li Notion: Saves the current buffer to disk, using the filename that
1960 is already associated with the buffer, asking for one if
1961 none is yet assigned.
1962 * \li Syntax: buffer-write
1965 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1967 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1968 * \li Action: Rename and save current buffer.
1969 * \li Syntax: buffer-write-as <FILENAME>
1970 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1971 is with respect to the original location of the buffer/file.
1974 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1976 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1977 * \li Action: Save all changed documents.
1978 * \li Syntax: buffer-write-all
1979 * \li Origin: rgh, gpothier 6 Aug 2007
1982 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1984 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
1985 * \li Action: Switch to the next opened document.
1986 * \li Notion: Note that this does not necessarily mean next in tabbar
1987 (for full list see View menu).
1988 * \li Syntax: buffer-next
1991 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1993 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
1994 * \li Action: Switch to the previous opened document.
1995 * \li Syntax: buffer-previous
1998 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2000 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2001 * \li Action: When run from a child document, this updates (exports) document built
2002 from the master buffer. If a master is not found, it updates the
2004 * \li Syntax: master-buffer-update
2005 * \li Author: Tommaso, 20 Sep 2007
2008 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2010 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2011 * \li Action: When run from a child document, this command shows a preview built
2012 from the master buffer. If a master is not found, it previews the
2014 * \li Syntax: master-buffer-view
2015 * \li Author: Tommaso, 20 Sep 2007
2018 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2020 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2021 * \li Action: Set language of the current document.
2022 * \li Syntax: buffer-language <LANG>
2023 * \li Params: <LANG>: language name. See lib/languages for list.
2024 * \li Author: leeming, 30 Mar 2004
2027 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2029 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2030 * \li Action: Save the current document settings as default.
2031 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2032 * \li Syntax: buffer-save-as-default [<ARGS>]
2033 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2034 you can find in document header of usual .lyx file.
2035 * \li Author: leeming, 30 Mar 2004
2038 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2040 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2041 * \li Action: Apply the given settings to the current document.
2042 * \li Syntax: buffer-params-apply [<ARGS>]
2043 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2044 you can find in document header of usual .lyx file.
2045 * \li Author: leeming, 30 Mar 2004
2048 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2051 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2052 * \li Action: Inserts another LyX file.
2053 * \li Syntax: file-insert [<FILE>]
2054 * \li Params: <FILE>: Filename to be inserted.
2057 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2059 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2060 * \li Action: Inserts plain text file.
2061 * \li Syntax: file-insert-plaintext [<FILE>]
2062 * \li Params: <FILE>: Filename to be inserted.
2063 * \li Origin: CFO-G, 19 Nov 1997
2066 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2068 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2069 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2070 * \li Syntax: file-insert-plaintext-para [<FILE>]
2071 * \li Params: <FILE>: Filename to be inserted.
2072 * \li Origin: Levon, 14 Feb 2001
2075 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2077 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2078 * \li Action: Open LyX document.
2079 * \li Syntax: file-open [<FILE>]
2080 * \li Params: <FILE>: Filename to be opened.
2083 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2086 * \var lyx::FuncCode lyx::LFUN_CALL
2087 * \li Action: Executes a command defined in a .def file.
2088 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2089 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2090 where <NAME> is the name of the new command and <LFUN> is the lfun code
2091 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2092 \\def_file "FileName" allows to include another .def file. \n
2093 This is particularly useful in connection with toolbar buttons:
2094 Since the name of the button image for this lfun is
2095 lib/images/commands/<NAME>.png this is the way to assign an image
2096 to a complex command-sequence.
2097 * \li Syntax: call <NAME>
2098 * \li Params: <NAME>: Name of the command that must be called.
2099 * \li Origin: broider, 2 Oct 2007
2102 { LFUN_CALL, "call", NoBuffer, System },
2104 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2105 * \li Action: Simulate halting Meta key (Alt key on PCs).
2106 * \li Notion: Used for buffer editation not for GUI control.
2107 * \li Syntax: meta-prefix
2110 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2112 * \var lyx::FuncCode lyx::LFUN_CANCEL
2113 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2114 * \li Syntax: cancel
2117 { LFUN_CANCEL, "cancel", NoBuffer, System },
2120 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2121 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2122 * \li Notion: Usually bound to M-x shortcut.
2123 * \li Syntax: command-execute
2126 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2127 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2129 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2130 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2131 * \li Syntax: command-sequence <CMDS>
2132 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2133 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2134 * \li Origin: Andre', 11 Nov 1999
2137 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2139 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2140 * \li Action: Shows message in statusbar (for script purposes).
2141 * \li Syntax: message <STRING>
2142 * \li Origin: Lgb, 8 Apr 2001
2145 { LFUN_MESSAGE, "message", NoBuffer, System },
2147 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2148 * \li Action: Save user preferences.
2149 * \li Syntax: preferences-save
2150 * \li Origin: Lgb, 27 Nov 1999
2153 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2155 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2156 * \li Action: Reconfigure the automatic settings.
2157 * \li Syntax: reconfigure
2158 * \li Origin: Asger, 14 Feb 1997
2161 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2163 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2164 * \li Action: Apply the given settings to user preferences.
2165 * \li Syntax: lyxrc-apply <SETTINGS>
2166 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2167 to get an idea which commands to use and their syntax.
2168 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2171 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2173 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2174 * \li Action: Determine whether keep cursor inside the editing window regardless
2175 the scrollbar movement.
2176 * \li Syntax: toggle-cursor-follows-scrollbar
2177 * \li Origin: ARRae, 2 Dec 1997
2180 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2182 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2183 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2184 * \li Notion: A new color entry is created if the color is unknown.
2185 Color names can be stored as a part of user settings.
2186 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2187 * \li Origin: SLior, 11 Jun 2000
2190 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2192 * \var lyx::FuncCode lyx::LFUN_STATISTICS
2193 * \li Action: Count the statistics (number of words and characters)
2194 in the document or in the given selection.
2195 * \li Notion: Note that this function gives the number of words/chars written,
2196 not the number of characters which will be typeset.
2197 * \li Syntax: statistics
2198 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2201 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2203 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2204 * \li Action: Show the inline completion at the cursor position.
2205 * \li Syntax: completion-inline
2206 * \li Origin: sts, Feb 19 2008
2209 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2211 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2212 * \li Action: Show the completion popup at the cursor position.
2213 * \li Syntax: completion-popup
2214 * \li Origin: sts, Feb 19 2008
2217 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2219 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2220 * \li Action: Try to complete the word or command at the cursor position.
2221 * \li Syntax: completion-complete
2222 * \li Origin: sts, Feb 19 2008
2225 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2227 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2228 * \li Action: Activate the branch
2229 * \li Syntax: branch-activate <BRANCH>
2230 * \li Params: <BRANCH>: The branch to activate
2231 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2232 could be used to export a pdf with the answers branch included
2233 without one's having to open LyX and activate the branch manually.
2234 * \li Origin: rgh, 27 May 2008
2237 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2239 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2240 * \li Action: De-activate the branch
2241 * \li Syntax: branch-deactivate <BRANCH>
2242 * \li Params: <BRANCH>: The branch to deactivate
2243 * \li Origin: rgh, 27 May 2008
2246 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2248 { LFUN_NOACTION, "", Noop, Hidden }
2249 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2252 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2253 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2260 LyXAction::LyXAction()
2266 // Returns an action tag from a string.
2267 FuncRequest LyXAction::lookupFunc(string const & func) const
2269 string const func2 = trim(func);
2271 if (func2.empty()) {
2272 return FuncRequest(LFUN_NOACTION);
2276 string const arg = split(func2, cmd, ' ');
2278 func_map::const_iterator fit = lyx_func_map.find(cmd);
2280 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2284 string const LyXAction::getActionName(FuncCode action) const
2286 info_map::const_iterator const it = lyx_info_map.find(action);
2287 return it != lyx_info_map.end() ? it->second.name : string();
2291 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2293 info_map::const_iterator const it = lyx_info_map.find(action);
2294 return it != lyx_info_map.end() ? it->second.type : Hidden;
2298 bool LyXAction::funcHasFlag(FuncCode action,
2299 LyXAction::func_attrib flag) const
2301 info_map::const_iterator ici = lyx_info_map.find(action);
2303 if (ici == lyx_info_map.end()) {
2304 LYXERR0("action: " << action << " is not known.");
2305 LASSERT(false, /**/);
2308 return ici->second.attrib & flag;
2312 LyXAction::const_func_iterator LyXAction::func_begin() const
2314 return lyx_func_map.begin();
2318 LyXAction::const_func_iterator LyXAction::func_end() const
2320 return lyx_func_map.end();