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 },
272 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
273 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
274 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
276 * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
277 * \li Action: Inserts an optional-argument (short title) inset.
278 * \li Syntax: optional-insert
279 * \li Origin: Martin, 12 Aug 2002
282 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
284 * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
285 * \li Action: Inserts a horizontal line.
286 * \li Syntax: line-insert
287 * \li Origin: poenitz, Oct 27 2003
290 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
292 * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
293 * \li Action: Inserts a new page.
294 * \li Syntax: newpage-insert<ARG>
295 * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
296 * \li Origin: uwestoehr, 24 Nov 2007
299 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
302 * \li Action: Inserts a marginal note.
303 * \li Syntax: marginalnote-insert
304 * \li Origin: Lgb, 26 Jun 2000
307 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
309 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
310 * \li Action: Inserts a single unicode character.
311 * \li Syntax: unicode-insert <CHAR>
312 * \li Params: <CHAR>: The character to insert, given as its code
313 point, in hexadecimal, e.g.: unicode-insert 0x0100.
314 * \li Origin: Lgb, 22 Oct 2006
317 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
319 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
320 * \li Action: Inserts a new listings inset.
321 * \li Syntax: listing-insert
322 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
325 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
326 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
328 * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
329 * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
330 information in a non-editable boxed InsetText.
331 * \li Notion: Apart from lfun arguments you can use the following method: \n
332 1. input the type and argument of this inset, e.g. "menu paste", in
334 2. select the text and run info-insert lfun.\n
335 * \li Syntax: info-insert <TYPE> <ARG>
336 * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
337 <ARG>: argument for a given type. Look into InsetInfo.h for detailed
339 * \li Origin: bpeng, 7 Oct 2007
342 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
344 * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
345 * \li Action: Inserts branch inset.
346 * \li Syntax: branch-insert <BRANCH-NAME>
347 * \li Origin: vermeer, Aug 17 Aug 2003
350 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
351 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
353 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
354 * \li Action: Inserts CharStyle, Custom inset or XML short element.
355 * \li Notion: Look into the Customization manual for more information about
357 For dissolving the element see #LFUN_INSET_DISSOLVE.
358 * \li Syntax: flex-insert <TYPE:Name>
359 * \li Params: TYPE: CharStyle|Custom|Element|Standard
360 Identifies whether this is a Character Style, a
361 Custom Inset or an XML Element, and which dynamical
362 sub-menu this flex inset is in on the LyX menu tree.
363 If Standard (currently unused): none of these.
364 Name: This name must be defined either in your layout file
365 or imported by some module. The definition is\n
366 InsetLayout <TYPE:Name>
367 * \li Sample: flex-insert CharStyle:Code
370 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
371 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
373 * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
374 * \li Action: Inserts one of horizontal space insets.
375 * \li Syntax: space-insert <NAME> [<LEN>]
376 * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
377 negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
379 <LEN>: length for custom spaces (hspace, hspace* for protected)
380 * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
383 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
384 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
386 * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
387 * \li Action: Inserts various characters into the document.
388 * \li Syntax: specialchar-insert <CHAR>
389 * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
390 end-of-sentence, menu-separator.
391 * \li Origin: JSpitzm, 6 Dec 2007
394 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
395 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
396 { LFUN_APPENDIX, "appendix", Noop, Edit },
398 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
399 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
401 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
402 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
404 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
405 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
407 * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
408 * \li Action: Inserts a line break or new line.
409 * \li Syntax: newline-insert <ARG>
410 * \li Params: <ARG>: <newline|linebreak> default: newline
411 * \li Origin: JSpitzm, 25 Mar 2008
414 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
418 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
421 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
422 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
423 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
424 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
425 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
426 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
427 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
428 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
430 * \var lyx::FuncCode lyx::LFUN_SCROLL
431 * \li Action: Scroll the buffer view.
432 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
433 * \li Syntax: scroll <TYPE> <QUANTITY>
434 * \li Params: <TYPE>: line|page\n
435 <QUANTITY>: up|down|<number>
436 * \li Origin: Abdelrazak Younes, Dec 27 2007
439 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
441 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
442 * \li Action: Recenters the screen on the current cursor position.
443 * \li Syntax: screen-recenter
446 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
447 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
448 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
450 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
452 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
453 * \li Action: Moves the cursor one position logically backwards.
454 * \li Notion: This is not the action which should be bound to the arrow keys,
455 because backwards may be left or right, depending on the
456 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
457 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
458 * \li Syntax: char-backward
461 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
463 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
464 * \li Action: Moves the cursor one position logically backwards, adding
465 traversed position to the selection.
466 * \li Notion: See also #LFUN_CHAR_BACKWARD.
467 * \li Syntax: char-backward-select
470 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
471 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
472 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
474 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
475 * \li Action: Moves the cursor one position logically forward.
476 * \li Notion: This is not the action which should be bound to the arrow keys,
477 because forward may be left or right, depending on the language.
478 The arrow keys should be bound to #LFUN_CHAR_LEFT or
479 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
480 * \li Syntax: char-forward
483 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
485 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
486 * \li Action: Moves the cursor one position logically forward, adding
487 traversed position to the selection.
488 * \li Notion: See also #LFUN_CHAR_FORWARD.
489 * \li Syntax: char-forward-select
492 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
494 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
495 * \li Action: Moves the cursor one position "to the left".
496 * \li Notion: This is the action which should be taken when the "left" key
497 is pressed. Generally, it moves the cursor one position to the
498 left. However, in Bidi text this become slightly more
499 complicated, and there are different modes of cursor movement.
500 In "visual mode", this moves left, plain and simple. In "logical
501 mode", movement is logically forward in RTL paragraphs, and
502 logically backwards in LTR paragraphs.
503 * \li Syntax: char-left
506 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
508 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
509 * \li Action: Moves the cursor one position "to the left", adding
510 traversed position to the selection.
511 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
512 * \li Syntax: char-left-select
515 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
517 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
518 * \li Action: Moves the cursor one position "to the right".
519 * \li Notion: This is the action which should be taken when the "right" key
520 is pressed. Generally, it moves the cursor one position to the
521 right. However, in Bidi text this become slightly more
522 complicated, and there are different modes of cursor movement.
523 In "visual mode", this moves right, plain and simple. In "logical
524 mode", movement is logically forward in LTR paragraphs, and
525 logically backwards in RTL paragraphs.
526 * \li Syntax: char-right
529 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
531 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
532 * \li Action: Moves the cursor one position "to the right", adding
533 traversed position to the selection.
534 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
535 * \li Syntax: char-right-select
538 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
541 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD
542 * \li Action: Moves the cursor to the logically previous beginning of a word.
543 * \li Notion: This is not the action which should be bound to the arrow keys,
544 because backwards may be left or right, depending on the
545 language. The arrow keys should be bound to #LFUN_WORD_LEFT or
546 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
547 * \li Syntax: word-backward
550 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
552 * \var lyx::FuncCode lyx::LFUN_WORD_BACKWARD_SELECT
553 * \li Action: Moves the cursor to the logically previous beginning of a word,
554 adding the logically traversed text to the selection.
555 * \li Notion: See also #LFUN_WORD_BACKWARD.
556 * \li Syntax: word-backward-select
559 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
560 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
561 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
562 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
564 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
565 * \li Action: Search for a given string in forward direction.
566 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
567 * \li Syntax: word-find-forward [<STRING>]
568 * \li Origin: Etienne, 16 Feb 1998
571 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
573 * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
574 * \li Action: Search for a given string in backward direction.
575 * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
576 * \li Syntax: word-find-backward [<STRING>]
577 * \li Origin: Etienne, 20 Feb 1998
580 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
582 * \var lyx::FuncCode lyx::LFUN_WORD_FIND
583 * \li Action: Search for next occurence of a string.
584 * \li Syntax: word-find [<DATA>]
585 * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
586 If no parameter is given, search with last find-dialog
587 data is used for search (i.e. find-next).
588 * \li Origin: poenitz, Jan 7 2004
591 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
592 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
594 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD
595 * \li Action: Moves the cursor to the logically next beginning of a word.
596 * \li Notion: This is not the action which should be bound to the arrow keys,
597 because forward may be left or right, depending on the language.
598 The arrow keys should be bound to #LFUN_WORD_LEFT or
599 #LFUN_WORD_RIGHT actions, which in turn may employ this one.
600 * \li Syntax: word-forward
603 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
605 * \var lyx::FuncCode lyx::LFUN_WORD_FORWARD_SELECT
606 * \li Action: Moves the cursor to the logically next beginning of a word,
607 adding the logically traversed text to the selection.
608 * \li Notion: See also #LFUN_WORD_FORWARD.
609 * \li Syntax: word-forward-select
612 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
614 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT
615 * \li Action: Moves the cursor to the next beginning of a word "on the left".
616 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
617 "left" key is pressed. Generally, it moves the cursor to the
618 next beginning of a word on the left. However, in Bidi text this
619 become slightly more complicated, and there are different modes
620 of cursor movement. In "visual mode", this moves left, plain and
621 simple. In "logical mode", movement is logically forward in RTL
622 paragraphs, and logically backwards in LTR paragraphs.
623 * \li Syntax: word-left
624 * \li Origin: dov, 28 Oct 2007
627 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
629 * \var lyx::FuncCode lyx::LFUN_WORD_LEFT_SELECT
630 * \li Action: Moves the cursor to the next beginning of a word "on the left",
631 adding *logically* traversed text to the selection.
632 * \li Notion: See also #LFUN_WORD_LEFT for exact details of the movement.
633 * \li Syntax: word-left-select
634 * \li Origin: dov, 28 Oct 2007
637 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
638 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
640 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT
641 * \li Action: Moves the cursor to the next beginning of a word "on the right".
642 * \li Notion: This is the action which should be taken when the (e.g., ctrl-)
643 "right" key is pressed. Generally, it moves the cursor to the
644 next beginning of a word on the right. However, in Bidi text
645 this become slightly more complicated, and there are different
646 modes of cursor movement. In "visual mode", this moves right,
647 plain and simple. In "logical mode", movement is logically
648 forward in LTR paragraphs, and logically backwards in RTL
650 * \li Syntax: word-right
651 * \li Origin: dov, 28 Oct 2007
654 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
656 * \var lyx::FuncCode lyx::LFUN_WORD_RIGHT_SELECT
657 * \li Action: Moves the cursor to the next beginning of a word "on the right",
658 adding *logically* traversed text to the selection.
659 * \li Notion: See also #LFUN_WORD_RIGHT for exact details of the movement.
660 * \li Syntax: word-right-select
661 * \li Origin: dov, 28 Oct 2007
664 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
665 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
666 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
668 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
669 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
670 * \li Syntax: thesaurus-entry
671 * \li Origin: Levon, 20 Jul 2001
674 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
675 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
676 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
677 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
678 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
680 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
681 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
682 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
683 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
684 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
686 * \var lyx::FuncCode lyx::LFUN_COPY
687 * \li Action: Copies to the clipboard the last edit.
691 { LFUN_COPY, "copy", ReadOnly, Edit },
693 * \var lyx::FuncCode lyx::LFUN_CUT
694 * \li Action: Cuts to the clipboard.
698 { LFUN_CUT, "cut", Noop, Edit },
700 * \var lyx::FuncCode lyx::LFUN_PASTE
701 * \li Action: Pastes from the active clipboard.
705 { LFUN_PASTE, "paste", Noop, Edit },
706 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
708 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
709 * \li Action: Pastes the material currently selected.
710 * \li Syntax: primary-selection-paste
713 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
715 * \var lyx::FuncCode lyx::LFUN_UNDO
716 * \li Action: Undoes the last edit.
720 { LFUN_UNDO, "undo", Noop, Edit },
722 * \var lyx::FuncCode lyx::LFUN_REDO
723 * \li Action: Redoes the last thing undone.
727 { LFUN_REDO, "redo", Noop, Edit },
729 * \var lyx::FuncCode lyx::LFUN_REPEAT
730 * \li Action: Repeat the given command.
731 * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
732 * \li Author: poenitz, 27 Oct 2003
735 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
736 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
738 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
739 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
740 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
742 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
743 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
744 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
745 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
746 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
747 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
748 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
749 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
750 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
751 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
752 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
753 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
754 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
755 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
756 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
758 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
759 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
760 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
761 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
764 * \var lyx::FuncCode lyx::LFUN_LAYOUT
765 * \li Action: Sets the layout (that is, environment) for the current paragraph.
766 * \li Syntax: layout <LAYOUT>
767 * \li Params: <LAYOUT>: the layout to use
770 { LFUN_LAYOUT, "layout", Noop, Layout },
772 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
773 * \li Action: Launches the paragraph settings dialog.
774 * \li Syntax: layout-paragraph
777 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
778 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
780 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
781 * \li Action: Displays list of layout choices.
782 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
783 dropbox allowing for choice of layout.
784 * \li Syntax: drop-layouts-choice
787 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
789 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
790 * \li Action: Clears the module list.
791 * \li Notion: Clears the list of included modules for the current buffer.
792 * \li Syntax: layout-modules-clear
793 * \li Origin: rgh, 25 August 2007
796 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
798 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
799 * \li Action: Adds a module.
800 * \li Notion: Adds a module to the list of included modules for the current buffer.
801 * \li Syntax: layout-module-add <MODULE>
802 * \li Params: <MODULE>: the module to be added
803 * \li Origin: rgh, 25 August 2007
806 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
808 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
809 * \li Action: Reloads layout information.
810 * \li Notion: Reloads all layout information for the current buffer from disk, thus
811 recognizing any changes that have been made to layout files on the fly.
812 This is intended to be used only by layout developers and should not be
813 used when one is trying to do actual work.
814 * \li Syntax: layout-reload
815 * \li Origin: rgh, 3 September 2007
818 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
820 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
821 * \li Action: Sets the text class for the current buffer.
822 * \li Syntax: textclass-apply <TEXTCLASS>
823 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
824 the filename, minus the ".layout" extension.
827 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
829 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
830 * \li Action: Loads information for a textclass from disk.
831 * \li Syntax: textclass-load <TEXTCLASS>
832 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
833 the filename, minus the ".layout" extension.
836 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
839 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
840 * \li Action: Disable selecting of text-region.
841 * \li Syntax: mark-off
844 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
846 * \var lyx::FuncCode lyx::LFUN_MARK_ON
847 * \li Action: Enable selecting of text-region.
848 * \li Notion: After enabling you can simply move arrow keys to get selected region.
849 * \li Syntax: mark-on
852 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
854 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
855 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
856 * \li Syntax: mark-toggle
857 * \li Origin: poenitz, May 5 2006
860 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
862 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
863 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
864 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
865 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
866 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
867 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
868 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
869 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
870 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
871 { LFUN_MATH_SPACE, "math-space", Noop, Math },
872 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
873 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
874 { LFUN_MATH_MODE, "math-mode", Noop, Math },
876 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
877 * \li Action: Toggles numbering of the current formula line.
878 * \li Notion: Must be in display formula mode.
879 * \li Syntax: math-number-line-toggle
880 * \li Origin: Alejandro 18 Jun 1996
883 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
885 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
886 * \li Action: Toggles numbering/labeling of the current formula.
887 * \li Notion: Must be in display formula mode.
888 * \li Syntax: math-number-toggle
889 * \li Origin: Alejandro 4 Jun 1996
892 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
893 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
894 { LFUN_MATH_SIZE, "math-size", Noop, Math },
896 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
897 * \li Action: Unfold a Math Macro.
898 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
900 * \li Syntax: math-macro-unfold
901 * \li Origin: sts, 06 January 2008
904 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
906 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
907 * \li Action: Fold a Math Macro.
908 * \li Notion: Fold the Math Macro the cursor is in if it was
909 unfolded, i.e. displayed as \foo before.
910 * \li Syntax: math-macro-fold
911 * \li Origin: sts, 06 January 2008
914 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
916 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
917 * \li Action: Add a parameter.
918 * \li Notion: Add a parameter to a Math Macro.
919 * \li Params: <NUM>: The number of the parameter behind which the new one
920 will be added (1 for the first, i.e. use 0 for add a
921 parameter at the left), defaults to the last one.
922 * \li Syntax: math-macro-add-param <NUM>
923 * \li Origin: sts, 06 January 2008
926 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
928 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
929 * \li Action: Remove the last parameter.
930 * \li Notion: Remove the last parameter of a Math Macro and
931 remove its value in all instances of the macro
933 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
934 the first), defaults to the last one.
935 * \li Syntax: math-macro-remove-param <NUM>
936 * \li Origin: sts, 06 January 2008
939 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
941 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
942 * \li Action: Append a greedy parameter.
943 * \li Notion: Append a greedy parameter to a Math Macro which
944 eats the following mathed cell in every instance of
945 the macro in the buffer.
946 * \li Syntax: math-macro-append-greedy-param
947 * \li Origin: sts, 06 January 2008
950 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
952 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
953 * \li Action: Remove a greedy parameter.
954 * \li Notion: Remove a greedy parameter of a Math Macro and spit
955 out the values of it in every instance of the macro
956 in the buffer. If it is an optional parameter the [valud]
958 * \li Syntax: math-macro-remove-greedy-param
959 * \li Origin: sts, 06 January 2008
962 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
964 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
965 * \li Action: Make a parameter optional.
966 * \li Notion: Turn the first non-optional parameter of a Math Macro
967 into an optional parameter with a default value.
968 * \li Syntax: math-macro-make-optional
969 * \li Origin: sts, 06 January 2008
972 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
974 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
975 * \li Action: Make a parameter non-optional.
976 * \li Notion: Turn the last optional parameter of a Math Macro
977 into a non-optional parameter. The default value is
978 remembered to be reused later if the user changes his mind.
979 * \li Syntax: math-macro-make-nonoptional
980 * \li Origin: sts, 06 January 2008
983 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
985 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
986 * \li Action: Add an optional parameter.
987 * \li Notion: Insert an optional parameter just behind the
988 already existing optional parameters.
989 * \li Syntax: math-macro-add-optional-param
990 * \li Origin: sts, 06 January 2008
993 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
995 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
996 * \li Action: Remove the last optional parameter.
997 * \li Notion: Remove the last optional parameter of a Math Macro and
998 remove it in all the instances of the macro in the buffer.
999 * \li Syntax: math-macro-remove-optional-param
1000 * \li Origin: sts, 06 January 2008
1003 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1005 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1006 * \li Action: Add a greedy optional parameter.
1007 * \li Notion: Add a greedy optional parameter which eats the value
1008 from the following cells in mathed which are in the [value]
1010 * \li Syntax: math-macro-add-greedy-optional-param
1011 * \li Origin: sts, 06 January 2008
1014 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1016 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1017 * \li Action: Only active in Math Macro definition.
1018 * \li Notion: Dummy function which is only active in a Math Macro definition.
1019 It's used to toggle the Math Macro toolbar if the cursor moves
1020 into a Math Macro definition.
1021 * \li Syntax: in-mathmacrotemplate
1022 * \li Origin: sts, 06 January 2008
1025 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1028 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1029 * \li Action: Moves the current paragraph downwards in the document.
1030 * \li Syntax: paragraph-move-down
1031 * \li Origin: Edwin, 8 Apr 2006
1034 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1036 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1037 * \li Action: Moves the current paragraph upwards in the document.
1038 * \li Syntax: paragraph-move-up
1039 * \li Origin: Edwin, 8 Apr 2006
1042 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1045 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1046 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1047 in upward direction.
1048 * \li Syntax: paragraph-up
1049 * \li Origin: Asger, 1 Oct 1996
1052 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1054 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1055 * \li Action: Move the cursor and select the text to the next paragraph (or
1056 begining of the current one) in upward direction.
1057 * \li Syntax: paragraph-up-select
1058 * \li Origin: Asger, 1 Oct 1996
1061 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1063 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1064 * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1065 in downward direction.
1066 * \li Syntax: paragraph-down
1067 * \li Origin: Asger, 1 Oct 1996
1070 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1072 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1073 * \li Action: Move the cursor and select the text to the next paragraph (or
1074 begining of the current one) in downward direction.
1075 * \li Syntax: paragraph-down-select
1076 * \li Origin: Asger, 1 Oct 1996
1079 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1081 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1082 * \li Action: Jump to a paragraph given by its id number.
1083 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1084 seen on the screen. Moreover the id is unique for all opened buffers (documents).
1085 * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
1086 * \li Origin: Dekel, 26 Aug 2000
1089 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1091 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1092 * \li Action: Breaks the current paragraph at the current location.
1093 * \li Syntax: break-paragraph
1096 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1097 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1099 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1100 * \li Action: Breaks the current paragraph at the current location,
1101 unless used at the beginning of a line, where it sets
1102 the label width string to empty.
1103 * \li Syntax: break-paragraph-skip
1106 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1108 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1109 * \li Action: Change paragraph settings.
1110 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1111 This function only modifies, and does not override, existing settings.
1112 Note that the "leftindent" indent setting is deprecated.
1113 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1114 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1115 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1116 <ALIGN>: \\align block|left|right|center|default\n
1117 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
1118 * \li Origin: rgh, Aug 15 2007
1121 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1123 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1124 * \li Action: Change paragraph settings.
1125 * \li Notion: Overwrite all nonspecified settings to the default ones.
1126 Use paragraph-params lfun if you don't want to overwrite others settings.
1127 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1128 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1129 * \li Origin: leeming, 30 Mar 2004
1132 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1133 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1136 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1137 * \li Action: Move the current group in the upward direction in the
1138 structure of the document.
1139 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1140 the whole substructure of the group.
1141 * \li Syntax: outline-up
1142 * \li Origin: Vermeer, 23 Mar 2006
1145 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1147 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1148 * \li Action: Move the current group in the downward direction in the
1149 structure of the document.
1150 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1151 the whole substructure of the group.
1152 * \li Syntax: outline-down
1153 * \li Origin: Vermeer, 23 Mar 2006
1156 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1158 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1159 * \li Action: Moves the current group in the downward direction in the
1160 hierarchy of the document structure.
1161 * \li Notion: Part -> Chapter -> Section -> etc.
1162 * \li Syntax: outline-in
1163 * \li Origin: Vermeer, 23 Mar 2006
1166 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1168 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1169 * \li Action: Moves the current group in the upward direction in the
1170 hierarchy of the document structure.
1171 * \li Notion: Part <- Chapter <- Section <- etc.
1172 * \li Syntax: outline-out
1173 * \li Origin: Vermeer, 23 Mar 2006
1176 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1178 * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1179 * \li Action: Edit the inset at cursor with an external application,
1180 * if one is attributed.
1181 * \li Syntax: inset-edit [<INSET_PARAMS>]
1182 * \li Params: <INSET_PARAMS>: Parameters for the inset.
1183 Currently only the filename will be considered.
1184 * \li Origin: JSpitzm, 27 Apr 2006
1187 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1189 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1190 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1191 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1192 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1193 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1195 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1196 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1197 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1198 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1199 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1201 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1202 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1203 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1204 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1205 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1206 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1207 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1208 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1211 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1212 * \li Action: Apply data for an inset.
1213 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1214 be applied. This is either changed to #LFUN_INSET_MODIFY or
1215 #LFUN_INSET_INSERT depending on the context where it is called.
1216 * \li Syntax: inset-apply <ARGS>
1217 * \li Params: See #LFUN_INSET_INSERT .
1220 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1222 * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1223 * \li Action: Dissolve the current inset into text.
1224 * \li Syntax: inset-dissolve [<INSET>]
1225 * \li Params: <INSET>: this can be used to make sure the right kind of inset
1226 is dissolved. For example "dissolve" entry in the charstyles
1227 sub-menu should only dissolve the charstyle inset, even if the
1228 cursor is inside several nested insets of different type.\n
1229 For values see #lyx::InsetLayout::lyxtype_ .
1230 * \li Author: JSpitz, 7 Aug 2006
1233 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1235 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1236 * \li Action: Insert new inset (type given by the parameters).
1237 * \li Syntax: inset-insert <INSET> <ARGS>
1238 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1239 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1240 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1242 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1243 where <label name> is the name of the referenced label and
1244 <Format> is one of the following: \n
1245 ref -- <reference> \n
1246 eqref -- (<reference>) \n
1247 pageref -- <page> \n
1248 vpageref -- on <page> \n
1249 vref -- <reference> on <page> \n
1250 prettyref -- Formatted reference
1253 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1255 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1256 * \li Action: Modify existing inset.
1257 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1258 bibtex, ert, command, graphics, note, space, vspace, tabular,
1259 bibitem, inlude, ref insets.
1260 * \li Syntax: inset-modify <INSET> <ARGS>
1261 * \li Params: See #LFUN_INSET_INSERT for further details.
1264 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1266 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1267 * \li Action: Modify the inset at cursor position, if there is one.
1268 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1269 bibtex, ert, command, graphics, note, space, vspace, tabular,
1270 bibitem, inlude, ref insets.
1271 * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1272 * \li Params: See #LFUN_INSET_INSERT for further details.
1273 * \li Origin: JSpitzm, 23 Mar 2008
1276 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1277 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1279 * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1280 * \li Action: Open the inset's properties dialog.
1281 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1282 * \li Syntax: inset-settings <INSET>
1283 * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1286 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1288 * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1289 * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1290 be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1291 be entered. Also cf. #LFUN_INSET_SETTINGS.
1292 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1293 bibtex, ert, command, graphics, note, space, vspace, tabular,
1294 bibitem, inlude, ref insets.
1295 * \li Syntax: next-inset-toggle <ARG>
1296 * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1297 * \li Origin: leeming, 30 Mar 2004
1300 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1302 * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1303 * \li Action: Toggles the collapsable inset we are currently in.
1304 * \li Syntax: inset-toggle [<ARG>]
1305 * \li Params: <ARG>: <open|close|toggle|assign>. \n
1306 open/close/toggle are for collapsable insets. close can be currently used
1307 by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1308 assign is for branch inset.
1309 * \li Origin: lasgouttes, 19 Jul 2001
1312 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1314 * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1315 * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1316 * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1317 * \li Syntax: all-insets-toggle <STATE> <INSET>
1318 * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1319 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1320 * \li Origin: leeming, 30 Mar 2004
1323 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1325 * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1326 * \li Action: Unify all graphics insets with the one given as an parameter.
1327 * \li Notion: This is internally used for synchronize certain group of graphics insets.
1328 * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1329 * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1330 (syntax can be seen in .lyx files).
1331 * \li Origin: sanda, 6 May 2008
1334 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1336 * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1337 * \li Action: Set the group for the graphics inset on the cursor position.
1338 * \li Syntax: set-graphics-group [<GROUP>]
1339 * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1340 the graphics inset is removed from the current group.
1341 * \li Origin: sanda, 6 May 2008
1344 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1347 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1348 * \li Action: Moves the cursor out of the current slice, going forward.
1349 * \li Notion: Cursor movement within an inset may be different than cursor
1350 movement in the surrounding text. This action should be called
1351 automatically by the cursor movement within the inset, when
1352 movement within the inset has ceased (reached the end of the
1353 last paragraph, for example), in order to move correctly
1354 back into the surrounding text.
1357 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1359 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1360 * \li Action: Moves the cursor out of the current slice, going backwards.
1361 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1364 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1366 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1367 * \li Action: Moves the cursor out of the current slice, going right.
1368 * \li Notion: See also #LFUN_FINISHED_FORWARD
1371 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1373 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1374 * \li Action: Moves the cursor out of the current slice, going left.
1375 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1378 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1380 { LFUN_LANGUAGE, "language", Noop, Edit },
1383 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1384 * \li Action: Goto a label.
1385 * \li Syntax: label-goto [<LABEL>]
1386 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1387 is on cursor position, Bookmark 0 is saved and
1388 cursor moves to the position of referenced label.
1389 * \li Origin: Ale, 6 Aug 1997
1392 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1393 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1395 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1396 * \li Action: Go to the next label or cross-reference.
1397 * \li Syntax: reference-next
1398 * \li Origin: Dekel, 14 Jan 2001
1401 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1404 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1405 * \li Action: Goto a bookmark.
1406 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1407 if necessary. Note that bookmarsk are saved per-session, not
1409 * \li Syntax: bookmark-goto <NUMBER>
1410 * \li Params: <NUMBER>: the number of the bookmark to restore.
1411 * \li Origin: Dekel, 27 January 2001
1414 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1416 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1417 * \li Action: Save a bookmark.
1418 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1419 must be between 1 and 9, inclusive. Note that bookmarks are
1420 saved per-session, not per file.
1421 * \li Syntax: bookmark-save <NUMBER>
1422 * \li Params: <NUMBER>: the number of the bookmark to save.
1423 * \li Origin: Dekel, 27 January 2001
1426 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1428 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1429 * \li Action: Clears the list of saved bookmarks.
1430 * \li Syntax: bookmark-clear
1431 * \li Origin: bpeng, 31 October 2006
1434 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1437 * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1438 * \li Action: Open the given help file according to the language setting.
1439 * \li Syntax: help-open <FILE>[.lyx]
1440 * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1441 * \li Author: Jug, 27 Jun 1999
1444 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1446 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1447 * \li Action: Terminates the current LyX instance.
1448 * \li Notion: Terminates the current LyX instance, asking whether to save
1449 modified documents, etc.
1450 * \li Syntax: lyx-quit
1453 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1455 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1456 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1457 * \li Notion: Skiping "auto" when allowauto is false.
1458 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1459 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1460 minibuffer|review|view/update|math_panels
1461 * \li Origin: Edwin, 21 May 2007
1464 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1466 * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1467 * \li Action: Opens the menu given by its name.
1468 * \li Syntax: menu-open <NAME>
1469 * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1472 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1474 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1475 * \li Action: Various UI visibility-toggling actions.
1476 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1477 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1478 menubar : Toggle visibility of the menubar.\n
1479 scrollbar : Toggle visibility of the scrollbar.\n
1480 frame : Toggle visibility of the frames around editing window.\n
1481 fullscreen : Toggle fullscreen mode. This also covers calling the
1482 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1483 custom tweaks of the toolbars should be used.
1484 * \li Origin: ps, 9 Feb 2007
1487 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1490 * \var lyx::FuncCode lyx::WINDOW_NEW
1491 * \li Action: Creates new empty LyX window.
1492 * \li Notion: Already opened documents from the previous window can be found under View menu.
1493 * \li Syntax: window-new [<GEOMETRY>]
1494 * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1495 accepted only on Windows platform.
1496 * \li Origin: Abdel, 21 Oct 2006
1499 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1501 * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1502 * \li Action: Closes the current LyX window.
1503 * \li Syntax: window-close
1504 * \li Origin: Abdel, 23 Oct 2006
1507 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1510 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1511 * \li Action: Creates another split view of current buffer.
1512 * \li Notion: All split views act in the same way indpendently.
1513 * \li Syntax: split-view <vertical|horizontal>
1514 * \li Params: horizontal : The work areas are laid out side by side.\n
1515 vertical : The work areas laid out vertically.\n
1516 * \li Origin: abdel, 20 Feb 2008
1519 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1522 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1523 * \li Action: Close the current tab group.
1524 * \li Notion: This only closes the work areas, not the buffer themselves.
1525 The still opened buffers can be visualized in another tab group.
1526 * \li Syntax: close-tab-group
1527 * \li Origin: abdel, 21 Feb 2008
1530 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1531 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1532 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1533 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1534 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1535 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1536 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1538 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1539 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1540 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1541 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1542 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1544 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1545 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1546 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1547 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1549 { LFUN_MESSAGE, "message", NoBuffer, System },
1550 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1551 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1553 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1554 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1555 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1557 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1558 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1559 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1560 * \li Origin: Edmar, 23 Dec 1998
1563 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1564 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1566 * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1567 * \li Action: Sets the cursor position based on the editing area coordinates
1568 (similar as clicking on that point with left mouse button).
1569 * \li Syntax: server-set-xy <X> <Y>
1572 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1574 * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1575 * \li Action: Returns the coordinates of cursor position in the editing area.
1576 * \li Syntax: server-get-xy
1579 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1582 * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1583 * \li Action: Generates the code (literate programming).
1584 * \li Notion: Latex file with extension \literate_extension is generated.
1585 Then LyX invokes \build_command (with a default of``make'') to generate the code and
1586 \build_error_filter to process the compilation error messages. \n
1587 In case you want to process your literate file with a script, or some other program,
1588 just insert in your lyxrc file an entry with:\n
1589 \build_command "my_script my_arguments" \n
1590 The \build_error_filter differs from the \literate_error_filter only in that the
1591 former will identify error messages from your compiler.
1592 * \li Syntax: build-program
1595 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1598 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1599 * \li Action: Saves the current buffer to a temporary file.
1600 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1601 is called automatically by LyX, to "autosave" the current buffer.
1602 * \li Syntax: buffer-auto-save
1605 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1607 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1608 * \li Action: Loads the given child document.
1609 * \li Notion: The current document is treated as a parent.
1610 * \li Syntax: buffer-child-open <FILE>
1611 * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1612 * \li Origin: Ale, 28 May 1997
1615 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1617 * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1618 * \li Action: Runs chktex for the current document.
1619 * \li Syntax: buffer-chktex
1620 * \li Origin: Asger, 30 Oct 1997
1623 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1625 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1626 * \li Action: Toggles compression of the current document on/off.
1627 * \li Syntax: buffer-toggle-compression
1628 * \li Origin: bpeng, 27 Apr 2006
1631 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1633 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1634 * \li Action: Closes the current buffer.
1635 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1636 if the buffer has been modified.
1637 * \li Syntax: buffer-close
1640 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1642 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1643 * \li Action: Exports the current buffer (document) to the given format.
1644 * \li Syntax: buffer-export <FORMAT>
1645 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1646 can find in Tools->Preferences->File formats->Format.
1647 Usual format you will enter is "pdf2" (pdflatex),
1648 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1649 In case of "custom" you will be asked for a format you
1650 want to start from and for the command that you want to
1651 apply to this format. Internally the control is then passed
1652 to #LFUN_BUFFER_EXPORT_CUSTOM.
1653 * \li Origin: Lgb, 29 Jul 1997
1656 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1658 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1659 * \li Action: Exports the current buffer (document) from the given format using
1660 the given command on it.
1661 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1662 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1663 intermediate file).\n
1664 <COMMAND> this command will be launched on the file. Note that you can
1665 use "$$FName" string to qualify the intermediate file.
1666 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1667 * \li Origin: leeming, 27 Mar 2004
1670 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1672 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1673 * \li Action: Prints the current document.
1674 * \li Notion: Many settings can be given via the preferences dialog.
1675 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1676 * \li Params: <TARGET> is either "printer" or "file".\n
1677 <TARGER-NAME> is either "default" or file name or printer name.\n
1678 <COMMAND> command ensuring the printing job.
1679 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1680 * \li Origin: leeming, 28 Mar 2004
1683 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1685 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1686 * \li Action: Import a given file as a lyx document.
1687 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1688 defined convertors in preferences. Look into File->Import menu to get
1689 an idea of the currently active import formats.
1690 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1691 * \li Origin: Asger, 24 Jul 1998
1694 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1696 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1697 * \li Action: Creates a new buffer (that is, document).
1698 * \li Notion: Implicit path can be set in Preferences dialog.
1699 * \li Syntax: buffer-new [<FILE>]
1700 * \li Params: <FILE>: filename of created file with absolute path.
1703 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1705 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1706 * \li Action: Creates a new buffer (that is, document) from a template.
1707 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1708 Template will be asked for via Open-dialog.
1709 * \li Syntax: buffer-new-template [<FILE>]
1710 * \li Params: <FILE>: filename of created file with absolute path.
1713 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1715 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1716 * \li Action: Reverts opened document.
1717 * \li Syntax: buffer-reload
1718 * \li Origin: Asger, 2 Feb 1997
1721 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1723 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1724 * \li Action: Switch to the given buffer.
1725 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1726 document in different LyX windows.
1727 * \li Syntax: buffer-new-template <BUFFER>
1728 * \li Params: <BUFFER>: already opened document which is to be shown.
1731 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1733 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1734 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1735 * \li Syntax: buffer-toggle-read-only
1736 * \li Origin: Lgb, 27 May 1997
1739 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1741 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1742 * \li Action: Displays current buffer in chosen format.
1743 * \li Notion: Displays the contents of the current buffer in the chosen
1744 format, for example, PDF or DVI. This runs the necessary
1745 converter, calls the defined viewer, and so forth.
1746 * \li Syntax: buffer-view <FORMAT>
1747 * \li Params: <FORMAT>: The format to display, where this is one of the
1748 formats defined (in the current GUI) in the
1749 Tools>Preferences>File Formats dialog.
1752 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1754 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1755 * \li Action: Exports the current document and put the result into the
1756 temporary directory.
1757 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1758 the output will be rewriten - updated. This is useful in case your viewer
1759 is able to detect such changes (e.g. ghostview for postscript).
1760 * \li Syntax: buffer-update <FORMAT>
1761 * \li Params: <FORMAT>: The format to display, where this is one of the
1762 formats defined (in the current GUI) in the
1763 Tools>Preferences>File Formats dialog.
1764 * \li Origin: Dekel, 5 Aug 2000
1767 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1770 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1771 * \li Action: Saves the current buffer.
1772 * \li Notion: Saves the current buffer to disk, using the filename that
1773 is already associated with the buffer, asking for one if
1774 none is yet assigned.
1775 * \li Syntax: buffer-write
1778 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1780 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1781 * \li Action: Rename and save current buffer.
1782 * \li Syntax: buffer-write-as <FILENAME>
1783 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1784 is with respect to the original location of the buffer/file.
1787 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1789 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1790 * \li Action: Save all changed documents.
1791 * \li Syntax: buffer-write-all
1792 * \li Origin: rgh, gpothier 6 Aug 2007
1795 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1797 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
1798 * \li Action: Switch to the next opened document.
1799 * \li Notion: Note that this does not necessarily mean next in tabbar
1800 (for full list see View menu).
1801 * \li Syntax: buffer-next
1804 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1806 * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
1807 * \li Action: Switch to the previous opened document.
1808 * \li Syntax: buffer-previous
1811 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1813 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
1814 * \li Action: When run from a child document, this updates (exports) document built
1815 from the master buffer. If a master is not found, it updates the
1817 * \li Syntax: master-buffer-update
1818 * \li Author: Tommaso, 20 Sep 2007
1821 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1823 * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
1824 * \li Action: When run from a child document, this command shows a preview built
1825 from the master buffer. If a master is not found, it previews the
1827 * \li Syntax: master-buffer-view
1828 * \li Author: Tommaso, 20 Sep 2007
1831 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1833 * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
1834 * \li Action: Set language of the current document.
1835 * \li Syntax: buffer-language <LANG>
1836 * \li Params: <LANG>: language name. See lib/languages for list.
1837 * \li Author: leeming, 30 Mar 2004
1840 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1842 * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
1843 * \li Action: Save the current document settings as default.
1844 * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
1845 * \li Syntax: buffer-save-as-default [<ARGS>]
1846 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1847 you can find in document header of usual .lyx file.
1848 * \li Author: leeming, 30 Mar 2004
1851 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1853 * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
1854 * \li Action: Apply the given settings to the current document.
1855 * \li Syntax: buffer-params-apply [<ARGS>]
1856 * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1857 you can find in document header of usual .lyx file.
1858 * \li Author: leeming, 30 Mar 2004
1861 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1864 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1865 * \li Action: Inserts another LyX file.
1866 * \li Syntax: file-insert [<FILE>]
1867 * \li Params: <FILE>: Filename to be inserted.
1870 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1872 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1873 * \li Action: Inserts plain text file.
1874 * \li Syntax: file-insert-plaintext [<FILE>]
1875 * \li Params: <FILE>: Filename to be inserted.
1876 * \li Origin: CFO-G, 19 Nov 1997
1879 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1881 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1882 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1883 * \li Syntax: file-insert-plaintext-para [<FILE>]
1884 * \li Params: <FILE>: Filename to be inserted.
1885 * \li Origin: Levon, 14 Feb 2001
1888 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1890 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1891 * \li Action: Open LyX document.
1892 * \li Syntax: file-open [<FILE>]
1893 * \li Params: <FILE>: Filename to be opened.
1896 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1899 * \var lyx::FuncCode lyx::LFUN_CALL
1900 * \li Action: Executes a command defined in a .def file.
1901 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1902 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1903 where <NAME> is the name of the new command and <LFUN> is the lfun code
1904 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1905 \\def_file "FileName" allows to include another .def file. \n
1906 This is particularly useful in connection with toolbar buttons:
1907 Since the name of the button image for this lfun is
1908 lib/images/commands/<NAME>.png this is the way to assign an image
1909 to a complex command-sequence.
1910 * \li Syntax: call <NAME>
1911 * \li Params: <NAME>: Name of the command that must be called.
1912 * \li Origin: broider, 2 Oct 2007
1915 { LFUN_CALL, "call", NoBuffer, System },
1917 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1918 * \li Action: Simulate halting Meta key (Alt key on PCs).
1919 * \li Notion: Used for buffer editation not for GUI control.
1920 * \li Syntax: meta-prefix
1923 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1925 * \var lyx::FuncCode lyx::LFUN_CANCEL
1926 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1927 * \li Syntax: cancel
1930 { LFUN_CANCEL, "cancel", NoBuffer, System },
1933 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1934 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1935 * \li Notion: Usually bound to M-x shortcut.
1936 * \li Syntax: command-execute
1939 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1940 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1942 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1943 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1944 * \li Syntax: command-sequence <CMDS>
1945 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1946 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1947 * \li Origin: Andre', 11 Nov 1999
1950 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1953 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1954 * \li Action: Save user preferences.
1955 * \li Syntax: preferences-save
1956 * \li Origin: Lgb, 27 Nov 1999
1959 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1961 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
1962 * \li Action: Reconfigure the automatic settings.
1963 * \li Syntax: reconfigure
1964 * \li Origin: Asger, 14 Feb 1997
1967 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1969 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
1970 * \li Action: Apply the given settings to user preferences.
1971 * \li Syntax: lyxrc-apply <SETTINGS>
1972 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1973 to get an idea which commands to use and their syntax.
1974 #lyx::LyXRC::LyXRCTags has the list of possible commands.
1977 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1979 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1980 * \li Action: Determine whether keep cursor inside the editing window regardless
1981 the scrollbar movement.
1982 * \li Syntax: toggle-cursor-follows-scrollbar
1983 * \li Origin: ARRae, 2 Dec 1997
1986 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1988 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
1989 * \li Action: Set the given LyX color to the color defined by the X11 name given.
1990 * \li Notion: A new color entry is created if the color is unknown.
1991 Color names can be stored as a part of user settings.
1992 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1993 * \li Origin: SLior, 11 Jun 2000
1996 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1998 * \var lyx::FuncCode lyx::LFUN_STATISTICS
1999 * \li Action: Count the statistics (number of words and characters)
2000 in the document or in the given selection.
2001 * \li Notion: Note that this function gives the number of words/chars written,
2002 not the number of characters which will be typeset.
2003 * \li Syntax: statistics
2004 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2007 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2009 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2010 * \li Action: Show the inline completion at the cursor position.
2011 * \li Syntax: completion-inline
2012 * \li Origin: sts, Feb 19 2008
2015 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2017 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2018 * \li Action: Show the completion popup at the cursor position.
2019 * \li Syntax: completion-popup
2020 * \li Origin: sts, Feb 19 2008
2023 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2025 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2026 * \li Action: Try to complete the word or command at the cursor position.
2027 * \li Syntax: completion-complete
2028 * \li Origin: sts, Feb 19 2008
2031 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2033 { LFUN_NOACTION, "", Noop, Hidden }
2034 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2037 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2038 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2045 LyXAction::LyXAction()
2051 // Returns an action tag from a string.
2052 FuncRequest LyXAction::lookupFunc(string const & func) const
2054 string const func2 = trim(func);
2056 if (func2.empty()) {
2057 return FuncRequest(LFUN_NOACTION);
2061 string const arg = split(func2, cmd, ' ');
2063 func_map::const_iterator fit = lyx_func_map.find(cmd);
2065 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2069 string const LyXAction::getActionName(FuncCode action) const
2071 info_map::const_iterator const it = lyx_info_map.find(action);
2072 return it != lyx_info_map.end() ? it->second.name : string();
2076 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2078 info_map::const_iterator const it = lyx_info_map.find(action);
2079 return it != lyx_info_map.end() ? it->second.type : Hidden;
2083 bool LyXAction::funcHasFlag(FuncCode action,
2084 LyXAction::func_attrib flag) const
2086 info_map::const_iterator ici = lyx_info_map.find(action);
2088 if (ici == lyx_info_map.end()) {
2089 LYXERR0("action: " << action << " is not known.");
2090 LASSERT(false, /**/);
2093 return ici->second.attrib & flag;
2097 LyXAction::const_func_iterator LyXAction::func_begin() const
2099 return lyx_func_map.begin();
2103 LyXAction::const_func_iterator LyXAction::func_end() const
2105 return lyx_func_map.end();