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 },
283 * \var lyx::FuncCode lyx::LFUN_FLOAT_WIDE_INSERT
284 * \li Action: Inserts float insets as in #LFUN_FLOAT_INSERT but span multiple columns.
285 * \li Notion: Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
286 * \li Syntax: float-wide-insert <TYPE>
287 * \li Params: <TYPE>: type of float depends on the used textclass. Usually
288 "algorithm", "table", "figure" parameters can be given.
289 * \li Origin: Lgb, 31 Oct 2001
292 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
294 * \var lyx::FuncCode lyx::LFUN_WRAP_INSERT
295 * \li Action: Inserts floats wrapped by the text around.
296 * \li Syntax: wrap-insert <TYPE>
297 * \li Params: <TYPE>: table|figure
298 * \li Origin: Dekel, 7 Apr 2002
301 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
303 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
304 * \li Action: Inserts an optional-argument (short title) inset.
305 * \li Syntax: optional-insert
306 * \li Origin: Martin, 12 Aug 2002
309 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
311 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
312 * \li Action: Inserts a horizontal line.
313 * \li Syntax: line-insert
314 * \li Origin: poenitz, Oct 27 2003
317 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
319 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
320 * \li Action: Inserts a new page.
321 * \li Syntax: newpage-insert<ARG>
322 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
323 * \li Origin: uwestoehr, 24 Nov 2007
326 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
328 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
329 * \li Action: Inserts a marginal note.
330 * \li Syntax: marginalnote-insert
331 * \li Origin: Lgb, 26 Jun 2000
334 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
336 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
337 * \li Action: Inserts a single unicode character.
338 * \li Syntax: unicode-insert <CHAR>
339 * \li Params: <CHAR>: The character to insert, given as its code
340 point, in hexadecimal, e.g.: unicode-insert 0x0100.
341 * \li Origin: Lgb, 22 Oct 2006
344 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
346 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
347 * \li Action: Inserts a new listings inset.
348 * \li Syntax: listing-insert
349 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
352 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
354 * \var lyx::FuncCode lyx::LFUN_QUOTE_INSERT
355 * \li Action: Inserts quotes according to the type and quote-language preference.
356 * \li Action: Currently English, Swedish, German, Polish, French, Danish quotes
358 * \li Syntax: quote-insert [<TYPE>]
359 * \li Params: TYPE: 'single' for single quotes, otherwise double quotes will be used.
362 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
364 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
365 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
366 information in a non-editable boxed InsetText.
367 * \li Notion: Apart from lfun arguments you can use the following method: \n
368 1. input the type and argument of this inset, e.g. "menu paste", in
370 2. select the text and run info-insert lfun.\n
371 * \li Syntax: info-insert <TYPE> <ARG>
372 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
373 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
375 * \li Origin: bpeng, 7 Oct 2007
378 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
380 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
381 * \li Action: Inserts branch inset.
382 * \li Syntax: branch-insert <BRANCH-NAME>
383 * \li Origin: vermeer, 17 Aug 2003
386 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
388 * \var lyx::FuncCode lyx::LFUN_BOX_INSERT
389 * \li Action: Inserts Box inset.
390 * \li Syntax: box-insert [<TYPE>]
391 * \li Params: <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox \n
392 Framed is the default one.
393 * \li Origin: vermeer, 7 Oct 2003
396 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
398 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
399 * \li Action: Inserts CharStyle, Custom inset or XML short element.
400 * \li Notion: Look into the Customization manual for more information about
402 For dissolving the element see #LFUN_INSET_DISSOLVE.
403 * \li Syntax: flex-insert <TYPE:Name>
404 * \li Params: TYPE: CharStyle|Custom|Element|Standard
405 Identifies whether this is a Character Style, a
406 Custom Inset or an XML Element, and which dynamical
407 sub-menu this flex inset is in on the LyX menu tree.
408 If Standard (currently unused): none of these.
409 Name: This name must be defined either in your layout file
410 or imported by some module. The definition is\n
411 InsetLayout <TYPE:Name>
412 * \li Sample: flex-insert CharStyle:Code
415 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
417 * \var lyx::FuncCode lyx::LFUN_SELF_INSERT
418 * \li Action: Inserts the given string (accordingly to the correct keymap).
419 * \li Notion: Automatically replace the currently selected text. Depends on lyxrc
420 settings "auto_region_delete".
421 * \li Syntax: self-insert <STRING>
424 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
426 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
427 * \li Action: Inserts one of horizontal space insets.
428 * \li Syntax: space-insert <NAME> [<LEN>]
429 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
430 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
432 <LEN>: length for custom spaces (hspace, hspace* for protected)
433 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
436 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
438 * \var lyx::FuncCode lyx::LFUN_HYPERLINK_INSERT
439 * \li Action: Inserts hyperlinks into the document (clickable in pdf output).
440 * \li Notion: Hyperlink target can be set via selection + hyperlink-insert function.
441 * \li Syntax: href-insert [<TARGET>]
442 * \li Origin: CFO-G, 21 Nov 1997
445 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
447 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
448 * \li Action: Inserts various characters into the document.
449 * \li Syntax: specialchar-insert <CHAR>
450 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
451 end-of-sentence, menu-separator.
452 * \li Origin: JSpitzm, 6 Dec 2007
455 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
457 * \var lyx::FuncCode lyx::LFUN_TOC_INSERT
458 * \li Action: Inserts table of contents.
459 * \li Syntax: toc-insert
460 * \li Origin: Lgb, 27 May 97
463 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
465 * \var lyx::FuncCode lyx::LFUN_APPENDIX
466 * \li Action: Start (or remove) Appendix on the given cursor position.
467 * \li Syntax: appendix
468 * \li Origin: ettrich, 5 May 1998
471 { LFUN_APPENDIX, "appendix", Noop, Edit },
473 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
474 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
476 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
477 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
479 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
480 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
482 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
483 * \li Action: Inserts a line break or new line.
484 * \li Syntax: newline-insert <ARG>
485 * \li Params: <ARG>: <newline|linebreak> default: newline
486 * \li Origin: JSpitzm, 25 Mar 2008
489 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
493 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
497 * \var lyx::FuncCode lyx::LFUN_ESCAPE
498 * \li Action: Clears the selection. If no text is selected call #LFUN_FINISHED_FORWARD.
500 * \li Origin: Lgb, 17 May 2001
503 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
504 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
505 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
506 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
507 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
508 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
509 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
510 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
511 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
513 * \var lyx::FuncCode lyx::LFUN_SCROLL
514 * \li Action: Scroll the buffer view.
515 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
516 * \li Syntax: scroll <TYPE> <QUANTITY>
517 * \li Params: <TYPE>: line|page\n
518 <QUANTITY>: up|down|<number>
519 * \li Origin: Abdelrazak Younes, Dec 27 2007
522 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
524 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
525 * \li Action: Recenters the screen on the current cursor position.
526 * \li Syntax: screen-recenter
529 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
530 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
531 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
533 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
535 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
536 * \li Action: Moves the cursor one position logically backwards.
537 * \li Notion: This is not the action which should be bound to the arrow keys,
538 because backwards may be left or right, depending on the
539 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
540 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
541 * \li Syntax: char-backward
544 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
546 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
547 * \li Action: Moves the cursor one position logically backwards, adding
548 traversed position to the selection.
549 * \li Notion: See also #LFUN_CHAR_BACKWARD.
550 * \li Syntax: char-backward-select
553 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
554 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
555 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
557 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
558 * \li Action: Moves the cursor one position logically forward.
559 * \li Notion: This is not the action which should be bound to the arrow keys,
560 because forward may be left or right, depending on the language.
561 The arrow keys should be bound to #LFUN_CHAR_LEFT or
562 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
563 * \li Syntax: char-forward
566 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
568 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
569 * \li Action: Moves the cursor one position logically forward, adding
570 traversed position to the selection.
571 * \li Notion: See also #LFUN_CHAR_FORWARD.
572 * \li Syntax: char-forward-select
575 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
577 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
578 * \li Action: Moves the cursor one position "to the left".
579 * \li Notion: This is the action which should be taken when the "left" key
580 is pressed. Generally, it moves the cursor one position to the
581 left. However, in Bidi text this become slightly more
582 complicated, and there are different modes of cursor movement.
583 In "visual mode", this moves left, plain and simple. In "logical
584 mode", movement is logically forward in RTL paragraphs, and
585 logically backwards in LTR paragraphs.
586 * \li Syntax: char-left
589 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
591 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
592 * \li Action: Moves the cursor one position "to the left", adding
593 traversed position to the selection.
594 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
595 * \li Syntax: char-left-select
598 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
600 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
601 * \li Action: Moves the cursor one position "to the right".
602 * \li Notion: This is the action which should be taken when the "right" key
603 is pressed. Generally, it moves the cursor one position to the
604 right. However, in Bidi text this become slightly more
605 complicated, and there are different modes of cursor movement.
606 In "visual mode", this moves right, plain and simple. In "logical
607 mode", movement is logically forward in LTR paragraphs, and
608 logically backwards in RTL paragraphs.
609 * \li Syntax: char-right
612 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
614 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
615 * \li Action: Moves the cursor one position "to the right", adding
616 traversed position to the selection.
617 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
618 * \li Syntax: char-right-select
621 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
624 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
625 * \li Action: Moves the cursor to the logically previous beginning of a word.
626 * \li Notion: This is not the action which should be bound to the arrow keys,
627 because backwards may be left or right, depending on the
628 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
629 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
630 * \li Syntax: word-backward
633 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
635 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
636 * \li Action: Moves the cursor to the logically previous beginning of a word,
637 adding the logically traversed text to the selection.
638 * \li Notion: See also #LFUN_WORD_BACKWARD.
639 * \li Syntax: word-backward-select
642 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
643 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
644 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
646 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
647 * \li Action: Search for a given string in forward direction.
648 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
649 * \li Syntax: word-find-forward [<STRING>]
650 * \li Origin: Etienne, 16 Feb 1998
653 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
655 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
656 * \li Action: Search for a given string in backward direction.
657 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
658 * \li Syntax: word-find-backward [<STRING>]
659 * \li Origin: Etienne, 20 Feb 1998
662 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
664 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
665 * \li Action: Search for next occurence of a string.
666 * \li Syntax: word-find [<DATA>]
667 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
668 If no parameter is given, search with last find-dialog
669 data is used for search (i.e. find-next).
670 * \li Origin: poenitz, Jan 7 2004
673 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
674 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
676 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
677 * \li Action: Moves the cursor to the logically next beginning of a word.
678 * \li Notion: This is not the action which should be bound to the arrow keys,
679 because forward may be left or right, depending on the language.
680 The arrow keys should be bound to #LFUN_WORD_LEFT or
681 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
682 * \li Syntax: word-forward
685 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
687 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
688 * \li Action: Moves the cursor to the logically next beginning of a word,
689 adding the logically traversed text to the selection.
690 * \li Notion: See also #LFUN_WORD_FORWARD.
691 * \li Syntax: word-forward-select
694 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
696 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
697 * \li Action: Moves the cursor to the next beginning of a word "on the left".
698 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
699 "left" key is pressed. Generally, it moves the cursor to the
700 next beginning of a word on the left. However, in Bidi text this
701 become slightly more complicated, and there are different modes
702 of cursor movement. In "visual mode", this moves left, plain and
703 simple. In "logical mode", movement is logically forward in RTL
704 paragraphs, and logically backwards in LTR paragraphs.
705 * \li Syntax: word-left
706 * \li Origin: dov, 28 Oct 2007
709 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
711 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
712 * \li Action: Moves the cursor to the next beginning of a word "on the left",
713 adding *logically* traversed text to the selection.
714 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
715 * \li Syntax: word-left-select
716 * \li Origin: dov, 28 Oct 2007
719 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
721 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
722 * \li Action: Moves the cursor to the next beginning of a word "on the right".
723 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
724 "right" key is pressed. Generally, it moves the cursor to the
725 next beginning of a word on the right. However, in Bidi text
726 this become slightly more complicated, and there are different
727 modes of cursor movement. In "visual mode", this moves right,
728 plain and simple. In "logical mode", movement is logically
729 forward in LTR paragraphs, and logically backwards in RTL
731 * \li Syntax: word-right
732 * \li Origin: dov, 28 Oct 2007
735 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
737 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
738 * \li Action: Moves the cursor to the next beginning of a word "on the right",
739 adding *logically* traversed text to the selection.
740 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
741 * \li Syntax: word-right-select
742 * \li Origin: dov, 28 Oct 2007
745 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
746 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
748 * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
749 * \li Action: Capitalizes the words in the selection (i.e. the first letters)
750 or the letter on the cursor position.
751 * \li Syntax: word-capitalize
754 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
756 * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
757 * \li Action: Change the words in the selection or from the cursor position
758 to the end of word to the upper case.
759 * \li Syntax: word-upcase
762 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
764 * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
765 * \li Action: Change the words in the selection or from the cursor position
766 to the end of word to the lower case.
767 * \li Syntax: word-lowcase
770 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
772 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
773 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
774 * \li Syntax: thesaurus-entry
775 * \li Origin: Levon, 20 Jul 2001
778 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
779 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
780 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
781 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
782 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
784 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
785 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
786 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
787 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
788 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
790 * \var lyx::FuncCode lyx::LFUN_COPY
791 * \li Action: Copies to the clipboard the last edit.
795 { LFUN_COPY, "copy", ReadOnly, Edit },
797 * \var lyx::FuncCode lyx::LFUN_CUT
798 * \li Action: Cuts to the clipboard.
802 { LFUN_CUT, "cut", Noop, Edit },
804 * \var lyx::FuncCode lyx::LFUN_PASTE
805 * \li Action: Pastes from the active clipboard.
809 { LFUN_PASTE, "paste", Noop, Edit },
810 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
812 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
813 * \li Action: Pastes the material currently selected.
814 * \li Syntax: primary-selection-paste
817 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
819 * \var lyx::FuncCode lyx::LFUN_UNDO
820 * \li Action: Undoes the last edit.
824 { LFUN_UNDO, "undo", Noop, Edit },
826 * \var lyx::FuncCode lyx::LFUN_REDO
827 * \li Action: Redoes the last thing undone.
831 { LFUN_REDO, "redo", Noop, Edit },
833 * \var lyx::FuncCode lyx::LFUN_REPEAT
834 * \li Action: Repeat the given command.
835 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
836 * \li Author: poenitz, 27 Oct 2003
839 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
841 * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
842 * \li Action: Transposes the character at the cursor with the one before it.
843 * \li Syntax: chars-transpose
844 * \li Author: Lgb, 25 Apr 2001
847 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
849 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
850 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
851 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
854 * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
855 * \li Action: Toggles the bold font (selection-wise).
856 * \li Syntax: font-bold
859 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
861 * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
862 * \li Action: Toggles the typewriter family font (selection-wise).
863 * \li Syntax: font-typewriter
866 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
868 * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
869 * \li Action: Toggles underline in the font (selection-wise).
870 * \li Syntax: font-underline
873 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
875 * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
876 * \li Action: Toggles the emphasis font style (selection-wise).
877 * \li Syntax: font-emph
880 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
882 * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
883 * \li Action: Toggles Noun text style font (selection-wise).
884 * \li Syntax: font-noun
887 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
889 * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
890 * \li Action: Toggles Roman family font (selection-wise).
891 * \li Syntax: font-roman
894 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
896 * \var lyx::FuncCode lyx::LFUN_FONT_SANS
897 * \li Action: Toggles Sans Serif family font (selection-wise).
898 * \li Syntax: font-sans
901 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
903 * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
904 * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
905 * \li Syntax: font-frak
906 * \li Origin: vermeer, 10 Jan 2002
909 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
911 * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
912 * \li Action: Toggles Italics font shape (math-mode, selection-wise).
913 * \li Syntax: font-ital
914 * \li Origin: vermeer, 10 Jan 2002
917 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
919 * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
920 * \li Action: Reverts the settings of the font to the default values (selection-wise).
921 * \li Syntax: font-default
924 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
925 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
926 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
927 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
928 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
930 * \var lyx::FuncCode lyx::LFUN_FONT_STATE
931 * \li Action: Returns the info about the current font.
932 * \li Syntax: font-state
935 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
937 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
938 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
939 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
940 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
943 * \var lyx::FuncCode lyx::LFUN_LAYOUT
944 * \li Action: Sets the layout (that is, environment) for the current paragraph.
945 * \li Syntax: layout <LAYOUT>
946 * \li Params: <LAYOUT>: the layout to use
949 { LFUN_LAYOUT, "layout", Noop, Layout },
951 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
952 * \li Action: Launches the paragraph settings dialog.
953 * \li Syntax: layout-paragraph
956 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
958 * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
959 * \li Action: Launches the tabular settings dialog.
960 * \li Syntax: layout-tabular
961 * \li Origin: Jug, 31 Jul 2000
964 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
966 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
967 * \li Action: Displays list of layout choices.
968 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
969 dropbox allowing for choice of layout.
970 * \li Syntax: drop-layouts-choice
973 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
975 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
976 * \li Action: Clears the module list.
977 * \li Notion: Clears the list of included modules for the current buffer.
978 * \li Syntax: layout-modules-clear
979 * \li Origin: rgh, 25 August 2007
982 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
984 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
985 * \li Action: Adds a module.
986 * \li Notion: Adds a module to the list of included modules for the current buffer.
987 * \li Syntax: layout-module-add <MODULE>
988 * \li Params: <MODULE>: the module to be added
989 * \li Origin: rgh, 25 August 2007
992 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
994 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
995 * \li Action: Reloads layout information.
996 * \li Notion: Reloads all layout information for the current buffer from disk, thus
997 recognizing any changes that have been made to layout files on the fly.
998 This is intended to be used only by layout developers and should not be
999 used when one is trying to do actual work.
1000 * \li Syntax: layout-reload
1001 * \li Origin: rgh, 3 September 2007
1004 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1006 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1007 * \li Action: Sets the text class for the current buffer.
1008 * \li Syntax: textclass-apply <TEXTCLASS>
1009 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1010 the filename, minus the ".layout" extension.
1013 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1015 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1016 * \li Action: Loads information for a textclass from disk.
1017 * \li Syntax: textclass-load <TEXTCLASS>
1018 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1019 the filename, minus the ".layout" extension.
1022 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1025 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1026 * \li Action: Disable selecting of text-region.
1027 * \li Syntax: mark-off
1030 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1032 * \var lyx::FuncCode lyx::LFUN_MARK_ON
1033 * \li Action: Enable selecting of text-region.
1034 * \li Notion: After enabling you can simply move arrow keys to get selected region.
1035 * \li Syntax: mark-on
1038 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1040 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1041 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1042 * \li Syntax: mark-toggle
1043 * \li Origin: poenitz, May 5 2006
1046 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1048 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1049 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1050 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1051 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1052 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1053 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1054 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1055 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1056 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1057 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1058 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1059 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1060 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1062 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1063 * \li Action: Toggles numbering of the current formula line.
1064 * \li Notion: Must be in display formula mode.
1065 * \li Syntax: math-number-line-toggle
1066 * \li Origin: Alejandro 18 Jun 1996
1069 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1071 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1072 * \li Action: Toggles numbering/labeling of the current formula.
1073 * \li Notion: Must be in display formula mode.
1074 * \li Syntax: math-number-toggle
1075 * \li Origin: Alejandro 4 Jun 1996
1078 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1079 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1080 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1082 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1083 * \li Action: Unfold a Math Macro.
1084 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1086 * \li Syntax: math-macro-unfold
1087 * \li Origin: sts, 06 January 2008
1090 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1092 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1093 * \li Action: Fold a Math Macro.
1094 * \li Notion: Fold the Math Macro the cursor is in if it was
1095 unfolded, i.e. displayed as \foo before.
1096 * \li Syntax: math-macro-fold
1097 * \li Origin: sts, 06 January 2008
1100 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1102 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1103 * \li Action: Add a parameter.
1104 * \li Notion: Add a parameter to a Math Macro.
1105 * \li Params: <NUM>: The number of the parameter behind which the new one
1106 will be added (1 for the first, i.e. use 0 for add a
1107 parameter at the left), defaults to the last one.
1108 * \li Syntax: math-macro-add-param <NUM>
1109 * \li Origin: sts, 06 January 2008
1112 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1114 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1115 * \li Action: Remove the last parameter.
1116 * \li Notion: Remove the last parameter of a Math Macro and
1117 remove its value in all instances of the macro
1119 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1120 the first), defaults to the last one.
1121 * \li Syntax: math-macro-remove-param <NUM>
1122 * \li Origin: sts, 06 January 2008
1125 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1127 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1128 * \li Action: Append a greedy parameter.
1129 * \li Notion: Append a greedy parameter to a Math Macro which
1130 eats the following mathed cell in every instance of
1131 the macro in the buffer.
1132 * \li Syntax: math-macro-append-greedy-param
1133 * \li Origin: sts, 06 January 2008
1136 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1138 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1139 * \li Action: Remove a greedy parameter.
1140 * \li Notion: Remove a greedy parameter of a Math Macro and spit
1141 out the values of it in every instance of the macro
1142 in the buffer. If it is an optional parameter the [valud]
1144 * \li Syntax: math-macro-remove-greedy-param
1145 * \li Origin: sts, 06 January 2008
1148 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1150 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1151 * \li Action: Make a parameter optional.
1152 * \li Notion: Turn the first non-optional parameter of a Math Macro
1153 into an optional parameter with a default value.
1154 * \li Syntax: math-macro-make-optional
1155 * \li Origin: sts, 06 January 2008
1158 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1160 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1161 * \li Action: Make a parameter non-optional.
1162 * \li Notion: Turn the last optional parameter of a Math Macro
1163 into a non-optional parameter. The default value is
1164 remembered to be reused later if the user changes his mind.
1165 * \li Syntax: math-macro-make-nonoptional
1166 * \li Origin: sts, 06 January 2008
1169 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1171 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1172 * \li Action: Add an optional parameter.
1173 * \li Notion: Insert an optional parameter just behind the
1174 already existing optional parameters.
1175 * \li Syntax: math-macro-add-optional-param
1176 * \li Origin: sts, 06 January 2008
1179 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1181 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1182 * \li Action: Remove the last optional parameter.
1183 * \li Notion: Remove the last optional parameter of a Math Macro and
1184 remove it in all the instances of the macro in the buffer.
1185 * \li Syntax: math-macro-remove-optional-param
1186 * \li Origin: sts, 06 January 2008
1189 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1191 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1192 * \li Action: Add a greedy optional parameter.
1193 * \li Notion: Add a greedy optional parameter which eats the value
1194 from the following cells in mathed which are in the [value]
1196 * \li Syntax: math-macro-add-greedy-optional-param
1197 * \li Origin: sts, 06 January 2008
1200 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1202 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1203 * \li Action: Only active in Math Macro definition.
1204 * \li Notion: Dummy function which is only active in a Math Macro definition.
1205 It's used to toggle the Math Macro toolbar if the cursor moves
1206 into a Math Macro definition.
1207 * \li Syntax: in-mathmacrotemplate
1208 * \li Origin: sts, 06 January 2008
1211 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1214 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1215 * \li Action: Moves the current paragraph downwards in the document.
1216 * \li Syntax: paragraph-move-down
1217 * \li Origin: Edwin, 8 Apr 2006
1220 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1222 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1223 * \li Action: Moves the current paragraph upwards in the document.
1224 * \li Syntax: paragraph-move-up
1225 * \li Origin: Edwin, 8 Apr 2006
1228 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1231 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1232 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1233 in upward direction.
1234 * \li Syntax: paragraph-up
1235 * \li Origin: Asger, 1 Oct 1996
1238 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1240 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1241 * \li Action: Move the cursor and select the text to the next paragraph (or
1242 begining of the current one) in upward direction.
1243 * \li Syntax: paragraph-up-select
1244 * \li Origin: Asger, 1 Oct 1996
1247 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1249 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1250 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1251 in downward direction.
1252 * \li Syntax: paragraph-down
1253 * \li Origin: Asger, 1 Oct 1996
1256 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1258 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1259 * \li Action: Move the cursor and select the text to the next paragraph (or
1260 begining of the current one) in downward direction.
1261 * \li Syntax: paragraph-down-select
1262 * \li Origin: Asger, 1 Oct 1996
1265 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1267 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1268 * \li Action: Jump to a paragraph given by its id number and optionally the
1269 desired position within the paragraph.
1270 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1271 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1272 * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1273 * \li Params: <PAR_ID_NUMBER>: paragraph id
1274 <POSITION_IN_PAR>: desired position within the paragraph
1275 * \li Origin: Dekel, 26 Aug 2000
1278 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1280 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1281 * \li Action: Breaks the current paragraph at the current location.
1282 * \li Syntax: break-paragraph
1285 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1287 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1288 * \li Action: Breaks the current paragraph at the current location.
1289 * \li Notion: Removes the selection.
1290 * \li Syntax: break-paragraph [<LAYOUT>]
1291 * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1292 to default layout) when the cursor is at the end of
1296 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1298 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1299 * \li Action: Breaks the current paragraph at the current location,
1300 unless used at the beginning of a line, where it sets
1301 the label width string to empty.
1302 * \li Syntax: break-paragraph-skip
1305 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1307 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1308 * \li Action: Change paragraph settings.
1309 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1310 This function only modifies, and does not override, existing settings.
1311 Note that the "leftindent" indent setting is deprecated.
1312 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1313 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1314 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1315 <ALIGN>: \\align block|left|right|center|default\n
1316 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1317 * \li Origin: rgh, Aug 15 2007
1320 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1322 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1323 * \li Action: Change paragraph settings.
1324 * \li Notion: Overwrite all nonspecified settings to the default ones.
1325 Use paragraph-params lfun if you don't want to overwrite others settings.
1326 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1327 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1328 * \li Origin: leeming, 30 Mar 2004
1331 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1332 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1335 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1336 * \li Action: Move the current group in the upward direction in the
1337 structure of the document.
1338 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1339 the whole substructure of the group.
1340 * \li Syntax: outline-up
1341 * \li Origin: Vermeer, 23 Mar 2006
1344 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1346 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1347 * \li Action: Move the current group in the downward direction in the
1348 structure of the document.
1349 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1350 the whole substructure of the group.
1351 * \li Syntax: outline-down
1352 * \li Origin: Vermeer, 23 Mar 2006
1355 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1357 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1358 * \li Action: Moves the current group in the downward direction in the
1359 hierarchy of the document structure.
1360 * \li Notion: Part -> Chapter -> Section -> etc.
1361 * \li Syntax: outline-in
1362 * \li Origin: Vermeer, 23 Mar 2006
1365 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1367 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1368 * \li Action: Moves the current group in the upward direction in the
1369 hierarchy of the document structure.
1370 * \li Notion: Part <- Chapter <- Section <- etc.
1371 * \li Syntax: outline-out
1372 * \li Origin: Vermeer, 23 Mar 2006
1375 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1377 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1378 * \li Action: Edit the inset at cursor with an external application,
1379 * if one is attributed.
1380 * \li Syntax: inset-edit [<INSET_PARAMS>]
1381 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1382 Currently only the filename will be considered.
1383 * \li Origin: JSpitzm, 27 Apr 2006
1386 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1388 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1389 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1390 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1391 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1392 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1394 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1395 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1396 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1397 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1398 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1400 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1401 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1402 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1403 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1404 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1405 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1406 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1407 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1410 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1411 * \li Action: Apply data for an inset.
1412 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1413 be applied. This is either changed to #LFUN_INSET_MODIFY or
1414 #LFUN_INSET_INSERT depending on the context where it is called.
1415 * \li Syntax: inset-apply <ARGS>
1416 * \li Params: See #LFUN_INSET_INSERT .
1419 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1421 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1422 * \li Action: Dissolve the current inset into text.
1423 * \li Syntax: inset-dissolve [<INSET>]
1424 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1425 is dissolved. For example "dissolve" entry in the charstyles
1426 sub-menu should only dissolve the charstyle inset, even if the
1427 cursor is inside several nested insets of different type.\n
1428 For values see #lyx::InsetLayout::lyxtype_ .
1429 * \li Author: JSpitz, 7 Aug 2006
1432 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1434 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1435 * \li Action: Insert new inset (type given by the parameters).
1436 * \li Syntax: inset-insert <INSET> <ARGS>
1437 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1438 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1439 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1441 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1442 where <label name> is the name of the referenced label and
1443 <Format> is one of the following: \n
1444 ref -- <reference> \n
1445 eqref -- (<reference>) \n
1446 pageref -- <page> \n
1447 vpageref -- on <page> \n
1448 vref -- <reference> on <page> \n
1449 prettyref -- Formatted reference
1452 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1454 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1455 * \li Action: Modify existing inset.
1456 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1457 bibtex, ert, command, graphics, note, space, vspace, tabular,
1458 bibitem, inlude, ref insets.
1459 * \li Syntax: inset-modify <INSET> <ARGS>
1460 * \li Params: See #LFUN_INSET_INSERT for further details.
1463 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1465 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1466 * \li Action: Modify the inset at cursor position, if there is one.
1467 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1468 bibtex, ert, command, graphics, note, space, vspace, tabular,
1469 bibitem, inlude, ref insets.
1470 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1471 * \li Params: See #LFUN_INSET_INSERT for further details.
1472 * \li Origin: JSpitzm, 23 Mar 2008
1475 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1476 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1478 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1479 * \li Action: Open the inset's properties dialog.
1480 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1481 * \li Syntax: inset-settings <INSET>
1482 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1485 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1487 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1488 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1489 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1490 be entered. Also cf. #LFUN_INSET_SETTINGS.
1491 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1492 bibtex, ert, command, graphics, note, space, vspace, tabular,
1493 bibitem, inlude, ref insets.
1494 * \li Syntax: next-inset-toggle <ARG>
1495 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1496 * \li Origin: leeming, 30 Mar 2004
1499 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1501 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1502 * \li Action: Toggles the collapsable inset we are currently in.
1503 * \li Syntax: inset-toggle [<ARG>]
1504 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1505 open/close/toggle are for collapsable insets. close can be currently used
1506 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1507 assign is for branch inset.
1508 * \li Origin: lasgouttes, 19 Jul 2001
1511 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1513 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1514 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1515 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1516 * \li Syntax: all-insets-toggle <STATE> <INSET>
1517 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1518 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1519 * \li Origin: leeming, 30 Mar 2004
1522 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1524 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1525 * \li Action: Unify all graphics insets with the one given as an parameter.
1526 * \li Notion: This is internally used for synchronize certain group of graphics insets.
1527 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1528 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1529 (syntax can be seen in .lyx files).
1530 * \li Origin: sanda, 6 May 2008
1533 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1535 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1536 * \li Action: Set the group for the graphics inset on the cursor position.
1537 * \li Syntax: set-graphics-group [<GROUP>]
1538 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1539 the graphics inset is removed from the current group.
1540 * \li Origin: sanda, 6 May 2008
1543 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1546 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1547 * \li Action: Moves the cursor out of the current slice, going forward.
1548 * \li Notion: Cursor movement within an inset may be different than cursor
1549 movement in the surrounding text. This action should be called
1550 automatically by the cursor movement within the inset, when
1551 movement within the inset has ceased (reached the end of the
1552 last paragraph, for example), in order to move correctly
1553 back into the surrounding text.
1556 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1558 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1559 * \li Action: Moves the cursor out of the current slice, going backwards.
1560 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1563 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1565 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1566 * \li Action: Moves the cursor out of the current slice, going right.
1567 * \li Notion: See also #LFUN_FINISHED_FORWARD
1570 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1572 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1573 * \li Action: Moves the cursor out of the current slice, going left.
1574 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1577 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1579 { LFUN_LANGUAGE, "language", Noop, Edit },
1582 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1583 * \li Action: Goto a label.
1584 * \li Syntax: label-goto [<LABEL>]
1585 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1586 is on cursor position, Bookmark 0 is saved and
1587 cursor moves to the position of referenced label.
1588 * \li Origin: Ale, 6 Aug 1997
1591 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1593 * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1594 * \li Action: Inserts label to text or displayed formula.
1595 * \li Syntax: label-insert [<LABEL>]
1596 * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1597 name will be opened.
1600 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1602 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1603 * \li Action: Go to the next label or cross-reference.
1604 * \li Syntax: reference-next
1605 * \li Origin: Dekel, 14 Jan 2001
1608 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1611 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1612 * \li Action: Goto a bookmark.
1613 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1614 if necessary. Note that bookmarsk are saved per-session, not
1616 * \li Syntax: bookmark-goto <NUMBER>
1617 * \li Params: <NUMBER>: the number of the bookmark to restore.
1618 * \li Origin: Dekel, 27 January 2001
1621 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1623 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1624 * \li Action: Save a bookmark.
1625 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1626 must be between 1 and 9, inclusive. Note that bookmarks are
1627 saved per-session, not per file.
1628 * \li Syntax: bookmark-save <NUMBER>
1629 * \li Params: <NUMBER>: the number of the bookmark to save.
1630 * \li Origin: Dekel, 27 January 2001
1633 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1635 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1636 * \li Action: Clears the list of saved bookmarks.
1637 * \li Syntax: bookmark-clear
1638 * \li Origin: bpeng, 31 October 2006
1641 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1644 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1645 * \li Action: Open the given help file according to the language setting.
1646 * \li Syntax: help-open <FILE>[.lyx]
1647 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1648 * \li Author: Jug, 27 Jun 1999
1651 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1653 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1654 * \li Action: Terminates the current LyX instance.
1655 * \li Notion: Terminates the current LyX instance, asking whether to save
1656 modified documents, etc.
1657 * \li Syntax: lyx-quit
1660 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1662 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1663 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1664 * \li Notion: Skiping "auto" when allowauto is false.
1665 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1666 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1667 minibuffer|review|view/update|math_panels
1668 * \li Origin: Edwin, 21 May 2007
1671 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1673 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1674 * \li Action: Opens the menu given by its name.
1675 * \li Syntax: menu-open <NAME>
1676 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1679 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1681 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1682 * \li Action: Various UI visibility-toggling actions.
1683 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1684 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1685 menubar : Toggle visibility of the menubar.\n
1686 scrollbar : Toggle visibility of the scrollbar.\n
1687 frame : Toggle visibility of the frames around editing window.\n
1688 fullscreen : Toggle fullscreen mode. This also covers calling the
1689 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1690 custom tweaks of the toolbars should be used.
1691 * \li Origin: ps, 9 Feb 2007
1694 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1697 * \var lyx::FuncCode lyx::WINDOW_NEW
1698 * \li Action: Creates new empty LyX window.
1699 * \li Notion: Already opened documents from the previous window can be found under View menu.
1700 * \li Syntax: window-new [<GEOMETRY>]
1701 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1702 accepted only on Windows platform.
1703 * \li Origin: Abdel, 21 Oct 2006
1706 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1708 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1709 * \li Action: Closes the current LyX window.
1710 * \li Syntax: window-close
1711 * \li Origin: Abdel, 23 Oct 2006
1714 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1717 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1718 * \li Action: Creates another split view of current buffer.
1719 * \li Notion: All split views act in the same way indpendently.
1720 * \li Syntax: split-view <vertical|horizontal>
1721 * \li Params: horizontal : The work areas are laid out side by side.\n
1722 vertical : The work areas laid out vertically.\n
1723 * \li Origin: abdel, 20 Feb 2008
1726 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1729 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1730 * \li Action: Close the current tab group.
1731 * \li Notion: This only closes the work areas, not the buffer themselves.
1732 The still opened buffers can be visualized in another tab group.
1733 * \li Syntax: close-tab-group
1734 * \li Origin: abdel, 21 Feb 2008
1737 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1738 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1739 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1740 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1741 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1742 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1743 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1745 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1746 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1747 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1748 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1749 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1751 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1752 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1753 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1754 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1756 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1758 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1759 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1760 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1762 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1763 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1764 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1765 * \li Origin: Edmar, 23 Dec 1998
1768 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1769 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1771 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1772 * \li Action: Sets the cursor position based on the editing area coordinates
1773 (similar as clicking on that point with left mouse button).
1774 * \li Syntax: server-set-xy <X> <Y>
1777 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1779 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1780 * \li Action: Returns the coordinates of cursor position in the editing area.
1781 * \li Syntax: server-get-xy
1784 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1787 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1788 * \li Action: Generates the code (literate programming).
1789 * \li Notion: Latex file with extension \literate_extension is generated.
1790 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1791 \build_error_filter to process the compilation error messages. \n
1792 In case you want to process your literate file with a script, or some other program,
1793 just insert in your lyxrc file an entry with:\n
1794 \build_command "my_script my_arguments" \n
1795 The \build_error_filter differs from the \literate_error_filter only in that the
1796 former will identify error messages from your compiler.
1797 * \li Syntax: build-program
1800 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1803 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1804 * \li Action: Saves the current buffer to a temporary file.
1805 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1806 is called automatically by LyX, to "autosave" the current buffer.
1807 * \li Syntax: buffer-auto-save
1810 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1812 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1813 * \li Action: Loads the given child document.
1814 * \li Notion: The current document is treated as a parent.
1815 * \li Syntax: buffer-child-open <FILE>
1816 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1817 * \li Origin: Ale, 28 May 1997
1820 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1822 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1823 * \li Action: Runs chktex for the current document.
1824 * \li Syntax: buffer-chktex
1825 * \li Origin: Asger, 30 Oct 1997
1828 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1830 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1831 * \li Action: Toggles compression of the current document on/off.
1832 * \li Syntax: buffer-toggle-compression
1833 * \li Origin: bpeng, 27 Apr 2006
1836 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1838 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1839 * \li Action: Closes the current buffer.
1840 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1841 if the buffer has been modified.
1842 * \li Syntax: buffer-close
1845 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1847 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1848 * \li Action: Exports the current buffer (document) to the given format.
1849 * \li Syntax: buffer-export <FORMAT>
1850 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1851 can find in Tools->Preferences->File formats->Format.
1852 Usual format you will enter is "pdf2" (pdflatex),
1853 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1854 In case of "custom" you will be asked for a format you
1855 want to start from and for the command that you want to
1856 apply to this format. Internally the control is then passed
1857 to #LFUN_BUFFER_EXPORT_CUSTOM.
1858 * \li Origin: Lgb, 29 Jul 1997
1861 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1863 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1864 * \li Action: Exports the current buffer (document) from the given format using
1865 the given command on it.
1866 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1867 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1868 intermediate file).\n
1869 <COMMAND> this command will be launched on the file. Note that you can
1870 use "$$FName" string to qualify the intermediate file.
1871 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1872 * \li Origin: leeming, 27 Mar 2004
1875 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1877 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1878 * \li Action: Prints the current document.
1879 * \li Notion: Many settings can be given via the preferences dialog.
1880 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1881 * \li Params: <TARGET> is either "printer" or "file".\n
1882 <TARGER-NAME> is either "default" or file name or printer name.\n
1883 <COMMAND> command ensuring the printing job.
1884 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1885 * \li Origin: leeming, 28 Mar 2004
1888 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1890 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1891 * \li Action: Import a given file as a lyx document.
1892 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1893 defined convertors in preferences. Look into File->Import menu to get
1894 an idea of the currently active import formats.
1895 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1896 * \li Origin: Asger, 24 Jul 1998
1899 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1901 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1902 * \li Action: Creates a new buffer (that is, document).
1903 * \li Notion: Implicit path can be set in Preferences dialog.
1904 * \li Syntax: buffer-new [<FILE>]
1905 * \li Params: <FILE>: filename of created file with absolute path.
1908 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1910 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1911 * \li Action: Creates a new buffer (that is, document) from a template.
1912 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1913 Template will be asked for via Open-dialog.
1914 * \li Syntax: buffer-new-template [<FILE>]
1915 * \li Params: <FILE>: filename of created file with absolute path.
1918 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1920 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1921 * \li Action: Reverts opened document.
1922 * \li Syntax: buffer-reload
1923 * \li Origin: Asger, 2 Feb 1997
1926 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1928 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1929 * \li Action: Switch to the given buffer.
1930 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1931 document in different LyX windows.
1932 * \li Syntax: buffer-new-template <BUFFER>
1933 * \li Params: <BUFFER>: already opened document which is to be shown.
1936 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1938 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1939 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1940 * \li Syntax: buffer-toggle-read-only
1941 * \li Origin: Lgb, 27 May 1997
1944 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1946 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1947 * \li Action: Displays current buffer in chosen format.
1948 * \li Notion: Displays the contents of the current buffer in the chosen
1949 format, for example, PDF or DVI. This runs the necessary
1950 converter, calls the defined viewer, and so forth.
1951 * \li Syntax: buffer-view <FORMAT>
1952 * \li Params: <FORMAT>: The format to display, where this is one of the
1953 formats defined (in the current GUI) in the
1954 Tools>Preferences>File Formats dialog.
1957 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1959 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1960 * \li Action: Exports the current document and put the result into the
1961 temporary directory.
1962 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1963 the output will be rewriten - updated. This is useful in case your viewer
1964 is able to detect such changes (e.g. ghostview for postscript).
1965 * \li Syntax: buffer-update <FORMAT>
1966 * \li Params: <FORMAT>: The format to display, where this is one of the
1967 formats defined (in the current GUI) in the
1968 Tools>Preferences>File Formats dialog.
1969 * \li Origin: Dekel, 5 Aug 2000
1972 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1975 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1976 * \li Action: Saves the current buffer.
1977 * \li Notion: Saves the current buffer to disk, using the filename that
1978 is already associated with the buffer, asking for one if
1979 none is yet assigned.
1980 * \li Syntax: buffer-write
1983 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1985 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1986 * \li Action: Rename and save current buffer.
1987 * \li Syntax: buffer-write-as <FILENAME>
1988 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1989 is with respect to the original location of the buffer/file.
1992 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1994 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1995 * \li Action: Save all changed documents.
1996 * \li Syntax: buffer-write-all
1997 * \li Origin: rgh, gpothier 6 Aug 2007
2000 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2002 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2003 * \li Action: Switch to the next opened document.
2004 * \li Notion: Note that this does not necessarily mean next in tabbar
2005 (for full list see View menu).
2006 * \li Syntax: buffer-next
2009 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2011 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2012 * \li Action: Switch to the previous opened document.
2013 * \li Syntax: buffer-previous
2016 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2018 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2019 * \li Action: When run from a child document, this updates (exports) document built
2020 from the master buffer. If a master is not found, it updates the
2022 * \li Syntax: master-buffer-update
2023 * \li Author: Tommaso, 20 Sep 2007
2026 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2028 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2029 * \li Action: When run from a child document, this command shows a preview built
2030 from the master buffer. If a master is not found, it previews the
2032 * \li Syntax: master-buffer-view
2033 * \li Author: Tommaso, 20 Sep 2007
2036 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2038 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2039 * \li Action: Set language of the current document.
2040 * \li Syntax: buffer-language <LANG>
2041 * \li Params: <LANG>: language name. See lib/languages for list.
2042 * \li Author: leeming, 30 Mar 2004
2045 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2047 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2048 * \li Action: Save the current document settings as default.
2049 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2050 * \li Syntax: buffer-save-as-default [<ARGS>]
2051 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2052 you can find in document header of usual .lyx file.
2053 * \li Author: leeming, 30 Mar 2004
2056 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2058 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2059 * \li Action: Apply the given settings to the current document.
2060 * \li Syntax: buffer-params-apply [<ARGS>]
2061 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2062 you can find in document header of usual .lyx file.
2063 * \li Author: leeming, 30 Mar 2004
2066 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2069 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2070 * \li Action: Inserts another LyX file.
2071 * \li Syntax: file-insert [<FILE>]
2072 * \li Params: <FILE>: Filename to be inserted.
2075 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2077 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2078 * \li Action: Inserts plain text file.
2079 * \li Syntax: file-insert-plaintext [<FILE>]
2080 * \li Params: <FILE>: Filename to be inserted.
2081 * \li Origin: CFO-G, 19 Nov 1997
2084 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2086 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2087 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2088 * \li Syntax: file-insert-plaintext-para [<FILE>]
2089 * \li Params: <FILE>: Filename to be inserted.
2090 * \li Origin: Levon, 14 Feb 2001
2093 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2095 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2096 * \li Action: Open LyX document.
2097 * \li Syntax: file-open [<FILE>]
2098 * \li Params: <FILE>: Filename to be opened.
2101 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2104 * \var lyx::FuncCode lyx::LFUN_CALL
2105 * \li Action: Executes a command defined in a .def file.
2106 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2107 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2108 where <NAME> is the name of the new command and <LFUN> is the lfun code
2109 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2110 \\def_file "FileName" allows to include another .def file. \n
2111 This is particularly useful in connection with toolbar buttons:
2112 Since the name of the button image for this lfun is
2113 lib/images/commands/<NAME>.png this is the way to assign an image
2114 to a complex command-sequence.
2115 * \li Syntax: call <NAME>
2116 * \li Params: <NAME>: Name of the command that must be called.
2117 * \li Origin: broider, 2 Oct 2007
2120 { LFUN_CALL, "call", NoBuffer, System },
2122 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2123 * \li Action: Simulate halting Meta key (Alt key on PCs).
2124 * \li Notion: Used for buffer editation not for GUI control.
2125 * \li Syntax: meta-prefix
2128 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2130 * \var lyx::FuncCode lyx::LFUN_CANCEL
2131 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2132 * \li Syntax: cancel
2135 { LFUN_CANCEL, "cancel", NoBuffer, System },
2138 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2139 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2140 * \li Notion: Usually bound to M-x shortcut.
2141 * \li Syntax: command-execute
2144 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2145 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2147 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2148 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2149 * \li Syntax: command-sequence <CMDS>
2150 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2151 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2152 * \li Origin: Andre', 11 Nov 1999
2155 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2157 * \var lyx::FuncCode lyx::LFUN_MESSAGE
2158 * \li Action: Shows message in statusbar (for script purposes).
2159 * \li Syntax: message <STRING>
2160 * \li Origin: Lgb, 8 Apr 2001
2163 { LFUN_MESSAGE, "message", NoBuffer, System },
2165 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2166 * \li Action: Save user preferences.
2167 * \li Syntax: preferences-save
2168 * \li Origin: Lgb, 27 Nov 1999
2171 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2173 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2174 * \li Action: Reconfigure the automatic settings.
2175 * \li Syntax: reconfigure
2176 * \li Origin: Asger, 14 Feb 1997
2179 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2181 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2182 * \li Action: Apply the given settings to user preferences.
2183 * \li Syntax: lyxrc-apply <SETTINGS>
2184 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2185 to get an idea which commands to use and their syntax.
2186 #lyx::LyXRC::LyXRCTags has the list of possible commands.
2189 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2191 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2192 * \li Action: Determine whether keep cursor inside the editing window regardless
2193 the scrollbar movement.
2194 * \li Syntax: toggle-cursor-follows-scrollbar
2195 * \li Origin: ARRae, 2 Dec 1997
2198 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2200 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2201 * \li Action: Set the given LyX color to the color defined by the X11 name given.
2202 * \li Notion: A new color entry is created if the color is unknown.
2203 Color names can be stored as a part of user settings.
2204 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2205 * \li Origin: SLior, 11 Jun 2000
2208 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2210 * \var lyx::FuncCode lyx::LFUN_STATISTICS
2211 * \li Action: Count the statistics (number of words and characters)
2212 in the document or in the given selection.
2213 * \li Notion: Note that this function gives the number of words/chars written,
2214 not the number of characters which will be typeset.
2215 * \li Syntax: statistics
2216 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2219 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2221 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2222 * \li Action: Show the inline completion at the cursor position.
2223 * \li Syntax: completion-inline
2224 * \li Origin: sts, Feb 19 2008
2227 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2229 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2230 * \li Action: Show the completion popup at the cursor position.
2231 * \li Syntax: completion-popup
2232 * \li Origin: sts, Feb 19 2008
2235 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2237 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2238 * \li Action: Try to complete the word or command at the cursor position.
2239 * \li Syntax: completion-complete
2240 * \li Origin: sts, Feb 19 2008
2243 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2245 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2246 * \li Action: Activate the branch
2247 * \li Syntax: branch-activate <BRANCH>
2248 * \li Params: <BRANCH>: The branch to activate
2249 * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2250 could be used to export a pdf with the answers branch included
2251 without one's having to open LyX and activate the branch manually.
2252 * \li Origin: rgh, 27 May 2008
2255 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2257 * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2258 * \li Action: De-activate the branch
2259 * \li Syntax: branch-deactivate <BRANCH>
2260 * \li Params: <BRANCH>: The branch to deactivate
2261 * \li Origin: rgh, 27 May 2008
2264 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2266 { LFUN_NOACTION, "", Noop, Hidden }
2267 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2270 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2271 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2278 LyXAction::LyXAction()
2284 // Returns an action tag from a string.
2285 FuncRequest LyXAction::lookupFunc(string const & func) const
2287 string const func2 = trim(func);
2289 if (func2.empty()) {
2290 return FuncRequest(LFUN_NOACTION);
2294 string const arg = split(func2, cmd, ' ');
2296 func_map::const_iterator fit = lyx_func_map.find(cmd);
2298 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2302 string const LyXAction::getActionName(FuncCode action) const
2304 info_map::const_iterator const it = lyx_info_map.find(action);
2305 return it != lyx_info_map.end() ? it->second.name : string();
2309 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2311 info_map::const_iterator const it = lyx_info_map.find(action);
2312 return it != lyx_info_map.end() ? it->second.type : Hidden;
2316 bool LyXAction::funcHasFlag(FuncCode action,
2317 LyXAction::func_attrib flag) const
2319 info_map::const_iterator ici = lyx_info_map.find(action);
2321 if (ici == lyx_info_map.end()) {
2322 LYXERR0("action: " << action << " is not known.");
2323 LASSERT(false, /**/);
2326 return ici->second.attrib & flag;
2330 LyXAction::const_func_iterator LyXAction::func_begin() const
2332 return lyx_func_map.begin();
2336 LyXAction::const_func_iterator LyXAction::func_end() const
2338 return lyx_func_map.end();