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 <boost/assert.hpp>
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
296 * \li Origin: uwestoehr, 24 Nov 2007
299 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
301 * \var lyx::FuncCode lyx::LFUN_PAGEBREAK_INSERT
302 * \li Action: Inserts a pagebreak.
303 * \li Syntax: pagebreak-insert
304 * \li Origin: poenitz, Oct 27 2003
307 { LFUN_PAGEBREAK_INSERT, "pagebreak-insert", Noop, Edit },
309 * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
310 * \li Action: Inserts a marginal note.
311 * \li Syntax: marginalnote-insert
312 * \li Origin: Lgb, 26 Jun 2000
315 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
317 * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
318 * \li Action: Inserts a single unicode character.
319 * \li Syntax: unicode-insert <CHAR>
320 * \li Params: <CHAR>: The character to insert, given as its code
321 point, in hexadecimal, e.g.: unicode-insert 0x0100.
322 * \li Origin: Lgb, 22 Oct 2006
325 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
327 * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
328 * \li Action: Inserts a new listings inset.
329 * \li Syntax: listing-insert
330 * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
333 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
334 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
335 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
336 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
337 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
339 * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
340 * \li Action: Inserts CharStyle, Custom inset or XML short element.
341 * \li Notion: Look into the Customization manual for more information about
343 For dissolving the element see #LFUN_INSET_DISSOLVE.
344 * \li Syntax: flex-insert <TYPE:Name>
345 * \li Params: TYPE: CharStyle|Custom|Element|Standard
346 Identifies whether this is a Character Style, a
347 Custom Inset or an XML Element, and which dynamical
348 sub-menu this flex inset is in on the LyX menu tree.
349 If Standard (currently unused): none of these.
350 Name: This name must be defined either in your layout file
351 or imported by some module. The definition is\n
352 InsetLayout <TYPE:Name>
353 * \li Sample: flex-insert CharStyle:Code
356 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
357 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
358 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
359 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
360 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
361 { LFUN_CLEARPAGE_INSERT, "clearpage-insert", Noop, Edit },
362 { LFUN_CLEARDOUBLEPAGE_INSERT, "cleardoublepage-insert", Noop, Edit },
363 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
364 { LFUN_APPENDIX, "appendix", Noop, Edit },
367 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
370 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
371 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
372 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
373 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
374 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
375 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
376 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
377 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
379 * \var lyx::FuncCode lyx::LFUN_SCROLL
380 * \li Action: Scroll the buffer view.
381 * \li Notion: Only scrolls the screen up or down; does not move the cursor.
382 * \li Syntax: scroll <TYPE> <QUANTITY>
383 * \li Params: <TYPE>: line|page\n
384 <QUANTITY>: up|down|<number>
385 * \li Origin: Abdelrazak Younes, Dec 27 2007
388 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
390 * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
391 * \li Action: Recenters the screen on the current cursor position.
392 * \li Syntax: screen-recenter
395 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
396 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
397 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
399 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
401 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
402 * \li Action: Moves the cursor one position logically backwards.
403 * \li Notion: This is not the action which should be bound to the arrow keys,
404 because backwards may be left or right, depending on the
405 language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
406 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
407 * \li Syntax: char-backward
410 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
412 * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
413 * \li Action: Moves the cursor one position logically backwards, adding
414 traversed position to the selection.
415 * \li Notion: See also #LFUN_CHAR_BACKWARD.
416 * \li Syntax: char-backward-select
419 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
420 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
421 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
423 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
424 * \li Action: Moves the cursor one position logically forward.
425 * \li Notion: This is not the action which should be bound to the arrow keys,
426 because forward may be left or right, depending on the language.
427 The arrow keys should be bound to #LFUN_CHAR_LEFT or
428 #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
429 * \li Syntax: char-forward
432 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
434 * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
435 * \li Action: Moves the cursor one position logically forward, adding
436 traversed position to the selection.
437 * \li Notion: See also #LFUN_CHAR_FORWARD.
438 * \li Syntax: char-forward-select
441 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
443 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
444 * \li Action: Moves the cursor one position "to the left".
445 * \li Notion: This is the action which should be taken when the "left" key
446 is pressed. Generally, it moves the cursor one position to the
447 left. However, in Bidi text this become slightly more
448 complicated, and there are different modes of cursor movement.
449 In "visual mode", this moves left, plain and simple. In "logical
450 mode", movement is logically forward in RTL paragraphs, and
451 logically backwards in LTR paragraphs.
452 * \li Syntax: char-left
455 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
457 * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
458 * \li Action: Moves the cursor one position "to the left", adding
459 traversed position to the selection.
460 * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
461 * \li Syntax: char-left-select
464 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
466 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
467 * \li Action: Moves the cursor one position "to the right".
468 * \li Notion: This is the action which should be taken when the "right" key
469 is pressed. Generally, it moves the cursor one position to the
470 right. However, in Bidi text this become slightly more
471 complicated, and there are different modes of cursor movement.
472 In "visual mode", this moves right, plain and simple. In "logical
473 mode", movement is logically forward in LTR paragraphs, and
474 logically backwards in RTL paragraphs.
475 * \li Syntax: char-right
478 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
480 * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
481 * \li Action: Moves the cursor one position "to the right", adding
482 traversed position to the selection.
483 * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
484 * \li Syntax: char-right-select
487 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
489 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
490 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
491 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
492 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
493 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
494 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
495 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
496 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
497 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
498 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
499 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
500 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
501 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
502 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
503 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
504 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
505 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
506 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
508 * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
509 * \li Action: Look up thesaurus entries with respect to the word under the cursor.
510 * \li Syntax: thesaurus-entry
511 * \li Origin: Levon, 20 Jul 2001
514 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
515 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
516 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
517 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
518 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
520 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
521 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
522 { LFUN_LINE_BREAK, "line-break", Noop, Edit },
523 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
524 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
525 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
526 { LFUN_NEW_LINE, "new-line", Noop, Edit },
529 * \var lyx::FuncCode lyx::LFUN_COPY
530 * \li Action: Copies to the clipboard the last edit.
534 { LFUN_COPY, "copy", ReadOnly, Edit },
536 * \var lyx::FuncCode lyx::LFUN_CUT
537 * \li Action: Cuts to the clipboard.
541 { LFUN_CUT, "cut", Noop, Edit },
543 * \var lyx::FuncCode lyx::LFUN_PASTE
544 * \li Action: Pastes from the active clipboard.
548 { LFUN_PASTE, "paste", Noop, Edit },
549 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
551 * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
552 * \li Action: Pastes the material currently selected.
553 * \li Syntax: primary-selection-paste
556 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
558 * \var lyx::FuncCode lyx::LFUN_UNDO
559 * \li Action: Undoes the last edit.
563 { LFUN_UNDO, "undo", Noop, Edit },
565 * \var lyx::FuncCode lyx::LFUN_REDO
566 * \li Action: Redoes the last thing undone.
570 { LFUN_REDO, "redo", Noop, Edit },
571 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
572 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
574 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
575 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
576 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
578 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
579 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
580 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
581 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
582 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
583 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
584 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
585 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
586 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
587 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
588 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
589 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
590 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
591 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
592 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
594 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
595 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
597 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
598 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
600 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
601 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
603 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
604 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
605 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
606 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
609 * \var lyx::FuncCode lyx::LFUN_LAYOUT
610 * \li Action: Sets the layout (that is, environment) for the current paragraph.
611 * \li Syntax: layout <LAYOUT>
612 * \li Params: <LAYOUT>: the layout to use
615 { LFUN_LAYOUT, "layout", Noop, Layout },
617 * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
618 * \li Action: Launches the paragraph settings dialog.
619 * \li Syntax: layout-paragraph
622 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
623 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
625 * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
626 * \li Action: Displays list of layout choices.
627 * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
628 dropbox allowing for choice of layout.
629 * \li Syntax: drop-layouts-choice
632 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
634 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
635 * \li Action: Clears the module list.
636 * \li Notion: Clears the list of included modules for the current buffer.
637 * \li Syntax: layout-modules-clear
638 * \li Origin: rgh, 25 August 2007
641 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
643 * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
644 * \li Action: Adds a module.
645 * \li Notion: Adds a module to the list of included modules for the current buffer.
646 * \li Syntax: layout-module-add <MODULE>
647 * \li Params: <MODULE>: the module to be added
648 * \li Origin: rgh, 25 August 2007
651 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
653 * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
654 * \li Action: Reloads layout information.
655 * \li Notion: Reloads all layout information for the current buffer from disk, thus
656 recognizing any changes that have been made to layout files on the fly.
657 This is intended to be used only by layout developers and should not be
658 used when one is trying to do actual work.
659 * \li Syntax: layout-reload
660 * \li Origin: rgh, 3 September 2007
663 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
665 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
666 * \li Action: Sets the text class for the current buffer.
667 * \li Syntax: textclass-apply <TEXTCLASS>
668 * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
669 the filename, minus the ".layout" extension.
672 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
674 * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
675 * \li Action: Loads information for a textclass from disk.
676 * \li Syntax: textclass-load <TEXTCLASS>
677 * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
678 the filename, minus the ".layout" extension.
681 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
684 * \var lyx::FuncCode lyx::LFUN_MARK_OFF
685 * \li Action: Disable selecting of text-region.
686 * \li Syntax: mark-off
689 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
691 * \var lyx::FuncCode lyx::LFUN_MARK_ON
692 * \li Action: Enable selecting of text-region.
693 * \li Notion: After enabling you can simply move arrow keys to get selected region.
694 * \li Syntax: mark-on
697 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
699 * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
700 * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
701 * \li Syntax: mark-toggle
702 * \li Origin: poenitz, May 5 2006
705 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
707 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
708 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
709 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
710 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
711 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
712 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
713 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
714 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
715 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
716 { LFUN_MATH_SPACE, "math-space", Noop, Math },
717 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
718 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
719 { LFUN_MATH_MODE, "math-mode", Noop, Math },
721 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
722 * \li Action: Toggles numbering of the current formula line.
723 * \li Notion: Must be in display formula mode.
724 * \li Syntax: math-number-line-toggle
725 * \li Origin: Alejandro 18 Jun 1996
728 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
730 * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
731 * \li Action: Toggles numbering/labeling of the current formula.
732 * \li Notion: Must be in display formula mode.
733 * \li Syntax: math-number-toggle
734 * \li Origin: Alejandro 4 Jun 1996
737 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
738 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
739 { LFUN_MATH_SIZE, "math-size", Noop, Math },
741 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
742 * \li Action: Unfold a Math Macro.
743 * \li Notion: Unfold the Math Macro the cursor is in, i.e.
745 * \li Syntax: math-macro-unfold
746 * \li Origin: sts, 06 January 2008
749 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
751 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
752 * \li Action: Fold a Math Macro.
753 * \li Notion: Fold the Math Macro the cursor is in if it was
754 unfolded, i.e. displayed as \foo before.
755 * \li Syntax: math-macro-fold
756 * \li Origin: sts, 06 January 2008
759 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
761 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
762 * \li Action: Add a parameter.
763 * \li Notion: Add a parameter to a Math Macro.
764 * \li Params: <NUM>: The number of the parameter behind which the new one
765 will be added (1 for the first, i.e. use 0 for add a
766 parameter at the left), defaults to the last one.
767 * \li Syntax: math-macro-add-param <NUM>
768 * \li Origin: sts, 06 January 2008
771 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
773 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
774 * \li Action: Remove the last parameter.
775 * \li Notion: Remove the last parameter of a Math Macro and
776 remove its value in all instances of the macro
778 * \li Params: <NUM>: The number of the parameter to be deleted (1 for
779 the first), defaults to the last one.
780 * \li Syntax: math-macro-remove-param <NUM>
781 * \li Origin: sts, 06 January 2008
784 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
786 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
787 * \li Action: Append a greedy parameter.
788 * \li Notion: Append a greedy parameter to a Math Macro which
789 eats the following mathed cell in every instance of
790 the macro in the buffer.
791 * \li Syntax: math-macro-append-greedy-param
792 * \li Origin: sts, 06 January 2008
795 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
797 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
798 * \li Action: Remove a greedy parameter.
799 * \li Notion: Remove a greedy parameter of a Math Macro and spit
800 out the values of it in every instance of the macro
801 in the buffer. If it is an optional parameter the [valud]
803 * \li Syntax: math-macro-remove-greedy-param
804 * \li Origin: sts, 06 January 2008
807 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
809 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
810 * \li Action: Make a parameter optional.
811 * \li Notion: Turn the first non-optional parameter of a Math Macro
812 into an optional parameter with a default value.
813 * \li Syntax: math-macro-make-optional
814 * \li Origin: sts, 06 January 2008
817 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
819 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
820 * \li Action: Make a parameter non-optional.
821 * \li Notion: Turn the last optional parameter of a Math Macro
822 into a non-optional parameter. The default value is
823 remembered to be reused later if the user changes his mind.
824 * \li Syntax: math-macro-make-nonoptional
825 * \li Origin: sts, 06 January 2008
828 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
830 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
831 * \li Action: Add an optional parameter.
832 * \li Notion: Insert an optional parameter just behind the
833 already existing optional parameters.
834 * \li Syntax: math-macro-add-optional-param
835 * \li Origin: sts, 06 January 2008
838 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
840 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
841 * \li Action: Remove the last optional parameter.
842 * \li Notion: Remove the last optional parameter of a Math Macro and
843 remove it in all the instances of the macro in the buffer.
844 * \li Syntax: math-macro-remove-optional-param
845 * \li Origin: sts, 06 January 2008
848 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
850 * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
851 * \li Action: Add a greedy optional parameter.
852 * \li Notion: Add a greedy optional parameter which eats the value
853 from the following cells in mathed which are in the [value]
855 * \li Syntax: math-macro-add-greedy-optional-param
856 * \li Origin: sts, 06 January 2008
859 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
861 * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
862 * \li Action: Only active in Math Macro definition.
863 * \li Notion: Dummy function which is only active in a Math Macro definition.
864 It's used to toggle the Math Macro toolbar if the cursor moves
865 into a Math Macro definition.
866 * \li Syntax: in-mathmacrotemplate
867 * \li Origin: sts, 06 January 2008
870 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
873 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
874 * \li Action: Moves the current paragraph downwards in the document.
875 * \li Syntax: paragraph-move-down
876 * \li Origin: Edwin, 8 Apr 2006
879 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
881 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
882 * \li Action: Moves the current paragraph upwards in the document.
883 * \li Syntax: paragraph-move-up
884 * \li Origin: Edwin, 8 Apr 2006
887 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
889 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
890 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
891 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
892 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
893 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
895 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
896 * \li Action: Jump to a paragraph given by its id number.
897 * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
898 seen on the screen. Moreover the id is unique for all opened buffers (documents).
899 * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
900 * \li Origin: Dekel, 26 Aug 2000
903 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
905 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
906 * \li Action: Breaks the current paragraph at the current location.
907 * \li Syntax: break-paragraph
910 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
912 * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
913 * \li Action: Breaks the current paragraph at the current location,
914 unless used at the beginning of a line, where it sets
915 the label width string to empty.
916 * \li Syntax: break-paragraph-skip
919 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
921 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
922 * \li Action: Change paragraph settings.
923 * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
924 This function only modifies, and does not override, existing settings.
925 Note that the "leftindent" indent setting is deprecated.
926 * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
927 * \li Params: <INDENT>: \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
928 <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
929 <ALIGN>: \\align block|left|right|center|default\n
930 <OTHERS>: \\labelwidthstring WIDTH|\\start_of_appendix\n
931 * \li Origin: rgh, Aug 15 2007
934 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
936 * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
937 * \li Action: Change paragraph settings.
938 * \li Notion: Overwrite all nonspecified settings to the default ones.
939 Use paragraph-params lfun if you don't want to overwrite others settings.
940 * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
941 * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
942 * \li Origin: leeming, 30 Mar 2004
945 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
946 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
949 * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
950 * \li Action: Move the current group in the upward direction in the
951 structure of the document.
952 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
953 the whole substructure of the group.
954 * \li Syntax: outline-up
955 * \li Origin: Vermeer, 23 Mar 2006
958 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
960 * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
961 * \li Action: Move the current group in the downward direction in the
962 structure of the document.
963 * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
964 the whole substructure of the group.
965 * \li Syntax: outline-down
966 * \li Origin: Vermeer, 23 Mar 2006
969 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
971 * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
972 * \li Action: Moves the current group in the downward direction in the
973 hierarchy of the document structure.
974 * \li Notion: Part -> Chapter -> Section -> etc.
975 * \li Syntax: outline-in
976 * \li Origin: Vermeer, 23 Mar 2006
979 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
981 * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
982 * \li Action: Moves the current group in the upward direction in the
983 hierarchy of the document structure.
984 * \li Notion: Part <- Chapter <- Section <- etc.
985 * \li Syntax: outline-out
986 * \li Origin: Vermeer, 23 Mar 2006
989 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
991 { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
992 { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
994 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
995 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
996 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
997 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
998 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1000 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1001 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1002 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1003 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1004 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1006 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1007 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1008 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1009 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1010 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1011 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1012 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1013 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1016 * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1017 * \li Action: Apply data for an inset.
1018 * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1019 be applied. This is either changed to #LFUN_INSET_MODIFY or
1020 #LFUN_INSET_INSERT depending on the context where it is called.
1021 * \li Syntax: inset-apply <ARGS>
1022 * \li Params: See #LFUN_INSET_INSERT .
1025 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1026 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1028 * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1029 * \li Action: Insert new inset (type given by the parameters).
1030 * \li Syntax: inset-insert <INSET> <ARGS>
1031 * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1032 hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1033 <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1035 * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1036 where <label name> is the name of the referenced label and
1037 <Format> is one of the following: \n
1038 ref -- <reference> \n
1039 eqref -- (<reference>) \n
1040 pageref -- <page> \n
1041 vpageref -- on <page> \n
1042 vref -- <reference> on <page> \n
1043 prettyref -- Formatted reference
1046 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1048 * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1049 * \li Action: Modify existing inset.
1050 * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1051 bibtex, ert, command, grahocs, note, vspace, tabular, bibitem,
1053 * \li Syntax: inset-modify <INSET> <ARGS>
1054 * \li Params: See #LFUN_INSET_INSERT for further details.
1057 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1058 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1059 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1060 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1061 { LFUN_INSET_TOGGLE, "", ReadOnly, Hidden },
1062 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1065 * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1066 * \li Action: Moves the cursor out of the current slice, going forward.
1067 * \li Notion: Cursor movement within an inset may be different than cursor
1068 movement in the surrounding text. This action should be called
1069 automatically by the cursor movement within the inset, when
1070 movement within the inset has ceased (reached the end of the
1071 last paragraph, for example), in order to move correctly
1072 back into the surrounding text.
1075 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1077 * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1078 * \li Action: Moves the cursor out of the current slice, going backwards.
1079 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1082 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1084 * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1085 * \li Action: Moves the cursor out of the current slice, going right.
1086 * \li Notion: See also #LFUN_FINISHED_FORWARD
1089 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1091 * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1092 * \li Action: Moves the cursor out of the current slice, going left.
1093 * \li Notion: See also #LFUN_FINISHED_FORWARD.
1096 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1098 { LFUN_LANGUAGE, "language", Noop, Edit },
1101 * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1102 * \li Action: Goto a label.
1103 * \li Syntax: label-goto [<LABEL>]
1104 * \li Params: <LABEL>: Requested label. If no label is given and refernce
1105 is on cursor position, Bookmark 0 is saved and
1106 cursor moves to the position of referenced label.
1107 * \li Origin: Ale, 6 Aug 1997
1110 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1111 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1113 * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1114 * \li Action: Go to the next label or cross-reference.
1115 * \li Syntax: reference-next
1116 * \li Origin: Dekel, 14 Jan 2001
1119 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1122 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1123 * \li Action: Goto a bookmark.
1124 * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1125 if necessary. Note that bookmarsk are saved per-session, not
1127 * \li Syntax: bookmark-goto <NUMBER>
1128 * \li Params: <NUMBER>: the number of the bookmark to restore.
1129 * \li Origin: Dekel, 27 January 2001
1132 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1134 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1135 * \li Action: Save a bookmark.
1136 * \li Notion: Saves a numbered bookmark to the sessions file. The number
1137 must be between 1 and 9, inclusive. Note that bookmarks are
1138 saved per-session, not per file.
1139 * \li Syntax: bookmark-save <NUMBER>
1140 * \li Params: <NUMBER>: the number of the bookmark to save.
1141 * \li Origin: Dekel, 27 January 2001
1144 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1146 * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1147 * \li Action: Clears the list of saved bookmarks.
1148 * \li Syntax: bookmark-clear
1149 * \li Origin: bpeng, 31 October 2006
1152 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1154 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1156 * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1157 * \li Action: Terminates the current LyX instance.
1158 * \li Notion: Terminates the current LyX instance, asking whether to save
1159 modified documents, etc.
1160 * \li Syntax: lyx-quit
1163 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1165 * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1166 * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1167 * \li Notion: Skiping "auto" when allowauto is false.
1168 * \li Syntax: toolbar-toggle <NAME> [allowauto]
1169 * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1170 minibuffer|review|view/update|math_panels
1171 * \li Origin: Edwin, 21 May 2007
1174 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1175 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1177 * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1178 * \li Action: Various UI visibility-toggling actions.
1179 * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1180 * \li Params: statusbar : Toggle visibility of the statusbar.\n
1181 menubar : Toggle visibility of the menubar.\n
1182 scrollbar : Toggle visibility of the scrollbar.\n
1183 frame : Toggle visibility of the frames around editing window.\n
1184 fullscreen : Toggle fullscreen mode. This also covers calling the
1185 previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1186 custom tweaks of the toolbars should be used.
1187 * \li Origin: ps, 9 Feb 2007
1190 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1192 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1193 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1196 * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1197 * \li Action: Creates another split view of current buffer.
1198 * \li Notion: All split views act in the same way indpendently.
1199 * \li Syntax: split-view <vertical|horizontal>
1200 * \li Params: horizontal : The work areas are laid out side by side.\n
1201 vertical : The work areas laid out vertically.\n
1202 * \li Origin: abdel, 20 Feb 2008
1205 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1208 * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1209 * \li Action: Close the current tab group.
1210 * \li Notion: This only closes the work areas, not the buffer themselves.
1211 The still opened buffers can be visualized in another tab group.
1212 * \li Syntax: close-tab-group
1213 * \li Origin: abdel, 21 Feb 2008
1216 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1217 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1218 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1219 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1220 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1221 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1222 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1224 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1225 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1226 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1227 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1228 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1230 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1231 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1232 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1233 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1235 { LFUN_MESSAGE, "message", NoBuffer, System },
1236 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1237 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1239 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1240 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1241 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1242 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1243 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1245 * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1246 * \li Action: Sets the cursor position based on the row number of generated TeX file.
1247 * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1248 * \li Origin: Edmar, 23 Dec 1998
1251 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1252 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1253 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1255 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1258 * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1259 * \li Action: Saves the current buffer to a temporary file.
1260 * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1261 is called automatically by LyX, to "autosave" the current buffer.
1262 * \li Syntax: buffer-auto-save
1265 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1266 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1267 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1268 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1269 { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
1271 * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1272 * \li Action: Closes the current buffer.
1273 * \li Notion: Closes the current buffer, asking whether to save it, etc,
1274 if the buffer has been modified.
1275 * \li Syntax: buffer-close
1278 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1280 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1281 * \li Action: Exports the current buffer (document) to the given format.
1282 * \li Syntax: buffer-export <FORMAT>
1283 * \li Params: <FORMAT> is either "custom" or one of the formats which you
1284 can find in Tools->Preferences->File formats->Format.
1285 Usual format you will enter is "pdf2" (pdflatex),
1286 "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1287 In case of "custom" you will be asked for a format you
1288 want to start from and for the command that you want to
1289 apply to this format. Internally the control is then passed
1290 to #LFUN_BUFFER_EXPORT_CUSTOM.
1291 * \li Origin: Lgb, 29 Jul 1997
1294 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1296 * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1297 * \li Action: Exports the current buffer (document) from the given format using
1298 the given command on it.
1299 * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1300 * \li Params: <FORMAT> format to start from (LyX will care to produce such
1301 intermediate file).\n
1302 <COMMAND> this command will be launched on the file. Note that you can
1303 use "$$FName" string to qualify the intermediate file.
1304 * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1305 * \li Origin: leeming, 27 Mar 2004
1308 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1310 * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1311 * \li Action: Prints the current document.
1312 * \li Notion: Many settings can be given via the preferences dialog.
1313 * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1314 * \li Params: <TARGET> is either "printer" or "file".\n
1315 <TARGER-NAME> is either "default" or file name or printer name.\n
1316 <COMMAND> command ensuring the printing job.
1317 * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1318 * \li Origin: leeming, 28 Mar 2004
1321 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1323 * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1324 * \li Action: Import a given file as a lyx document.
1325 * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1326 defined convertors in preferences. Look into File->Import menu to get
1327 an idea of the currently active import formats.
1328 * \li Syntax: buffer-import <FORMAT> [<FILE>]
1329 * \li Origin: Asger, 24 Jul 1998
1332 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1334 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1335 * \li Action: Creates a new buffer (that is, document).
1336 * \li Notion: Implicit path can be set in Preferences dialog.
1337 * \li Syntax: buffer-new [<FILE>]
1338 * \li Params: <FILE>: filename of created file with absolute path.
1341 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1343 * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1344 * \li Action: Creates a new buffer (that is, document) from a template.
1345 * \li Notion: Path for new files and templates can be set in Preferences dialog.
1346 Template will be asked for via Open-dialog.
1347 * \li Syntax: buffer-new-template [<FILE>]
1348 * \li Params: <FILE>: filename of created file with absolute path.
1351 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1353 * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1354 * \li Action: Reverts opened document.
1355 * \li Syntax: buffer-reload
1356 * \li Origin: Asger, 2 Feb 1997
1359 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1361 * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1362 * \li Action: Switch to the given buffer.
1363 * \li Notion: This is useful also in case you need simultaneously more views of the edited
1364 document in different LyX windows.
1365 * \li Syntax: buffer-new-template <BUFFER>
1366 * \li Params: <BUFFER>: already opened document which is to be shown.
1369 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1371 * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1372 * \li Action: Toggle editing mode of the current document between read/write and read-only.
1373 * \li Syntax: buffer-toggle-read-only
1374 * \li Origin: Lgb, 27 May 1997
1377 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1379 * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1380 * \li Action: Displays current buffer in chosen format.
1381 * \li Notion: Displays the contents of the current buffer in the chosen
1382 format, for example, PDF or DVI. This runs the necessary
1383 converter, calls the defined viewer, and so forth.
1384 * \li Syntax: buffer-view <FORMAT>
1385 * \li Params: <FORMAT>: The format to display, where this is one of the
1386 formats defined (in the current GUI) in the
1387 Tools>Preferences>File Formats dialog.
1390 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1392 * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1393 * \li Action: Exports the current document and put the result into the
1394 temporary directory.
1395 * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1396 the output will be rewriten - updated. This is useful in case your viewer
1397 is able to detect such changes (e.g. ghostview for postscript).
1398 * \li Syntax: buffer-update <FORMAT>
1399 * \li Params: <FORMAT>: The format to display, where this is one of the
1400 formats defined (in the current GUI) in the
1401 Tools>Preferences>File Formats dialog.
1402 * \li Origin: Dekel, 5 Aug 2000
1405 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1408 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1409 * \li Action: Saves the current buffer.
1410 * \li Notion: Saves the current buffer to disk, using the filename that
1411 is already associated with the buffer, asking for one if
1412 none is yet assigned.
1413 * \li Syntax: buffer-write
1416 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1418 * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1419 * \li Action: Rename and save current buffer.
1420 * \li Syntax: buffer-write-as <FILENAME>
1421 * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1422 is with respect to the original location of the buffer/file.
1425 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1426 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1427 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1428 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1429 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1430 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1431 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1432 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1433 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1436 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1437 * \li Action: Inserts another LyX file.
1438 * \li Syntax: file-insert [<FILE>]
1439 * \li Params: <FILE>: Filename to be inserted.
1442 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1444 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1445 * \li Action: Inserts plain text file.
1446 * \li Syntax: file-insert-plaintext [<FILE>]
1447 * \li Params: <FILE>: Filename to be inserted.
1448 * \li Origin: CFO-G, 19 Nov 1997
1451 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1453 * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1454 * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1455 * \li Syntax: file-insert-plaintext-para [<FILE>]
1456 * \li Params: <FILE>: Filename to be inserted.
1457 * \li Origin: Levon, 14 Feb 2001
1460 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1462 * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1463 * \li Action: Open LyX document.
1464 * \li Syntax: file-open [<FILE>]
1465 * \li Params: <FILE>: Filename to be opened.
1468 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1471 * \var lyx::FuncCode lyx::LFUN_CALL
1472 * \li Action: Executes a command defined in a .def file.
1473 * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1474 A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1475 where <NAME> is the name of the new command and <LFUN> is the lfun code
1476 to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1477 \\def_file "FileName" allows to include another .def file. \n
1478 This is particularly useful in connection with toolbar buttons:
1479 Since the name of the button image for this lfun is
1480 lib/images/commands/<NAME>.png this is the way to assign an image
1481 to a complex command-sequence.
1482 * \li Syntax: call <NAME>
1483 * \li Params: <NAME>: Name of the command that must be called.
1484 * \li Origin: broider, 2 Oct 2007
1487 { LFUN_CALL, "call", NoBuffer, System },
1489 * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1490 * \li Action: Simulate halting Meta key (Alt key on PCs).
1491 * \li Notion: Used for buffer editation not for GUI control.
1492 * \li Syntax: meta-prefix
1495 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1497 * \var lyx::FuncCode lyx::LFUN_CANCEL
1498 * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1499 * \li Syntax: cancel
1502 { LFUN_CANCEL, "cancel", NoBuffer, System },
1505 * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1506 * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1507 * \li Notion: Usually bound to M-x shortcut.
1508 * \li Syntax: command-execute
1511 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1512 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1514 * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1515 * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1516 * \li Syntax: command-sequence <CMDS>
1517 * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1518 * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1519 * \li Origin: Andre', 11 Nov 1999
1522 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1525 * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1526 * \li Action: Save user preferences.
1527 * \li Syntax: preferences-save
1528 * \li Origin: Lgb, 27 Nov 1999
1531 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1533 * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
1534 * \li Action: Reconfigure the automatic settings.
1535 * \li Syntax: reconfigure
1536 * \li Origin: Asger, 14 Feb 1997
1539 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1541 * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
1542 * \li Action: Apply the given settings to user preferences.
1543 * \li Syntax: lyxrc-apply <SETTINGS>
1544 * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1545 to get an idea which commands to use and their syntax.
1546 #lyx::LyXRC::LyXRCTags has the list of possible commands.
1549 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1551 * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1552 * \li Action: Determine whether keep cursor inside the editing window regardless
1553 the scrollbar movement.
1554 * \li Syntax: toggle-cursor-follows-scrollbar
1555 * \li Origin: ARRae, 2 Dec 1997
1558 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1560 * \var lyx::FuncCode lyx::LFUN_SET_COLOR
1561 * \li Action: Set the given LyX color to the color defined by the X11 name given.
1562 * \li Notion: A new color entry is created if the color is unknown.
1563 Color names can be stored as a part of user settings.
1564 * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1565 * \li Origin: SLior, 11 Jun 2000
1568 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1570 * \var lyx::FuncCode lyx::LFUN_STATISTICS
1571 * \li Action: Count the statistics (number of words and characters)
1572 in the document or in the given selection.
1573 * \li Notion: Note that this function gives the number of words/chars written,
1574 not the number of characters which will be typeset.
1575 * \li Syntax: statistics
1576 * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1579 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1581 * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1582 * \li Action: Show the inline completion at the cursor position.
1583 * \li Syntax: completion-inline
1584 * \li Origin: sts, Feb 19 2008
1587 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1589 * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1590 * \li Action: Show the completion popup at the cursor position.
1591 * \li Syntax: completion-popup
1592 * \li Origin: sts, Feb 19 2008
1595 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1597 * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
1598 * \li Action: Try to complete the word or command at the cursor position.
1599 * \li Syntax: completion-complete
1600 * \li Origin: sts, Feb 19 2008
1603 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1605 { LFUN_NOACTION, "", Noop, Hidden }
1606 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1609 for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1610 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1617 LyXAction::LyXAction()
1623 // Returns an action tag from a string.
1624 FuncRequest LyXAction::lookupFunc(string const & func) const
1626 string const func2 = trim(func);
1628 if (func2.empty()) {
1629 return FuncRequest(LFUN_NOACTION);
1633 string const arg = split(func2, cmd, ' ');
1635 func_map::const_iterator fit = lyx_func_map.find(cmd);
1637 return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1641 string const LyXAction::getActionName(FuncCode action) const
1643 info_map::const_iterator const it = lyx_info_map.find(action);
1644 return it != lyx_info_map.end() ? it->second.name : string();
1648 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
1650 info_map::const_iterator const it = lyx_info_map.find(action);
1651 return it != lyx_info_map.end() ? it->second.type : Hidden;
1655 bool LyXAction::funcHasFlag(FuncCode action,
1656 LyXAction::func_attrib flag) const
1658 info_map::const_iterator ici = lyx_info_map.find(action);
1660 if (ici == lyx_info_map.end()) {
1661 LYXERR0("action: " << action << " is not known.");
1662 BOOST_ASSERT(false);
1665 return ici->second.attrib & flag;
1669 LyXAction::const_func_iterator LyXAction::func_begin() const
1671 return lyx_func_map.begin();
1675 LyXAction::const_func_iterator LyXAction::func_end() const
1677 return lyx_func_map.end();