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/assert.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 },
195 { LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Edit },
197 * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
198 * \li Action: Adds a tie \htmlonly (a͡)\endhtmlonly
199 over the next two character typed.
200 * \li Notion: the following char will finish the tie.
201 * \li Syntax: accent-tie
204 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
206 * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
207 * \li Action: Adds a tilde \htmlonly (ã)\endhtmlonly
208 over the next character typed.
209 * \li Syntax: accent-tilde
212 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
214 * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
215 * \li Action: Adds an umlaut \htmlonly (ä)\endhtmlonly
216 over the next character typed.
217 * \li Syntax: accent-umlaut
220 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
222 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
223 * \li Action: Adds a bar \htmlonly (a̠)\endhtmlonly
224 under the next character typed.
225 * \li Syntax: accent-underbar
228 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
230 * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
231 * \li Action: Adds a dot \htmlonly (ạ)\endhtmlonly
232 under the next character typed.
233 * \li Syntax: accent-underdot
236 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
239 * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
240 * \li Action: Inserts a caption inset.
241 * \li Syntax: caption-insert
242 * \li Origin: Lgb, 18 Jul 2000
245 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
247 * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
248 * \li Action: Inserts the current date.
249 * \li Syntax: date-insert [<ARG>]
250 * \li Params: <ARG>: Format of date. The default value (%x) can be set
251 in Preferences->Date format. For possible formats
252 see manual page of strftime function.
253 * \li Origin: jdblair, 31 Jan 2000
256 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
258 * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
259 * \li Action: Inserts a footnote inset.
260 * \li Syntax: footnote-insert
261 * \li Origin: Jug, 7 Mar 2000
264 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
266 * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
267 * \li Action: Inserts an ERT inset.
268 * \li Syntax: ert-insert
269 * \li Origin: Jug, 18 Feb 2000
272 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
273 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
274 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
275 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
277 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
278 * \li Action: Inserts an optional-argument (short title) inset.
279 * \li Syntax: optional-insert
280 * \li Origin: Martin, 12 Aug 2002
283 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
285 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
286 * \li Action: Inserts a horizontal line.
287 * \li Syntax: line-insert
288 * \li Origin: poenitz, Oct 27 2003
291 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
293 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
294 * \li Action: Inserts a new page.
295 * \li Syntax: newpage-insert<ARG>
296 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
297 * \li Origin: uwestoehr, 24 Nov 2007
300 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
302 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
303 * \li Action: Inserts a marginal note.
304 * \li Syntax: marginalnote-insert
305 * \li Origin: Lgb, 26 Jun 2000
308 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
310 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
311 * \li Action: Inserts a single unicode character.
312 * \li Syntax: unicode-insert <CHAR>
313 * \li Params: <CHAR>: The character to insert, given as its code
314 point, in hexadecimal, e.g.: unicode-insert 0x0100.
315 * \li Origin: Lgb, 22 Oct 2006
318 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
320 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
321 * \li Action: Inserts a new listings inset.
322 * \li Syntax: listing-insert
323 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
326 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
327 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
329 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
330 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
331 information in a non-editable boxed InsetText.
332 * \li Notion: Apart from lfun arguments you can use the following method: \n
333 1. input the type and argument of this inset, e.g. "menu paste", in
335 2. select the text and run info-insert lfun.\n
336 * \li Syntax: info-insert <TYPE> <ARG>
337 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
338 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
340 * \li Origin: bpeng, 7 Oct 2007
343 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
345 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
346 * \li Action: Inserts branch inset.
347 * \li Syntax: branch-insert <BRANCH-NAME>
348 * \li Origin: vermeer, Aug 17 Aug 2003
351 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
352 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
354 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
355 * \li Action: Inserts CharStyle, Custom inset or XML short element.
356 * \li Notion: Look into the Customization manual for more information about
358 For dissolving the element see #LFUN_INSET_DISSOLVE.
359 * \li Syntax: flex-insert <TYPE:Name>
360 * \li Params: TYPE: CharStyle|Custom|Element|Standard
361 Identifies whether this is a Character Style, a
362 Custom Inset or an XML Element, and which dynamical
363 sub-menu this flex inset is in on the LyX menu tree.
364 If Standard (currently unused): none of these.
365 Name: This name must be defined either in your layout file
366 or imported by some module. The definition is\n
367 InsetLayout <TYPE:Name>
368 * \li Sample: flex-insert CharStyle:Code
371 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
372 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
374 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
375 * \li Action: Inserts one of horizontal space insets.
376 * \li Syntax: space-insert <NAME> [<LEN>]
377 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
378 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
380 <LEN>: length for custom spaces (hspace, hspace* for protected)
381 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
384 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
385 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
387 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
388 * \li Action: Inserts various characters into the document.
389 * \li Syntax: specialchar-insert <CHAR>
390 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
391 end-of-sentence, menu-separator.
392 * \li Origin: JSpitzm, 6 Dec 2007
395 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
396 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
397 { LFUN_APPENDIX, "appendix", Noop, Edit },
399 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
400 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
402 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
403 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
405 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
406 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
408 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
409 * \li Action: Inserts a line break or new line.
410 * \li Syntax: newline-insert <ARG>
411 * \li Params: <ARG>: <newline|linebreak> default: newline
412 * \li Origin: JSpitzm, 25 Mar 2008
415 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
419 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
422 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
423 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
424 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
425 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
426 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
427 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
428 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
429 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
431 * \var lyx::FuncCode lyx::LFUN_SCROLL
432 * \li Action: Scroll the buffer view.
433 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
434 * \li Syntax: scroll <TYPE> <QUANTITY>
435 * \li Params: <TYPE>: line|page\n
436 <QUANTITY>: up|down|<number>
437 * \li Origin: Abdelrazak Younes, Dec 27 2007
440 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
442 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
443 * \li Action: Recenters the screen on the current cursor position.
444 * \li Syntax: screen-recenter
447 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
448 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
449 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
451 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
453 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
454 * \li Action: Moves the cursor one position logically backwards.
455 * \li Notion: This is not the action which should be bound to the arrow keys,
456 because backwards may be left or right, depending on the
457 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
458 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
459 * \li Syntax: char-backward
462 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
464 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
465 * \li Action: Moves the cursor one position logically backwards, adding
466 traversed position to the selection.
467 * \li Notion: See also #LFUN_CHAR_BACKWARD.
468 * \li Syntax: char-backward-select
471 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
472 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
473 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
475 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
476 * \li Action: Moves the cursor one position logically forward.
477 * \li Notion: This is not the action which should be bound to the arrow keys,
478 because forward may be left or right, depending on the language.
479 The arrow keys should be bound to #LFUN_CHAR_LEFT or
480 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
481 * \li Syntax: char-forward
484 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
486 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
487 * \li Action: Moves the cursor one position logically forward, adding
488 traversed position to the selection.
489 * \li Notion: See also #LFUN_CHAR_FORWARD.
490 * \li Syntax: char-forward-select
493 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
495 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
496 * \li Action: Moves the cursor one position "to the left".
497 * \li Notion: This is the action which should be taken when the "left" key
498 is pressed. Generally, it moves the cursor one position to the
499 left. However, in Bidi text this become slightly more
500 complicated, and there are different modes of cursor movement.
501 In "visual mode", this moves left, plain and simple. In "logical
502 mode", movement is logically forward in RTL paragraphs, and
503 logically backwards in LTR paragraphs.
504 * \li Syntax: char-left
507 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
509 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
510 * \li Action: Moves the cursor one position "to the left", adding
511 traversed position to the selection.
512 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
513 * \li Syntax: char-left-select
516 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
518 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
519 * \li Action: Moves the cursor one position "to the right".
520 * \li Notion: This is the action which should be taken when the "right" key
521 is pressed. Generally, it moves the cursor one position to the
522 right. However, in Bidi text this become slightly more
523 complicated, and there are different modes of cursor movement.
524 In "visual mode", this moves right, plain and simple. In "logical
525 mode", movement is logically forward in LTR paragraphs, and
526 logically backwards in RTL paragraphs.
527 * \li Syntax: char-right
530 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
532 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
533 * \li Action: Moves the cursor one position "to the right", adding
534 traversed position to the selection.
535 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
536 * \li Syntax: char-right-select
539 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
541 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
542 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
543 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
544 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
545 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
547 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
548 * \li Action: Search for a given string in forward direction.
549 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
550 * \li Syntax: word-find-forward [<STRING>]
551 * \li Origin: Etienne, 16 Feb 1998
554 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
556 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
557 * \li Action: Search for a given string in backward direction.
558 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
559 * \li Syntax: word-find-backward [<STRING>]
560 * \li Origin: Etienne, 20 Feb 1998
563 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
565 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
566 * \li Action: Search for next occurence of a string.
567 * \li Syntax: word-find [<DATA>]
568 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
569 If no parameter is given, search with last find-dialog
570 data is used for search (i.e. find-next).
571 * \li Origin: poenitz, Jan 7 2004
574 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
575 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
576 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
577 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
578 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
579 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
580 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
581 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
582 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
583 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
584 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
586 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
587 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
588 * \li Syntax: thesaurus-entry
589 * \li Origin: Levon, 20 Jul 2001
592 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
593 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
594 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
595 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
596 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
598 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
599 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
600 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
601 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
602 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
604 * \var lyx::FuncCode lyx::LFUN_COPY
605 * \li Action: Copies to the clipboard the last edit.
609 { LFUN_COPY, "copy", ReadOnly, Edit },
611 * \var lyx::FuncCode lyx::LFUN_CUT
612 * \li Action: Cuts to the clipboard.
616 { LFUN_CUT, "cut", Noop, Edit },
618 * \var lyx::FuncCode lyx::LFUN_PASTE
619 * \li Action: Pastes from the active clipboard.
623 { LFUN_PASTE, "paste", Noop, Edit },
624 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
626 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
627 * \li Action: Pastes the material currently selected.
628 * \li Syntax: primary-selection-paste
631 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
633 * \var lyx::FuncCode lyx::LFUN_UNDO
634 * \li Action: Undoes the last edit.
638 { LFUN_UNDO, "undo", Noop, Edit },
640 * \var lyx::FuncCode lyx::LFUN_REDO
641 * \li Action: Redoes the last thing undone.
645 { LFUN_REDO, "redo", Noop, Edit },
647 * \var lyx::FuncCode lyx::LFUN_REPEAT
648 * \li Action: Repeat the given command.
649 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
650 * \li Author: poenitz, 27 Oct 2003
653 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
654 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
656 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
657 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
658 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
660 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
661 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
662 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
663 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
664 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
665 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
666 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
667 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
668 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
669 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
670 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
671 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
672 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
673 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
674 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
676 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
677 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
678 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
679 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
682 * \var lyx::FuncCode lyx::LFUN_LAYOUT
683 * \li Action: Sets the layout (that is, environment) for the current paragraph.
684 * \li Syntax: layout <LAYOUT>
685 * \li Params: <LAYOUT>: the layout to use
688 { LFUN_LAYOUT, "layout", Noop, Layout },
690 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
691 * \li Action: Launches the paragraph settings dialog.
692 * \li Syntax: layout-paragraph
695 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
696 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
698 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
699 * \li Action: Displays list of layout choices.
700 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
701 dropbox allowing for choice of layout.
702 * \li Syntax: drop-layouts-choice
705 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
707 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
708 * \li Action: Clears the module list.
709 * \li Notion: Clears the list of included modules for the current buffer.
710 * \li Syntax: layout-modules-clear
711 * \li Origin: rgh, 25 August 2007
714 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
716 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
717 * \li Action: Adds a module.
718 * \li Notion: Adds a module to the list of included modules for the current buffer.
719 * \li Syntax: layout-module-add <MODULE>
720 * \li Params: <MODULE>: the module to be added
721 * \li Origin: rgh, 25 August 2007
724 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
726 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
727 * \li Action: Reloads layout information.
728 * \li Notion: Reloads all layout information for the current buffer from disk, thus
729 recognizing any changes that have been made to layout files on the fly.
730 This is intended to be used only by layout developers and should not be
731 used when one is trying to do actual work.
732 * \li Syntax: layout-reload
733 * \li Origin: rgh, 3 September 2007
736 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
738 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
739 * \li Action: Sets the text class for the current buffer.
740 * \li Syntax: textclass-apply <TEXTCLASS>
741 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
742 the filename, minus the ".layout" extension.
745 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
747 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
748 * \li Action: Loads information for a textclass from disk.
749 * \li Syntax: textclass-load <TEXTCLASS>
750 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
751 the filename, minus the ".layout" extension.
754 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
757 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
758 * \li Action: Disable selecting of text-region.
759 * \li Syntax: mark-off
762 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
764 * \var lyx::FuncCode lyx::LFUN_MARK_ON
765 * \li Action: Enable selecting of text-region.
766 * \li Notion: After enabling you can simply move arrow keys to get selected region.
767 * \li Syntax: mark-on
770 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
772 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
773 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
774 * \li Syntax: mark-toggle
775 * \li Origin: poenitz, May 5 2006
778 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
780 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
781 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
782 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
783 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
784 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
785 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
786 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
787 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
788 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
789 { LFUN_MATH_SPACE, "math-space", Noop, Math },
790 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
791 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
792 { LFUN_MATH_MODE, "math-mode", Noop, Math },
794 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
795 * \li Action: Toggles numbering of the current formula line.
796 * \li Notion: Must be in display formula mode.
797 * \li Syntax: math-number-line-toggle
798 * \li Origin: Alejandro 18 Jun 1996
801 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
803 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
804 * \li Action: Toggles numbering/labeling of the current formula.
805 * \li Notion: Must be in display formula mode.
806 * \li Syntax: math-number-toggle
807 * \li Origin: Alejandro 4 Jun 1996
810 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
811 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
812 { LFUN_MATH_SIZE, "math-size", Noop, Math },
814 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
815 * \li Action: Unfold a Math Macro.
816 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
818 * \li Syntax: math-macro-unfold
819 * \li Origin: sts, 06 January 2008
822 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
824 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
825 * \li Action: Fold a Math Macro.
826 * \li Notion: Fold the Math Macro the cursor is in if it was
827 unfolded, i.e. displayed as \foo before.
828 * \li Syntax: math-macro-fold
829 * \li Origin: sts, 06 January 2008
832 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
834 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
835 * \li Action: Add a parameter.
836 * \li Notion: Add a parameter to a Math Macro.
837 * \li Params: <NUM>: The number of the parameter behind which the new one
838 will be added (1 for the first, i.e. use 0 for add a
839 parameter at the left), defaults to the last one.
840 * \li Syntax: math-macro-add-param <NUM>
841 * \li Origin: sts, 06 January 2008
844 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
846 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
847 * \li Action: Remove the last parameter.
848 * \li Notion: Remove the last parameter of a Math Macro and
849 remove its value in all instances of the macro
851 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
852 the first), defaults to the last one.
853 * \li Syntax: math-macro-remove-param <NUM>
854 * \li Origin: sts, 06 January 2008
857 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
859 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
860 * \li Action: Append a greedy parameter.
861 * \li Notion: Append a greedy parameter to a Math Macro which
862 eats the following mathed cell in every instance of
863 the macro in the buffer.
864 * \li Syntax: math-macro-append-greedy-param
865 * \li Origin: sts, 06 January 2008
868 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
870 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
871 * \li Action: Remove a greedy parameter.
872 * \li Notion: Remove a greedy parameter of a Math Macro and spit
873 out the values of it in every instance of the macro
874 in the buffer. If it is an optional parameter the [valud]
876 * \li Syntax: math-macro-remove-greedy-param
877 * \li Origin: sts, 06 January 2008
880 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
882 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
883 * \li Action: Make a parameter optional.
884 * \li Notion: Turn the first non-optional parameter of a Math Macro
885 into an optional parameter with a default value.
886 * \li Syntax: math-macro-make-optional
887 * \li Origin: sts, 06 January 2008
890 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
892 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
893 * \li Action: Make a parameter non-optional.
894 * \li Notion: Turn the last optional parameter of a Math Macro
895 into a non-optional parameter. The default value is
896 remembered to be reused later if the user changes his mind.
897 * \li Syntax: math-macro-make-nonoptional
898 * \li Origin: sts, 06 January 2008
901 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
903 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
904 * \li Action: Add an optional parameter.
905 * \li Notion: Insert an optional parameter just behind the
906 already existing optional parameters.
907 * \li Syntax: math-macro-add-optional-param
908 * \li Origin: sts, 06 January 2008
911 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
913 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
914 * \li Action: Remove the last optional parameter.
915 * \li Notion: Remove the last optional parameter of a Math Macro and
916 remove it in all the instances of the macro in the buffer.
917 * \li Syntax: math-macro-remove-optional-param
918 * \li Origin: sts, 06 January 2008
921 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
923 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
924 * \li Action: Add a greedy optional parameter.
925 * \li Notion: Add a greedy optional parameter which eats the value
926 from the following cells in mathed which are in the [value]
928 * \li Syntax: math-macro-add-greedy-optional-param
929 * \li Origin: sts, 06 January 2008
932 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
934 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
935 * \li Action: Only active in Math Macro definition.
936 * \li Notion: Dummy function which is only active in a Math Macro definition.
937 It's used to toggle the Math Macro toolbar if the cursor moves
938 into a Math Macro definition.
939 * \li Syntax: in-mathmacrotemplate
940 * \li Origin: sts, 06 January 2008
943 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
946 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
947 * \li Action: Moves the current paragraph downwards in the document.
948 * \li Syntax: paragraph-move-down
949 * \li Origin: Edwin, 8 Apr 2006
952 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
954 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
955 * \li Action: Moves the current paragraph upwards in the document.
956 * \li Syntax: paragraph-move-up
957 * \li Origin: Edwin, 8 Apr 2006
960 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
963 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
964 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
966 * \li Syntax: paragraph-up
967 * \li Origin: Asger, 1 Oct 1996
970 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
972 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
973 * \li Action: Move the cursor and select the text to the next paragraph (or
974 begining of the current one) in upward direction.
975 * \li Syntax: paragraph-up-select
976 * \li Origin: Asger, 1 Oct 1996
979 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
981 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
982 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
983 in downward direction.
984 * \li Syntax: paragraph-down
985 * \li Origin: Asger, 1 Oct 1996
988 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
990 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
991 * \li Action: Move the cursor and select the text to the next paragraph (or
992 begining of the current one) in downward direction.
993 * \li Syntax: paragraph-down-select
994 * \li Origin: Asger, 1 Oct 1996
997 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
999 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1000 * \li Action: Jump to a paragraph given by its id number.
1001 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1002 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1003 * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
1004 * \li Origin: Dekel, 26 Aug 2000
1007 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1009 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1010 * \li Action: Breaks the current paragraph at the current location.
1011 * \li Syntax: break-paragraph
1014 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1015 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1017 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1018 * \li Action: Breaks the current paragraph at the current location,
1019 unless used at the beginning of a line, where it sets
1020 the label width string to empty.
1021 * \li Syntax: break-paragraph-skip
1024 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1026 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1027 * \li Action: Change paragraph settings.
1028 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1029 This function only modifies, and does not override, existing settings.
1030 Note that the "leftindent" indent setting is deprecated.
1031 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1032 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1033 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1034 <ALIGN>: \\align block|left|right|center|default\n
1035 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1036 * \li Origin: rgh, Aug 15 2007
1039 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1041 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1042 * \li Action: Change paragraph settings.
1043 * \li Notion: Overwrite all nonspecified settings to the default ones.
1044 Use paragraph-params lfun if you don't want to overwrite others settings.
1045 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1046 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1047 * \li Origin: leeming, 30 Mar 2004
1050 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1051 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1054 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1055 * \li Action: Move the current group in the upward direction in the
1056 structure of the document.
1057 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1058 the whole substructure of the group.
1059 * \li Syntax: outline-up
1060 * \li Origin: Vermeer, 23 Mar 2006
1063 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1065 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1066 * \li Action: Move the current group in the downward direction in the
1067 structure of the document.
1068 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1069 the whole substructure of the group.
1070 * \li Syntax: outline-down
1071 * \li Origin: Vermeer, 23 Mar 2006
1074 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1076 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1077 * \li Action: Moves the current group in the downward direction in the
1078 hierarchy of the document structure.
1079 * \li Notion: Part -> Chapter -> Section -> etc.
1080 * \li Syntax: outline-in
1081 * \li Origin: Vermeer, 23 Mar 2006
1084 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1086 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1087 * \li Action: Moves the current group in the upward direction in the
1088 hierarchy of the document structure.
1089 * \li Notion: Part <- Chapter <- Section <- etc.
1090 * \li Syntax: outline-out
1091 * \li Origin: Vermeer, 23 Mar 2006
1094 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1096 { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
1097 { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
1099 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1100 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1101 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1102 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1103 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1105 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1106 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1107 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1108 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1109 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1111 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1112 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1113 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1114 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1115 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1116 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1117 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1118 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1121 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1122 * \li Action: Apply data for an inset.
1123 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1124 be applied. This is either changed to #LFUN_INSET_MODIFY or
1125 #LFUN_INSET_INSERT depending on the context where it is called.
1126 * \li Syntax: inset-apply <ARGS>
1127 * \li Params: See #LFUN_INSET_INSERT .
1130 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1132 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1133 * \li Action: Dissolve the current inset into text.
1134 * \li Syntax: inset-dissolve [<INSET>]
1135 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1136 is dissolved. For example "dissolve" entry in the charstyles
1137 sub-menu should only dissolve the charstyle inset, even if the
1138 cursor is inside several nested insets of different type.\n
1139 For values see #lyx::InsetLayout::lyxtype_ .
1140 * \li Author: JSpitz, 7 Aug 2006
1143 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1145 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1146 * \li Action: Insert new inset (type given by the parameters).
1147 * \li Syntax: inset-insert <INSET> <ARGS>
1148 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1149 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1150 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1152 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1153 where <label name> is the name of the referenced label and
1154 <Format> is one of the following: \n
1155 ref -- <reference> \n
1156 eqref -- (<reference>) \n
1157 pageref -- <page> \n
1158 vpageref -- on <page> \n
1159 vref -- <reference> on <page> \n
1160 prettyref -- Formatted reference
1163 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1165 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1166 * \li Action: Modify existing inset.
1167 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1168 bibtex, ert, command, graphics, note, space, vspace, tabular,
1169 bibitem, inlude, ref insets.
1170 * \li Syntax: inset-modify <INSET> <ARGS>
1171 * \li Params: See #LFUN_INSET_INSERT for further details.
1174 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1176 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1177 * \li Action: Modify the inset at cursor position, if there is one.
1178 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1179 bibtex, ert, command, graphics, note, space, vspace, tabular,
1180 bibitem, inlude, ref insets.
1181 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1182 * \li Params: See #LFUN_INSET_INSERT for further details.
1183 * \li Origin: JSpitzm, 23 Mar 2008
1186 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1187 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1189 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1190 * \li Action: Open the inset's properties dialog.
1191 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1192 * \li Syntax: inset-settings <INSET>
1193 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1196 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1198 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1199 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1200 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1201 be entered. Also cf. #LFUN_INSET_SETTINGS.
1202 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1203 bibtex, ert, command, graphics, note, space, vspace, tabular,
1204 bibitem, inlude, ref insets.
1205 * \li Syntax: next-inset-toggle <ARG>
1206 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1207 * \li Origin: leeming, 30 Mar 2004
1210 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1212 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1213 * \li Action: Toggles the collapsable inset we are currently in.
1214 * \li Syntax: inset-toggle [<ARG>]
1215 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1216 open/close/toggle are for collapsable insets. close can be currently used
1217 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1218 assign is for branch inset.
1219 * \li Origin: lasgouttes, 19 Jul 2001
1222 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1224 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1225 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1226 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1227 * \li Syntax: all-insets-toggle <STATE> <INSET>
1228 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1229 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1230 * \li Origin: leeming, 30 Mar 2004
1233 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1236 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1237 * \li Action: Moves the cursor out of the current slice, going forward.
1238 * \li Notion: Cursor movement within an inset may be different than cursor
1239 movement in the surrounding text. This action should be called
1240 automatically by the cursor movement within the inset, when
1241 movement within the inset has ceased (reached the end of the
1242 last paragraph, for example), in order to move correctly
1243 back into the surrounding text.
1246 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1248 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1249 * \li Action: Moves the cursor out of the current slice, going backwards.
1250 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1253 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1255 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1256 * \li Action: Moves the cursor out of the current slice, going right.
1257 * \li Notion: See also #LFUN_FINISHED_FORWARD
1260 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1262 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1263 * \li Action: Moves the cursor out of the current slice, going left.
1264 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1267 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1269 { LFUN_LANGUAGE, "language", Noop, Edit },
1272 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1273 * \li Action: Goto a label.
1274 * \li Syntax: label-goto [<LABEL>]
1275 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1276 is on cursor position, Bookmark 0 is saved and
1277 cursor moves to the position of referenced label.
1278 * \li Origin: Ale, 6 Aug 1997
1281 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1282 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1284 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1285 * \li Action: Go to the next label or cross-reference.
1286 * \li Syntax: reference-next
1287 * \li Origin: Dekel, 14 Jan 2001
1290 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1293 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1294 * \li Action: Goto a bookmark.
1295 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1296 if necessary. Note that bookmarsk are saved per-session, not
1298 * \li Syntax: bookmark-goto <NUMBER>
1299 * \li Params: <NUMBER>: the number of the bookmark to restore.
1300 * \li Origin: Dekel, 27 January 2001
1303 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1305 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1306 * \li Action: Save a bookmark.
1307 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1308 must be between 1 and 9, inclusive. Note that bookmarks are
1309 saved per-session, not per file.
1310 * \li Syntax: bookmark-save <NUMBER>
1311 * \li Params: <NUMBER>: the number of the bookmark to save.
1312 * \li Origin: Dekel, 27 January 2001
1315 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1317 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1318 * \li Action: Clears the list of saved bookmarks.
1319 * \li Syntax: bookmark-clear
1320 * \li Origin: bpeng, 31 October 2006
1323 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1326 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1327 * \li Action: Open the given help file according to the language setting.
1328 * \li Syntax: help-open <FILE>[.lyx]
1329 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1330 * \li Author: Jug, 27 Jun 1999
1333 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1335 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1336 * \li Action: Terminates the current LyX instance.
1337 * \li Notion: Terminates the current LyX instance, asking whether to save
1338 modified documents, etc.
1339 * \li Syntax: lyx-quit
1342 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1344 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1345 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1346 * \li Notion: Skiping "auto" when allowauto is false.
1347 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1348 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1349 minibuffer|review|view/update|math_panels
1350 * \li Origin: Edwin, 21 May 2007
1353 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1355 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1356 * \li Action: Opens the menu given by its name.
1357 * \li Syntax: menu-open <NAME>
1358 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1361 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1363 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1364 * \li Action: Various UI visibility-toggling actions.
1365 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1366 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1367 menubar : Toggle visibility of the menubar.\n
1368 scrollbar : Toggle visibility of the scrollbar.\n
1369 frame : Toggle visibility of the frames around editing window.\n
1370 fullscreen : Toggle fullscreen mode. This also covers calling the
1371 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1372 custom tweaks of the toolbars should be used.
1373 * \li Origin: ps, 9 Feb 2007
1376 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1379 * \var lyx::FuncCode lyx::WINDOW_NEW
1380 * \li Action: Creates new empty LyX window.
1381 * \li Notion: Already opened documents from the previous window can be found under View menu.
1382 * \li Syntax: window-new [<GEOMETRY>]
1383 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1384 accepted only on Windows platform.
1385 * \li Origin: Abdel, 21 Oct 2006
1388 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1390 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1391 * \li Action: Closes the current LyX window.
1392 * \li Syntax: window-close
1393 * \li Origin: Abdel, 23 Oct 2006
1396 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1399 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1400 * \li Action: Creates another split view of current buffer.
1401 * \li Notion: All split views act in the same way indpendently.
1402 * \li Syntax: split-view <vertical|horizontal>
1403 * \li Params: horizontal : The work areas are laid out side by side.\n
1404 vertical : The work areas laid out vertically.\n
1405 * \li Origin: abdel, 20 Feb 2008
1408 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1411 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1412 * \li Action: Close the current tab group.
1413 * \li Notion: This only closes the work areas, not the buffer themselves.
1414 The still opened buffers can be visualized in another tab group.
1415 * \li Syntax: close-tab-group
1416 * \li Origin: abdel, 21 Feb 2008
1419 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1420 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1421 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1422 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1423 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1424 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1425 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1427 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1428 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1429 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1430 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1431 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1433 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1434 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1435 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1436 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1438 { LFUN_MESSAGE, "message", NoBuffer, System },
1439 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1440 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1442 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1443 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1444 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1446 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1447 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1448 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1449 * \li Origin: Edmar, 23 Dec 1998
1452 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1453 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1455 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1456 * \li Action: Sets the cursor position based on the editing area coordinates
1457 (similar as clicking on that point with left mouse button).
1458 * \li Syntax: server-set-xy <X> <Y>
1461 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1463 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1464 * \li Action: Returns the coordinates of cursor position in the editing area.
1465 * \li Syntax: server-get-xy
1468 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1471 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1472 * \li Action: Generates the code (literate programming).
1473 * \li Notion: Latex file with extension \literate_extension is generated.
1474 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1475 \build_error_filter to process the compilation error messages. \n
1476 In case you want to process your literate file with a script, or some other program,
1477 just insert in your lyxrc file an entry with:\n
1478 \build_command "my_script my_arguments" \n
1479 The \build_error_filter differs from the \literate_error_filter only in that the
1480 former will identify error messages from your compiler.
1481 * \li Syntax: build-program
1484 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1487 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1488 * \li Action: Saves the current buffer to a temporary file.
1489 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1490 is called automatically by LyX, to "autosave" the current buffer.
1491 * \li Syntax: buffer-auto-save
1494 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1496 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1497 * \li Action: Loads the given child document.
1498 * \li Notion: The current document is treated as a parent.
1499 * \li Syntax: buffer-child-open <FILE>
1500 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1501 * \li Origin: Ale, 28 May 1997
1504 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1506 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1507 * \li Action: Runs chktex for the current document.
1508 * \li Syntax: buffer-chktex
1509 * \li Origin: Asger, 30 Oct 1997
1512 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1514 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1515 * \li Action: Toggles compression of the current document on/off.
1516 * \li Syntax: buffer-toggle-compression
1517 * \li Origin: bpeng, 27 Apr 2006
1520 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1522 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1523 * \li Action: Closes the current buffer.
1524 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1525 if the buffer has been modified.
1526 * \li Syntax: buffer-close
1529 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1531 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1532 * \li Action: Exports the current buffer (document) to the given format.
1533 * \li Syntax: buffer-export <FORMAT>
1534 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1535 can find in Tools->Preferences->File formats->Format.
1536 Usual format you will enter is "pdf2" (pdflatex),
1537 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1538 In case of "custom" you will be asked for a format you
1539 want to start from and for the command that you want to
1540 apply to this format. Internally the control is then passed
1541 to #LFUN_BUFFER_EXPORT_CUSTOM.
1542 * \li Origin: Lgb, 29 Jul 1997
1545 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1547 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1548 * \li Action: Exports the current buffer (document) from the given format using
1549 the given command on it.
1550 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1551 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1552 intermediate file).\n
1553 <COMMAND> this command will be launched on the file. Note that you can
1554 use "$$FName" string to qualify the intermediate file.
1555 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1556 * \li Origin: leeming, 27 Mar 2004
1559 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1561 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1562 * \li Action: Prints the current document.
1563 * \li Notion: Many settings can be given via the preferences dialog.
1564 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1565 * \li Params: <TARGET> is either "printer" or "file".\n
1566 <TARGER-NAME> is either "default" or file name or printer name.\n
1567 <COMMAND> command ensuring the printing job.
1568 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1569 * \li Origin: leeming, 28 Mar 2004
1572 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1574 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1575 * \li Action: Import a given file as a lyx document.
1576 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1577 defined convertors in preferences. Look into File->Import menu to get
1578 an idea of the currently active import formats.
1579 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1580 * \li Origin: Asger, 24 Jul 1998
1583 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1585 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1586 * \li Action: Creates a new buffer (that is, document).
1587 * \li Notion: Implicit path can be set in Preferences dialog.
1588 * \li Syntax: buffer-new [<FILE>]
1589 * \li Params: <FILE>: filename of created file with absolute path.
1592 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1594 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1595 * \li Action: Creates a new buffer (that is, document) from a template.
1596 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1597 Template will be asked for via Open-dialog.
1598 * \li Syntax: buffer-new-template [<FILE>]
1599 * \li Params: <FILE>: filename of created file with absolute path.
1602 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1604 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1605 * \li Action: Reverts opened document.
1606 * \li Syntax: buffer-reload
1607 * \li Origin: Asger, 2 Feb 1997
1610 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1612 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1613 * \li Action: Switch to the given buffer.
1614 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1615 document in different LyX windows.
1616 * \li Syntax: buffer-new-template <BUFFER>
1617 * \li Params: <BUFFER>: already opened document which is to be shown.
1620 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1622 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1623 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1624 * \li Syntax: buffer-toggle-read-only
1625 * \li Origin: Lgb, 27 May 1997
1628 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1630 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1631 * \li Action: Displays current buffer in chosen format.
1632 * \li Notion: Displays the contents of the current buffer in the chosen
1633 format, for example, PDF or DVI. This runs the necessary
1634 converter, calls the defined viewer, and so forth.
1635 * \li Syntax: buffer-view <FORMAT>
1636 * \li Params: <FORMAT>: The format to display, where this is one of the
1637 formats defined (in the current GUI) in the
1638 Tools>Preferences>File Formats dialog.
1641 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1643 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1644 * \li Action: Exports the current document and put the result into the
1645 temporary directory.
1646 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1647 the output will be rewriten - updated. This is useful in case your viewer
1648 is able to detect such changes (e.g. ghostview for postscript).
1649 * \li Syntax: buffer-update <FORMAT>
1650 * \li Params: <FORMAT>: The format to display, where this is one of the
1651 formats defined (in the current GUI) in the
1652 Tools>Preferences>File Formats dialog.
1653 * \li Origin: Dekel, 5 Aug 2000
1656 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1659 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1660 * \li Action: Saves the current buffer.
1661 * \li Notion: Saves the current buffer to disk, using the filename that
1662 is already associated with the buffer, asking for one if
1663 none is yet assigned.
1664 * \li Syntax: buffer-write
1667 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1669 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1670 * \li Action: Rename and save current buffer.
1671 * \li Syntax: buffer-write-as <FILENAME>
1672 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1673 is with respect to the original location of the buffer/file.
1676 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1678 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1679 * \li Action: Save all changed documents.
1680 * \li Syntax: buffer-write-all
1681 * \li Origin: rgh, gpothier 6 Aug 2007
1684 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1686 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
1687 * \li Action: Switch to the next opened document.
1688 * \li Notion: Note that this does not necessarily mean next in tabbar
1689 (for full list see View menu).
1690 * \li Syntax: buffer-next
1693 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1695 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
1696 * \li Action: Switch to the previous opened document.
1697 * \li Syntax: buffer-previous
1700 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1702 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
1703 * \li Action: When run from a child document, this updates (exports) document built
1704 from the master buffer. If a master is not found, it updates the
1706 * \li Syntax: master-buffer-update
1707 * \li Author: Tommaso, 20 Sep 2007
1710 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1712 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
1713 * \li Action: When run from a child document, this command shows a preview built
1714 from the master buffer. If a master is not found, it previews the
1716 * \li Syntax: master-buffer-view
1717 * \li Author: Tommaso, 20 Sep 2007
1720 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1722 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
1723 * \li Action: Set language of the current document.
1724 * \li Syntax: buffer-language <LANG>
1725 * \li Params: <LANG>: language name. See lib/languages for list.
1726 * \li Author: leeming, 30 Mar 2004
1729 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1731 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
1732 * \li Action: Save the current document settings as default.
1733 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
1734 * \li Syntax: buffer-save-as-default [<ARGS>]
1735 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1736 you can find in document header of usual .lyx file.
1737 * \li Author: leeming, 30 Mar 2004
1740 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1742 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
1743 * \li Action: Apply the given settings to the current document.
1744 * \li Syntax: buffer-params-apply [<ARGS>]
1745 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1746 you can find in document header of usual .lyx file.
1747 * \li Author: leeming, 30 Mar 2004
1750 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1753 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1754 * \li Action: Inserts another LyX file.
1755 * \li Syntax: file-insert [<FILE>]
1756 * \li Params: <FILE>: Filename to be inserted.
1759 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1761 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1762 * \li Action: Inserts plain text file.
1763 * \li Syntax: file-insert-plaintext [<FILE>]
1764 * \li Params: <FILE>: Filename to be inserted.
1765 * \li Origin: CFO-G, 19 Nov 1997
1768 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1770 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1771 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1772 * \li Syntax: file-insert-plaintext-para [<FILE>]
1773 * \li Params: <FILE>: Filename to be inserted.
1774 * \li Origin: Levon, 14 Feb 2001
1777 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1779 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1780 * \li Action: Open LyX document.
1781 * \li Syntax: file-open [<FILE>]
1782 * \li Params: <FILE>: Filename to be opened.
1785 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1788 * \var lyx::FuncCode lyx::LFUN_CALL
1789 * \li Action: Executes a command defined in a .def file.
1790 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1791 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1792 where <NAME> is the name of the new command and <LFUN> is the lfun code
1793 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1794 \\def_file "FileName" allows to include another .def file. \n
1795 This is particularly useful in connection with toolbar buttons:
1796 Since the name of the button image for this lfun is
1797 lib/images/commands/<NAME>.png this is the way to assign an image
1798 to a complex command-sequence.
1799 * \li Syntax: call <NAME>
1800 * \li Params: <NAME>: Name of the command that must be called.
1801 * \li Origin: broider, 2 Oct 2007
1804 { LFUN_CALL, "call", NoBuffer, System },
1806 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1807 * \li Action: Simulate halting Meta key (Alt key on PCs).
1808 * \li Notion: Used for buffer editation not for GUI control.
1809 * \li Syntax: meta-prefix
1812 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1814 * \var lyx::FuncCode lyx::LFUN_CANCEL
1815 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1816 * \li Syntax: cancel
1819 { LFUN_CANCEL, "cancel", NoBuffer, System },
1822 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1823 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1824 * \li Notion: Usually bound to M-x shortcut.
1825 * \li Syntax: command-execute
1828 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1829 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1831 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1832 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1833 * \li Syntax: command-sequence <CMDS>
1834 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1835 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1836 * \li Origin: Andre', 11 Nov 1999
1839 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1842 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1843 * \li Action: Save user preferences.
1844 * \li Syntax: preferences-save
1845 * \li Origin: Lgb, 27 Nov 1999
1848 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1850 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
1851 * \li Action: Reconfigure the automatic settings.
1852 * \li Syntax: reconfigure
1853 * \li Origin: Asger, 14 Feb 1997
1856 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1858 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
1859 * \li Action: Apply the given settings to user preferences.
1860 * \li Syntax: lyxrc-apply <SETTINGS>
1861 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1862 to get an idea which commands to use and their syntax.
1863 #lyx::LyXRC::LyXRCTags has the list of possible commands.
1866 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1868 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1869 * \li Action: Determine whether keep cursor inside the editing window regardless
1870 the scrollbar movement.
1871 * \li Syntax: toggle-cursor-follows-scrollbar
1872 * \li Origin: ARRae, 2 Dec 1997
1875 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1877 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
1878 * \li Action: Set the given LyX color to the color defined by the X11 name given.
1879 * \li Notion: A new color entry is created if the color is unknown.
1880 Color names can be stored as a part of user settings.
1881 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1882 * \li Origin: SLior, 11 Jun 2000
1885 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1887 * \var lyx::FuncCode lyx::LFUN_STATISTICS
1888 * \li Action: Count the statistics (number of words and characters)
1889 in the document or in the given selection.
1890 * \li Notion: Note that this function gives the number of words/chars written,
1891 not the number of characters which will be typeset.
1892 * \li Syntax: statistics
1893 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1896 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1898 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1899 * \li Action: Show the inline completion at the cursor position.
1900 * \li Syntax: completion-inline
1901 * \li Origin: sts, Feb 19 2008
1904 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1906 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1907 * \li Action: Show the completion popup at the cursor position.
1908 * \li Syntax: completion-popup
1909 * \li Origin: sts, Feb 19 2008
1912 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1914 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
1915 * \li Action: Try to complete the word or command at the cursor position.
1916 * \li Syntax: completion-complete
1917 * \li Origin: sts, Feb 19 2008
1920 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1922 { LFUN_NOACTION, "", Noop, Hidden }
1923 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1926 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1927 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1934 LyXAction::LyXAction()
1940 // Returns an action tag from a string.
1941 FuncRequest LyXAction::lookupFunc(string const & func) const
1943 string const func2 = trim(func);
1945 if (func2.empty()) {
1946 return FuncRequest(LFUN_NOACTION);
1950 string const arg = split(func2, cmd, ' ');
1952 func_map::const_iterator fit = lyx_func_map.find(cmd);
1954 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1958 string const LyXAction::getActionName(FuncCode action) const
1960 info_map::const_iterator const it = lyx_info_map.find(action);
1961 return it != lyx_info_map.end() ? it->second.name : string();
1965 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
1967 info_map::const_iterator const it = lyx_info_map.find(action);
1968 return it != lyx_info_map.end() ? it->second.type : Hidden;
1972 bool LyXAction::funcHasFlag(FuncCode action,
1973 LyXAction::func_attrib flag) const
1975 info_map::const_iterator ici = lyx_info_map.find(action);
1977 if (ici == lyx_info_map.end()) {
1978 LYXERR0("action: " << action << " is not known.");
1979 LASSERT(false, /**/);
1982 return ici->second.attrib & flag;
1986 LyXAction::const_func_iterator LyXAction::func_begin() const
1988 return lyx_func_map.begin();
1992 LyXAction::const_func_iterator LyXAction::func_end() const
1994 return lyx_func_map.end();