src/LyXAction.cpp

   1 /*!
   2  * \file LyXAction.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Jean-Marc Lasgouttes
   8  * \author John Levon
   9  * \author André Pönitz
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #include <config.h>
  15
  16 #include "LyXAction.h"
  17
  18 #include "FuncRequest.h"
  19
  20 #include "support/debug.h"
  21 #include "support/lstrings.h"
  22
  23 #include "support/assert.h"
  24
  25 using namespace std;
  26 using namespace lyx::support;
  27
  28 namespace lyx {
  29
  30 /*
  31      NAMING RULES FOR USER-COMMANDS
  32      Here's the set of rules to apply when a new command name is introduced:
  33
  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'.
  43
  44      (May 19 1996, 12:04, RvdK)
  45 */
  46
  47 /* LFUN documentation (a start at least, Chr 2007-08-12)
  48  *
  49  * The documentation below is primarily notes about restrictions and
  50  * oddities relating to the different LFUNs.
  51  *
  52  * Try to find an appropriate (thematical) place when adding the new LFUN.
  53  *
  54  * Doxygen template below. Some notes: Parameters should be set in uppercase
  55  * and put in <BRACKETS>, as so.
  56  */
  57
  58 /*!
  59  * \var lyx::FuncCode lyx::LFUN_
  60  * \li Action:
  61  * \li Notion:
  62  * \li Syntax:
  63  * \li Params:
  64  * \li Sample:
  65  * \li Origin:
  66  * \endvar
  67  */
  68
  69 LyXAction lyxaction;
  70
  71
  72 void LyXAction::newFunc(FuncCode action, string const & name,
  73                         unsigned int attrib, LyXAction::func_type type)
  74 {
  75         lyx_func_map[name] = action;
  76         FuncInfo tmpinfo;
  77         tmpinfo.name = name;
  78         tmpinfo.attrib = attrib;
  79         tmpinfo.type = type;
  80         lyx_info_map[action] = tmpinfo;
  81 }
  82
  83
  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()
  88 {
  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
  93         // magnitudes faster.
  94
  95         static bool init;
  96         if (init) return;
  97
  98         struct ev_item {
  99                 FuncCode action;
 100                 char const * name;
 101                 unsigned int attrib;
 102                 func_type type;
 103         };
 104
 105         ev_item const items[] = {
 106 #endif
 107 /*!
 108  * \var lyx::FuncCode lyx::LFUN_ACCENT_ACUTE
 109  * \li Action: Adds an acute accent \htmlonly (&aacute;)\endhtmlonly
 110                to the next character typed.
 111  * \li Syntax: accent-acute
 112  * \endvar
 113  */
 114                 { LFUN_ACCENT_ACUTE, "accent-acute", Noop, Edit },
 115 /*!
 116  * \var lyx::FuncCode lyx::LFUN_ACCENT_BREVE
 117  * \li Action: Adds a breve accent \htmlonly (&#259;)\endhtmlonly
 118                to the next character typed.
 119  * \li Syntax: accent-breve
 120  * \endvar
 121  */
 122                 { LFUN_ACCENT_BREVE, "accent-breve", Noop, Edit },
 123 /*!
 124  * \var lyx::FuncCode lyx::LFUN_ACCENT_CARON
 125  * \li Action: Adds a caron \htmlonly (&#462;)\endhtmlonly
 126                to the next character typed.
 127  * \li Syntax: accent-caron
 128  * \endvar
 129  */
 130                 { LFUN_ACCENT_CARON, "accent-caron", Noop, Edit },
 131 /*!
 132  * \var lyx::FuncCode lyx::LFUN_ACCENT_CEDILLA
 133  * \li Action: Adds a cedilla \htmlonly (&ccedil;)\endhtmlonly
 134                to the next character typed.
 135  * \li Syntax: accent-cedilla
 136  * \endvar
 137  */
 138                 { LFUN_ACCENT_CEDILLA, "accent-cedilla", Noop, Edit },
 139 /*!
 140  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCLE
 141  * \li Action: Adds a circle accent \htmlonly (&aring;)\endhtmlonly
 142                to the next character typed.
 143  * \li Syntax: accent-circle
 144  * \endvar
 145  */
 146                 { LFUN_ACCENT_CIRCLE, "accent-circle", Noop, Edit },
 147 /*!
 148  * \var lyx::FuncCode lyx::LFUN_ACCENT_CIRCUMFLEX
 149  * \li Action: Adds a circumflex \htmlonly (&ecirc;)\endhtmlonly
 150                to the next character typed.
 151  * \li Syntax: accent-circumflex
 152  * \endvar
 153  */
 154                 { LFUN_ACCENT_CIRCUMFLEX, "accent-circumflex", Noop, Edit },
 155 /*!
 156  * \var lyx::FuncCode lyx::LFUN_ACCENT_DOT
 157  * \li Action: Adds a dot accent \htmlonly (&#380;)\endhtmlonly
 158                to the next character typed.
 159  * \li Syntax: accent-dot
 160  * \endvar
 161  */
 162                 { LFUN_ACCENT_DOT, "accent-dot", Noop, Edit },
 163 /*!
 164  * \var lyx::FuncCode lyx::LFUN_ACCENT_GRAVE
 165  * \li Action: Adds a grave accent \htmlonly (&egrave;)\endhtmlonly
 166                to the next character typed.
 167  * \li Syntax: accent-grave
 168  * \endvar
 169  */
 170                 { LFUN_ACCENT_GRAVE, "accent-grave", Noop, Edit },
 171 /*!
 172  * \var lyx::FuncCode lyx::LFUN_ACCENT_HUNGARIAN_UMLAUT
 173  * \li Action: Adds a Hungarian umlaut \htmlonly (&#337;)\endhtmlonly
 174                to the next character typed.
 175  * \li Syntax: accent-grave
 176  * \endvar
 177  */
 178                 { LFUN_ACCENT_HUNGARIAN_UMLAUT, "accent-hungarian-umlaut", Noop, Edit },
 179 /*!
 180  * \var lyx::FuncCode lyx::LFUN_ACCENT_MACRON
 181  * \li Action: Adds a macron \htmlonly (&#257;)\endhtmlonly
 182                to the next character typed.
 183  * \li Syntax: accent-macron
 184  * \endvar
 185  */
 186                 { LFUN_ACCENT_MACRON, "accent-macron", Noop, Edit },
 187 /*!
 188  * \var lyx::FuncCode lyx::LFUN_ACCENT_OGONEK
 189  * \li Action: Adds an ogonek accent \htmlonly (&#261;)\endhtmlonly
 190                to the next character typed.
 191  * \li Syntax: accent-ogonek
 192  * \endvar
 193  */
 194                 { LFUN_ACCENT_OGONEK, "accent-ogonek", Noop, Edit },
 195                 { LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Edit },
 196 /*!
 197  * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
 198  * \li Action: Adds a tie \htmlonly (a&#865;)\endhtmlonly
 199                over the next two character typed.
 200  * \li Notion: the following char will finish the tie.
 201  * \li Syntax: accent-tie
 202  * \endvar
 203  */
 204                 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
 205 /*!
 206  * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
 207  * \li Action: Adds a tilde \htmlonly (&atilde;)\endhtmlonly
 208                over the next character typed.
 209  * \li Syntax: accent-tilde
 210  * \endvar
 211  */
 212                 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
 213 /*!
 214  * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
 215  * \li Action: Adds an umlaut \htmlonly (&auml;)\endhtmlonly
 216                over the next character typed.
 217  * \li Syntax: accent-umlaut
 218  * \endvar
 219  */
 220                 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
 221 /*!
 222  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
 223  * \li Action: Adds a bar \htmlonly (a&#800;)\endhtmlonly
 224                under the next character typed.
 225  * \li Syntax: accent-underbar
 226  * \endvar
 227  */
 228                 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
 229 /*!
 230  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
 231  * \li Action: Adds a dot \htmlonly (&#7841;)\endhtmlonly
 232                under the next character typed.
 233  * \li Syntax: accent-underdot
 234  * \endvar
 235  */
 236                 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
 237
 238 /*!
 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
 243  * \endvar
 244  */
 245                 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
 246 /*!
 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
 254  * \endvar
 255  */
 256                 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
 257 /*!
 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
 262  * \endvar
 263  */
 264                 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
 265 /*!
 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
 270  * \endvar
 271  */
 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 },
 276 /*!
 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
 281  * \endvar
 282  */
 283                 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
 284 /*!
 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
 289  * \endvar
 290  */
 291                 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
 292 /*!
 293  * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
 294  * \li Action: Inserts a new page.
 295  * \li Syntax: newpage-insert<ARG>
 296  * \li Params: <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
 297  * \li Origin: uwestoehr, 24 Nov 2007
 298  * \endvar
 299  */
 300                 { LFUN_NEWPAGE_INSERT, "newpage-insert", Noop, Edit },
 301 /*!
 302  * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
 303  * \li Action: Inserts a marginal note.
 304  * \li Syntax: marginalnote-insert
 305  * \li Origin: Lgb, 26 Jun 2000
 306  * \endvar
 307  */
 308                 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
 309 /*!
 310  * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
 311  * \li Action: Inserts a single unicode character.
 312  * \li Syntax: unicode-insert <CHAR>
 313  * \li Params: <CHAR>: The character to insert, given as its code
 314                        point, in hexadecimal, e.g.: unicode-insert 0x0100.
 315  * \li Origin: Lgb, 22 Oct 2006
 316  * \endvar
 317  */
 318                 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
 319 /*!
 320  * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
 321  * \li Action: Inserts a new listings inset.
 322  * \li Syntax: listing-insert
 323  * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
 324  * \endvar
 325  */
 326                 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
 327                 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
 328 /*!
 329  * \var lyx::FuncCode lyx::LFUN_INFO_INSERT
 330  * \li Action: Displays shortcuts, lyxrc, package and textclass availability and menu
 331                information in a non-editable boxed InsetText.
 332  * \li Notion: Apart from lfun arguments you can use the following method: \n
 333                1. input the type and argument of this inset, e.g. "menu paste", in
 334                the work area.\n
 335                2. select the text and run info-insert lfun.\n
 336  * \li Syntax: info-insert <TYPE> <ARG>
 337  * \li Params: <TYPE>: shortcut|lyxrc|package|textclass|menu|buffer \n
 338                <ARG>: argument for a given type. Look into InsetInfo.h for detailed
 339                       description.
 340  * \li Origin: bpeng, 7 Oct 2007
 341  * \endvar
 342  */
 343                 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
 344 /*!
 345  * \var lyx::FuncCode lyx::LFUN_BRANCH_INSERT
 346  * \li Action: Inserts branch inset.
 347  * \li Syntax: branch-insert <BRANCH-NAME>
 348  * \li Origin: vermeer, Aug 17 Aug 2003
 349  * \endvar
 350  */
 351                 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
 352                 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
 353 /*!
 354  * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
 355  * \li Action: Inserts CharStyle, Custom inset or XML short element.
 356  * \li Notion: Look into the Customization manual for more information about
 357                these elements.\n
 358                For dissolving the element see #LFUN_INSET_DISSOLVE.
 359  * \li Syntax: flex-insert <TYPE:Name>
 360  * \li Params: TYPE: CharStyle|Custom|Element|Standard
 361                      Identifies whether this is a Character Style, a
 362                      Custom Inset or an XML Element, and which dynamical
 363                      sub-menu this flex inset is in on the LyX menu tree.
 364                      If Standard (currently unused): none of these.
 365                Name: This name must be defined either in your layout file
 366                      or imported by some module. The definition is\n
 367                      InsetLayout <TYPE:Name>
 368  * \li Sample: flex-insert CharStyle:Code
 369  * \endvar
 370  */
 371                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
 372                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
 373 /*!
 374  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
 375  * \li Action: Inserts one of horizontal space insets.
 376  * \li Syntax: space-insert <NAME> [<LEN>]
 377  * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
 378                        negthinspace, hfill, hfill*, dotfill, hrulefill, hspace,
 379                        hspace* \n
 380                <LEN>: length for custom spaces (hspace, hspace* for protected)
 381  * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
 382  * \endvar
 383  */
 384                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
 385                 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
 386 /*!
 387  * \var lyx::FuncCode lyx::LFUN_SPECIALCHAR_INSERT
 388  * \li Action: Inserts various characters into the document.
 389  * \li Syntax: specialchar-insert <CHAR>
 390  * \li Params: <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots,
 391                        end-of-sentence, menu-separator.
 392  * \li Origin: JSpitzm, 6 Dec 2007
 393  * \endvar
 394  */
 395                 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
 396                 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
 397                 { LFUN_APPENDIX, "appendix", Noop, Edit },
 398
 399                 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
 400                 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
 401
 402                 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
 403                 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
 404
 405                 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
 406                 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
 407 /*!
 408  * \var lyx::FuncCode lyx::LFUN_NEWLINE_INSERT
 409  * \li Action: Inserts a line break or new line.
 410  * \li Syntax: newline-insert <ARG>
 411  * \li Params: <ARG>: <newline|linebreak> default: newline
 412  * \li Origin: JSpitzm, 25 Mar 2008
 413  * \endvar
 414  */
 415                 { LFUN_NEWLINE_INSERT, "newline-insert", Noop, Edit },
 416
 417
 418 #if 0
 419                 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
 420 #endif
 421
 422                 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
 423                 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
 424                 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
 425                 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
 426                 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
 427                 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
 428                 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
 429                 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
 430 /*!
 431  * \var lyx::FuncCode lyx::LFUN_SCROLL
 432  * \li Action: Scroll the buffer view.
 433  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
 434  * \li Syntax: scroll <TYPE> <QUANTITY>
 435  * \li Params: <TYPE>:  line|page\n
 436                <QUANTITY>: up|down|<number>
 437  * \li Origin: Abdelrazak Younes, Dec 27 2007
 438  * \endvar
 439  */
 440                 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
 441 /*!
 442  * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
 443  * \li Action: Recenters the screen on the current cursor position.
 444  * \li Syntax: screen-recenter
 445  * \endvar
 446  */
 447                 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
 448                 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
 449                 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
 450
 451                 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
 452 /*!
 453  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
 454  * \li Action: Moves the cursor one position logically backwards.
 455  * \li Notion: This is not the action which should be bound to the arrow keys,
 456                because backwards may be left or right, depending on the
 457                language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
 458                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
 459  * \li Syntax: char-backward
 460  * \endvar
 461  */
 462                 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
 463 /*!
 464  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
 465  * \li Action: Moves the cursor one position logically backwards, adding
 466                traversed position to the selection.
 467  * \li Notion: See also #LFUN_CHAR_BACKWARD.
 468  * \li Syntax: char-backward-select
 469  * \endvar
 470  */
 471                 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
 472                 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
 473                 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
 474 /*!
 475  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
 476  * \li Action: Moves the cursor one position logically forward.
 477  * \li Notion: This is not the action which should be bound to the arrow keys,
 478                because forward may be left or right, depending on the language.
 479                The arrow keys should be bound to #LFUN_CHAR_LEFT or
 480                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
 481  * \li Syntax: char-forward
 482  * \endvar
 483  */
 484                 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
 485 /*!
 486  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
 487  * \li Action: Moves the cursor one position logically forward, adding
 488                traversed position to the selection.
 489  * \li Notion: See also #LFUN_CHAR_FORWARD.
 490  * \li Syntax: char-forward-select
 491  * \endvar
 492  */
 493                 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
 494 /*!
 495  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
 496  * \li Action: Moves the cursor one position "to the left".
 497  * \li Notion: This is the action which should be taken when the "left" key
 498                is pressed. Generally, it moves the cursor one position to the
 499                left. However, in Bidi text this become slightly more
 500                complicated, and there are different modes of cursor movement.
 501                In "visual mode", this moves left, plain and simple. In "logical
 502                mode", movement is logically forward in RTL paragraphs, and
 503                logically backwards in LTR paragraphs.
 504  * \li Syntax: char-left
 505  * \endvar
 506  */
 507                 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
 508 /*!
 509  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
 510  * \li Action: Moves the cursor one position "to the left", adding
 511                traversed position to the selection.
 512  * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
 513  * \li Syntax: char-left-select
 514  * \endvar
 515  */
 516                 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
 517 /*!
 518  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
 519  * \li Action: Moves the cursor one position "to the right".
 520  * \li Notion: This is the action which should be taken when the "right" key
 521                is pressed. Generally, it moves the cursor one position to the
 522                right. However, in Bidi text this become slightly more
 523                complicated, and there are different modes of cursor movement.
 524                In "visual mode", this moves right, plain and simple. In "logical
 525                mode", movement is logically forward in LTR paragraphs, and
 526                logically backwards in RTL paragraphs.
 527  * \li Syntax: char-right
 528  * \endvar
 529  */
 530                 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
 531 /*!
 532  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
 533  * \li Action: Moves the cursor one position "to the right", adding
 534                traversed position to the selection.
 535  * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
 536  * \li Syntax: char-right-select
 537  * \endvar
 538  */
 539                 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
 540
 541                 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
 542                 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
 543                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
 544                 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
 545                 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
 546 /*!
 547  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_FORWARD
 548  * \li Action: Search for a given string in forward direction.
 549  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
 550  * \li Syntax: word-find-forward [<STRING>]
 551  * \li Origin: Etienne, 16 Feb 1998
 552  * \endvar
 553  */
 554                 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
 555 /*!
 556  * \var lyx::FuncCode lyx::LFUN_WORD_FIND_BACKWARD
 557  * \li Action: Search for a given string in backward direction.
 558  * \li Notion: Case sensitive, match words. If no argument given, last search repeated.
 559  * \li Syntax: word-find-backward [<STRING>]
 560  * \li Origin: Etienne, 20 Feb 1998
 561  * \endvar
 562  */
 563                 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
 564 /*!
 565  * \var lyx::FuncCode lyx::LFUN_WORD_FIND
 566  * \li Action: Search for next occurence of a string.
 567  * \li Syntax: word-find [<DATA>]
 568  * \li Params: <DATA>: data encoded from Find dialog (see #lyx::find2string()).
 569                        If no parameter is given, search with last find-dialog
 570                        data is used for search (i.e. find-next).
 571  * \li Origin: poenitz, Jan 7 2004
 572  * \endvar
 573  */
 574                 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
 575                 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
 576                 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
 577                 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
 578                 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
 579                 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
 580                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
 581                 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
 582                 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
 583                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
 584                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
 585 /*!
 586  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
 587  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
 588  * \li Syntax: thesaurus-entry
 589  * \li Origin: Levon, 20 Jul 2001
 590  * \endvar
 591  */
 592                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
 593                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
 594                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
 595                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
 596                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
 597
 598                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
 599                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
 600                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
 601                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
 602                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
 603 /*!
 604  * \var lyx::FuncCode lyx::LFUN_COPY
 605  * \li Action: Copies to the clipboard the last edit.
 606  * \li Syntax: copy
 607  * \endvar
 608  */
 609                 { LFUN_COPY, "copy", ReadOnly, Edit },
 610 /*!
 611  * \var lyx::FuncCode lyx::LFUN_CUT
 612  * \li Action: Cuts to the clipboard.
 613  * \li Syntax: cut
 614  * \endvar
 615  */
 616                 { LFUN_CUT, "cut", Noop, Edit },
 617 /*!
 618  * \var lyx::FuncCode lyx::LFUN_PASTE
 619  * \li Action: Pastes from the active clipboard.
 620  * \li Syntax: paste
 621  * \endvar
 622  */
 623                 { LFUN_PASTE, "paste", Noop, Edit },
 624                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
 625 /*!
 626  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
 627  * \li Action: Pastes the material currently selected.
 628  * \li Syntax: primary-selection-paste
 629  * \endvar
 630  */
 631                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
 632 /*!
 633  * \var lyx::FuncCode lyx::LFUN_UNDO
 634  * \li Action: Undoes the last edit.
 635  * \li Syntax: undo
 636  * \endvar
 637  */
 638                 { LFUN_UNDO, "undo", Noop, Edit },
 639 /*!
 640  * \var lyx::FuncCode lyx::LFUN_REDO
 641  * \li Action: Redoes the last thing undone.
 642  * \li Syntax: redo
 643  * \endvar
 644  */
 645                 { LFUN_REDO, "redo", Noop, Edit },
 646 /*!
 647  * \var lyx::FuncCode lyx::LFUN_REPEAT
 648  * \li Action: Repeat the given command.
 649  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
 650  * \li Author: poenitz, 27 Oct 2003
 651  * \endvar
 652  */
 653                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
 654                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
 655
 656                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
 657                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
 658                 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
 659
 660                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
 661                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
 662                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
 663                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
 664                 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
 665                 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
 666                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
 667                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
 668                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
 669                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
 670                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
 671                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
 672                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
 673                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
 674                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
 675
 676                 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
 677                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
 678                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
 679                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
 680
 681 /*!
 682  * \var lyx::FuncCode lyx::LFUN_LAYOUT
 683  * \li Action: Sets the layout (that is, environment) for the current paragraph.
 684  * \li Syntax: layout <LAYOUT>
 685  * \li Params: <LAYOUT>: the layout to use
 686  * \endvar
 687  */
 688                 { LFUN_LAYOUT, "layout", Noop, Layout },
 689 /*!
 690  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
 691  * \li Action: Launches the paragraph settings dialog.
 692  * \li Syntax: layout-paragraph
 693  * \endvar
 694  */
 695                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
 696                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
 697 /*!
 698  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
 699  * \li Action: Displays list of layout choices.
 700  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
 701                dropbox allowing for choice of layout.
 702  * \li Syntax: drop-layouts-choice
 703  * \endvar
 704  */
 705                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
 706 /*!
 707  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
 708  * \li Action: Clears the module list.
 709  * \li Notion: Clears the list of included modules for the current buffer.
 710  * \li Syntax: layout-modules-clear
 711  * \li Origin: rgh, 25 August 2007
 712  * \endvar
 713  */
 714                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
 715 /*!
 716  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
 717  * \li Action: Adds a module.
 718  * \li Notion: Adds a module to the list of included modules for the current buffer.
 719  * \li Syntax: layout-module-add <MODULE>
 720  * \li Params: <MODULE>: the module to be added
 721  * \li Origin: rgh, 25 August 2007
 722  * \endvar
 723  */
 724                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
 725 /*!
 726  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
 727  * \li Action: Reloads layout information.
 728  * \li Notion: Reloads all layout information for the current buffer from disk, thus
 729                recognizing any changes that have been made to layout files on the fly.
 730                This is intended to be used only by layout developers and should not be
 731                used when one is trying to do actual work.
 732  * \li Syntax: layout-reload
 733  * \li Origin: rgh, 3 September 2007
 734  * \endvar
 735  */
 736                 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
 737 /*!
 738  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
 739  * \li Action: Sets the text class for the current buffer.
 740  * \li Syntax: textclass-apply <TEXTCLASS>
 741  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
 742                    the filename, minus the ".layout" extension.
 743  * \endvar
 744  */
 745                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
 746 /*!
 747  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
 748  * \li Action: Loads information for a textclass from disk.
 749  * \li Syntax: textclass-load <TEXTCLASS>
 750  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
 751                    the filename, minus the ".layout" extension.
 752  * \endvar
 753  */
 754                 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
 755
 756 /*!
 757  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
 758  * \li Action: Disable selecting of text-region.
 759  * \li Syntax: mark-off
 760  * \endvar
 761  */
 762                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
 763 /*!
 764  * \var lyx::FuncCode lyx::LFUN_MARK_ON
 765  * \li Action: Enable selecting of text-region.
 766  * \li Notion: After enabling you can simply move arrow keys to get selected region.
 767  * \li Syntax: mark-on
 768  * \endvar
 769  */
 770                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
 771 /*!
 772  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
 773  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
 774  * \li Syntax: mark-toggle
 775  * \li Origin: poenitz, May 5 2006
 776  * \endvar
 777  */
 778                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
 779
 780                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
 781                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
 782                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
 783                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
 784                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
 785                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
 786                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
 787                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
 788                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
 789                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
 790                 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
 791                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
 792                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
 793 /*!
 794  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
 795  * \li Action: Toggles numbering of the current formula line.
 796  * \li Notion: Must be in display formula mode.
 797  * \li Syntax: math-number-line-toggle
 798  * \li Origin: Alejandro 18 Jun 1996
 799  * \endvar
 800  */
 801                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
 802 /*!
 803  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
 804  * \li Action: Toggles numbering/labeling of the current formula.
 805  * \li Notion: Must be in display formula mode.
 806  * \li Syntax: math-number-toggle
 807  * \li Origin: Alejandro 4 Jun 1996
 808  * \endvar
 809  */
 810                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
 811                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
 812                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
 813 /*!
 814  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
 815  * \li Action: Unfold a Math Macro.
 816  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
 817                display it as \foo.
 818  * \li Syntax: math-macro-unfold
 819  * \li Origin: sts, 06 January 2008
 820  * \endvar
 821  */
 822                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
 823 /*!
 824  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
 825  * \li Action: Fold a Math Macro.
 826  * \li Notion: Fold the Math Macro the cursor is in if it was
 827                unfolded, i.e. displayed as \foo before.
 828  * \li Syntax: math-macro-fold
 829  * \li Origin: sts, 06 January 2008
 830  * \endvar
 831  */
 832                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
 833 /*!
 834  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
 835  * \li Action: Add a parameter.
 836  * \li Notion: Add a parameter to a Math Macro.
 837  * \li Params: <NUM>: The number of the parameter behind which the new one
 838                will be added (1 for the first, i.e. use 0 for add a
 839                parameter at the left), defaults to the last one.
 840  * \li Syntax: math-macro-add-param <NUM>
 841  * \li Origin: sts, 06 January 2008
 842  * \endvar
 843  */
 844                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
 845 /*!
 846  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
 847  * \li Action: Remove the last parameter.
 848  * \li Notion: Remove the last parameter of a Math Macro and
 849                remove its value in all instances of the macro
 850                in the buffer.
 851  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
 852                the first), defaults to the last one.
 853  * \li Syntax: math-macro-remove-param <NUM>
 854  * \li Origin: sts, 06 January 2008
 855  * \endvar
 856  */
 857                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
 858 /*!
 859  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
 860  * \li Action: Append a greedy parameter.
 861  * \li Notion: Append a greedy parameter to a Math Macro which
 862                eats the following mathed cell in every instance of
 863                the macro in the buffer.
 864  * \li Syntax: math-macro-append-greedy-param
 865  * \li Origin: sts, 06 January 2008
 866  * \endvar
 867  */
 868                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
 869 /*!
 870  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
 871  * \li Action: Remove a greedy parameter.
 872  * \li Notion: Remove a greedy parameter of a Math Macro and spit
 873                out the values of it in every instance of the macro
 874                in the buffer. If it is an optional parameter the [valud]
 875                format is used.
 876  * \li Syntax: math-macro-remove-greedy-param
 877  * \li Origin: sts, 06 January 2008
 878  * \endvar
 879  */
 880                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
 881 /*!
 882  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
 883  * \li Action: Make a parameter optional.
 884  * \li Notion: Turn the first non-optional parameter of a Math Macro
 885                into an optional parameter with a default value.
 886  * \li Syntax: math-macro-make-optional
 887  * \li Origin: sts, 06 January 2008
 888  * \endvar
 889  */
 890                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
 891 /*!
 892  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
 893  * \li Action: Make a parameter non-optional.
 894  * \li Notion: Turn the last optional parameter of a Math Macro
 895                into a non-optional parameter. The default value is
 896                remembered to be reused later if the user changes his mind.
 897  * \li Syntax: math-macro-make-nonoptional
 898  * \li Origin: sts, 06 January 2008
 899  * \endvar
 900  */
 901                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
 902 /*!
 903  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
 904  * \li Action: Add an optional parameter.
 905  * \li Notion: Insert an optional parameter just behind the
 906                already existing optional parameters.
 907  * \li Syntax: math-macro-add-optional-param
 908  * \li Origin: sts, 06 January 2008
 909  * \endvar
 910  */
 911                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
 912 /*!
 913  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
 914  * \li Action: Remove the last optional parameter.
 915  * \li Notion: Remove the last optional parameter of a Math Macro and
 916                remove it in all the instances of the macro in the buffer.
 917  * \li Syntax: math-macro-remove-optional-param
 918  * \li Origin: sts, 06 January 2008
 919  * \endvar
 920  */
 921                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
 922 /*!
 923  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
 924  * \li Action: Add a greedy optional parameter.
 925  * \li Notion: Add a greedy optional parameter which eats the value
 926                from the following cells in mathed which are in the [value]
 927                format.
 928  * \li Syntax: math-macro-add-greedy-optional-param
 929  * \li Origin: sts, 06 January 2008
 930  * \endvar
 931  */
 932                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
 933 /*!
 934  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
 935  * \li Action: Only active in Math Macro definition.
 936  * \li Notion: Dummy function which is only active in a Math Macro definition.
 937                It's used to toggle the Math Macro toolbar if the cursor moves
 938                into a Math Macro definition.
 939  * \li Syntax: in-mathmacrotemplate
 940  * \li Origin: sts, 06 January 2008
 941  * \endvar
 942  */
 943                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
 944
 945 /*!
 946  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
 947  * \li Action: Moves the current paragraph downwards in the document.
 948  * \li Syntax: paragraph-move-down
 949  * \li Origin: Edwin, 8 Apr 2006
 950  * \endvar
 951  */
 952                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
 953 /*!
 954  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
 955  * \li Action: Moves the current paragraph upwards in the document.
 956  * \li Syntax: paragraph-move-up
 957  * \li Origin: Edwin, 8 Apr 2006
 958  * \endvar
 959  */
 960                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
 961
 962 /*!
 963  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
 964  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
 965                in upward direction.
 966  * \li Syntax: paragraph-up
 967  * \li Origin: Asger, 1 Oct 1996
 968  * \endvar
 969  */
 970                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
 971 /*!
 972  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
 973  * \li Action: Move the cursor and select the text to the next paragraph (or
 974                begining of the current one) in upward direction.
 975  * \li Syntax: paragraph-up-select
 976  * \li Origin: Asger, 1 Oct 1996
 977  * \endvar
 978  */
 979                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
 980 /*!
 981  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
 982  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
 983                in downward direction.
 984  * \li Syntax: paragraph-down
 985  * \li Origin: Asger, 1 Oct 1996
 986  * \endvar
 987  */
 988                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
 989 /*!
 990  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
 991  * \li Action: Move the cursor and select the text to the next paragraph (or
 992                begining of the current one) in downward direction.
 993  * \li Syntax: paragraph-down-select
 994  * \li Origin: Asger, 1 Oct 1996
 995  * \endvar
 996  */
 997                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
 998 /*!
 999  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1000  * \li Action: Jump to a paragraph given by its id number.
1001  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1002                seen on the screen. Moreover the id is unique for all opened buffers (documents).
1003  * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
1004  * \li Origin: Dekel, 26 Aug 2000
1005  * \endvar
1006  */
1007                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1008 /*!
1009  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1010  * \li Action: Breaks the current paragraph at the current location.
1011  * \li Syntax: break-paragraph
1012  * \endvar
1013  */
1014                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1015                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1016 /*!
1017  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
1018  * \li Action: Breaks the current paragraph at the current location,
1019                unless used at the beginning of a line, where it sets
1020                the label width string to empty.
1021  * \li Syntax: break-paragraph-skip
1022  * \endvar
1023  */
1024                 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
1025 /*!
1026  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1027  * \li Action: Change paragraph settings.
1028  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1029                This function only modifies, and does not override, existing settings.
1030                Note that the "leftindent" indent setting is deprecated.
1031  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1032  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1033                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1034                <ALIGN>:   \\align block|left|right|center|default\n
1035                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1036  * \li Origin: rgh, Aug 15 2007
1037  * \endvar
1038  */
1039                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1040 /*!
1041  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1042  * \li Action: Change paragraph settings.
1043  * \li Notion: Overwrite all nonspecified settings to the default ones.
1044                Use paragraph-params lfun if you don't want to overwrite others settings.
1045  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1046  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1047  * \li Origin: leeming, 30 Mar 2004
1048  * \endvar
1049  */
1050                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1051                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1052
1053 /*!
1054  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1055  * \li Action: Move the current group in the upward direction in the
1056                structure of the document.
1057  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1058                the whole substructure of the group.
1059  * \li Syntax: outline-up
1060  * \li Origin: Vermeer, 23 Mar 2006
1061  * \endvar
1062  */
1063                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1064 /*!
1065  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1066  * \li Action: Move the current group in the downward direction in the
1067                structure of the document.
1068  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1069                the whole substructure of the group.
1070  * \li Syntax: outline-down
1071  * \li Origin: Vermeer, 23 Mar 2006
1072  * \endvar
1073  */
1074                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1075 /*!
1076  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1077  * \li Action: Moves the current group in the downward direction in the
1078                hierarchy of the document structure.
1079  * \li Notion: Part -> Chapter -> Section -> etc.
1080  * \li Syntax: outline-in
1081  * \li Origin: Vermeer, 23 Mar 2006
1082  * \endvar
1083  */
1084                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1085 /*!
1086  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1087  * \li Action: Moves the current group in the upward direction in the
1088                hierarchy of the document structure.
1089  * \li Notion: Part <- Chapter <- Section <- etc.
1090  * \li Syntax: outline-out
1091  * \li Origin: Vermeer, 23 Mar 2006
1092  * \endvar
1093  */
1094                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1095 /*!
1096  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1097  * \li Action: Edit the inset at cursor with an external application,
1098  *             if one is attributed.
1099  * \li Syntax: inset-edit
1100  * \li Origin: JSpitzm, 27 Apr 2006
1101  * \endvar
1102  */
1103                 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1104
1105                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1106                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1107                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1108                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1109                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1110
1111                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1112                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1113                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1114                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1115                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1116
1117                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1118                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1119                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1120                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1121                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1122                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1123                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1124                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1125
1126 /*!
1127  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1128  * \li Action: Apply data for an inset.
1129  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1130                be applied. This is either changed to #LFUN_INSET_MODIFY or
1131                #LFUN_INSET_INSERT depending on the context where it is called.
1132  * \li Syntax: inset-apply <ARGS>
1133  * \li Params: See #LFUN_INSET_INSERT .
1134  * \endvar
1135  */
1136                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1137 /*!
1138  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1139  * \li Action: Dissolve the current inset into text.
1140  * \li Syntax: inset-dissolve [<INSET>]
1141  * \li Params: <INSET>: this can be used to make sure the right kind of inset
1142                         is dissolved. For example "dissolve" entry in the charstyles
1143                         sub-menu should only dissolve the charstyle inset, even if the
1144                         cursor is inside several nested insets of different type.\n
1145                         For values see #lyx::InsetLayout::lyxtype_ .
1146  * \li Author: JSpitz, 7 Aug 2006
1147  * \endvar
1148  */
1149                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1150 /*!
1151  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1152  * \li Action: Insert new inset (type given by the parameters).
1153  * \li Syntax: inset-insert <INSET> <ARGS>
1154  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1155                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1156                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1157                        explore.
1158  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1159                where <label name> is the name of the referenced label and
1160                <Format> is one of the following: \n
1161                ref -- <reference> \n
1162                eqref -- (<reference>) \n
1163                pageref -- <page> \n
1164                vpageref -- on <page> \n
1165                vref -- <reference> on <page> \n
1166                prettyref -- Formatted reference
1167  * \endvar
1168  */
1169                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1170 /*!
1171  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1172  * \li Action: Modify existing inset.
1173  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1174                bibtex, ert, command, graphics, note, space, vspace, tabular,
1175                bibitem, inlude, ref insets.
1176  * \li Syntax: inset-modify <INSET> <ARGS>
1177  * \li Params: See #LFUN_INSET_INSERT for further details.
1178  * \endvar
1179  */
1180                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1181 /*!
1182  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1183  * \li Action: Modify the inset at cursor position, if there is one.
1184  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1185                bibtex, ert, command, graphics, note, space, vspace, tabular,
1186                bibitem, inlude, ref insets.
1187  * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1188  * \li Params: See #LFUN_INSET_INSERT for further details.
1189  * \li Origin: JSpitzm, 23 Mar 2008
1190  * \endvar
1191  */
1192                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1193                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1194 /*!
1195  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1196  * \li Action: Open the inset's properties dialog.
1197  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1198  * \li Syntax: inset-settings <INSET>
1199  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1200  * \endvar
1201  */
1202                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1203 /*!
1204  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1205  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1206                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1207                be entered. Also cf. #LFUN_INSET_SETTINGS.
1208  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1209                bibtex, ert, command, graphics, note, space, vspace, tabular,
1210                bibitem, inlude, ref insets.
1211  * \li Syntax: next-inset-toggle <ARG>
1212  * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1213  * \li Origin: leeming, 30 Mar 2004
1214  * \endvar
1215  */
1216                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1217 /*!
1218  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1219  * \li Action: Toggles the collapsable inset we are currently in.
1220  * \li Syntax: inset-toggle [<ARG>]
1221  * \li Params: <ARG>: <open|close|toggle|assign>. \n
1222                open/close/toggle are for collapsable insets. close can be currently used
1223                by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1224                assign is for branch inset.
1225  * \li Origin: lasgouttes, 19 Jul 2001
1226  * \endvar
1227  */
1228                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1229 /*!
1230  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1231  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1232  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1233  * \li Syntax: all-insets-toggle <STATE> <INSET>
1234  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1235                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1236  * \li Origin: leeming, 30 Mar 2004
1237  * \endvar
1238  */
1239                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1240
1241 /*!
1242  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1243  * \li Action: Moves the cursor out of the current slice, going forward.
1244  * \li Notion: Cursor movement within an inset may be different than cursor
1245                movement in the surrounding text. This action should be called
1246                automatically by the cursor movement within the inset, when
1247                movement within the inset has ceased (reached the end of the
1248                last paragraph, for example), in order to move correctly
1249                back into the surrounding text.
1250  * \endvar
1251  */
1252                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1253 /*!
1254  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1255  * \li Action: Moves the cursor out of the current slice, going backwards.
1256  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1257  * \endvar
1258  */
1259                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1260 /*!
1261  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1262  * \li Action: Moves the cursor out of the current slice, going right.
1263  * \li Notion: See also #LFUN_FINISHED_FORWARD
1264  * \endvar
1265  */
1266                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1267 /*!
1268  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1269  * \li Action: Moves the cursor out of the current slice, going left.
1270  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1271  * \endvar
1272  */
1273                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1274
1275                 { LFUN_LANGUAGE, "language", Noop, Edit },
1276
1277 /*!
1278  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1279  * \li Action: Goto a label.
1280  * \li Syntax: label-goto [<LABEL>]
1281  * \li Params: <LABEL>: Requested label. If no label is given and refernce
1282                         is on cursor position, Bookmark 0 is saved and
1283                         cursor moves to the position of referenced label.
1284  * \li Origin: Ale, 6 Aug 1997
1285  * \endvar
1286  */
1287                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1288                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1289 /*!
1290  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1291  * \li Action: Go to the next label or cross-reference.
1292  * \li Syntax: reference-next
1293  * \li Origin: Dekel, 14 Jan 2001
1294  * \endvar
1295  */
1296                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1297
1298 /*!
1299  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1300  * \li Action: Goto a bookmark.
1301  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1302                if necessary. Note that bookmarsk are saved per-session, not
1303                per file.
1304  * \li Syntax: bookmark-goto <NUMBER>
1305  * \li Params: <NUMBER>: the number of the bookmark to restore.
1306  * \li Origin: Dekel, 27 January 2001
1307  * \endvar
1308  */
1309                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1310 /*!
1311  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1312  * \li Action: Save a bookmark.
1313  * \li Notion: Saves a numbered bookmark to the sessions file. The number
1314                must be between 1 and 9, inclusive. Note that bookmarks are
1315                saved per-session, not per file.
1316  * \li Syntax: bookmark-save <NUMBER>
1317  * \li Params: <NUMBER>: the number of the bookmark to save.
1318  * \li Origin: Dekel, 27 January 2001
1319  * \endvar
1320  */
1321                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1322 /*!
1323  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1324  * \li Action: Clears the list of saved bookmarks.
1325  * \li Syntax: bookmark-clear
1326  * \li Origin: bpeng, 31 October 2006
1327  * \endvar
1328  */
1329                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1330
1331 /*!
1332  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1333  * \li Action: Open the given help file according to the language setting.
1334  * \li Syntax: help-open <FILE>[.lyx]
1335  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1336  * \li Author: Jug, 27 Jun 1999
1337  * \endvar
1338  */
1339                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1340 /*!
1341  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1342  * \li Action: Terminates the current LyX instance.
1343  * \li Notion: Terminates the current LyX instance, asking whether to save
1344                modified documents, etc.
1345  * \li Syntax: lyx-quit
1346  * \endvar
1347  */
1348                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1349 /*!
1350  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1351  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1352  * \li Notion: Skiping "auto" when allowauto is false.
1353  * \li Syntax: toolbar-toggle <NAME> [allowauto]
1354  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1355                        minibuffer|review|view/update|math_panels
1356  * \li Origin: Edwin, 21 May 2007
1357  * \endvar
1358  */
1359                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1360 /*!
1361  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1362  * \li Action: Opens the menu given by its name.
1363  * \li Syntax: menu-open <NAME>
1364  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1365  * \endvar
1366  */
1367                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1368 /*!
1369  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1370  * \li Action: Various UI visibility-toggling actions.
1371  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1372  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
1373                menubar    : Toggle visibility of the menubar.\n
1374                scrollbar  : Toggle visibility of the scrollbar.\n
1375                frame      : Toggle visibility of the frames around editing window.\n
1376                fullscreen : Toggle fullscreen mode. This also covers calling the
1377                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1378                             custom tweaks of the toolbars should be used.
1379  * \li Origin: ps, 9 Feb 2007
1380  * \endvar
1381  */
1382                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1383
1384 /*!
1385  * \var lyx::FuncCode lyx::WINDOW_NEW
1386  * \li Action: Creates new empty LyX window.
1387  * \li Notion: Already opened documents from the previous window can be found under View menu.
1388  * \li Syntax: window-new [<GEOMETRY>]
1389  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1390                            accepted only on Windows platform.
1391  * \li Origin: Abdel, 21 Oct 2006
1392  * \endvar
1393  */
1394                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1395 /*!
1396  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1397  * \li Action: Closes the current LyX window.
1398  * \li Syntax: window-close
1399  * \li Origin: Abdel, 23 Oct 2006
1400  * \endvar
1401  */
1402                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1403
1404 /*!
1405  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1406  * \li Action: Creates another split view of current buffer.
1407  * \li Notion: All split views act in the same way indpendently.
1408  * \li Syntax: split-view <vertical|horizontal>
1409  * \li Params: horizontal : The work areas are laid out side by side.\n
1410                vertical   : The work areas laid out vertically.\n
1411  * \li Origin: abdel, 20 Feb 2008
1412  * \endvar
1413  */
1414                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1415
1416 /*!
1417  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1418  * \li Action: Close the current tab group.
1419  * \li Notion: This only closes the work areas, not the buffer themselves.
1420                The still opened buffers can be visualized in another tab group.
1421  * \li Syntax: close-tab-group
1422  * \li Origin: abdel, 21 Feb 2008
1423  * \endvar
1424  */
1425                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1426                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1427                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1428                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1429                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1430                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1431                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1432
1433                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1434                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1435                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1436                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1437                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1438
1439                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1440                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1441                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1442                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1443
1444                 { LFUN_MESSAGE, "message", NoBuffer, System },
1445                 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1446                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1447
1448                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1449                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1450                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1451 /*!
1452  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1453  * \li Action: Sets the cursor position based on the row number of generated TeX file.
1454  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1455  * \li Origin: Edmar, 23 Dec 1998
1456  * \endvar
1457  */
1458                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1459                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1460 /*!
1461  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1462  * \li Action: Sets the cursor position based on the editing area coordinates
1463                (similar as clicking on that point with left mouse button).
1464  * \li Syntax: server-set-xy <X> <Y>
1465  * \endvar
1466  */
1467                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1468 /*!
1469  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1470  * \li Action: Returns the coordinates of cursor position in the editing area.
1471  * \li Syntax: server-get-xy
1472  * \endvar
1473  */
1474                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1475
1476 /*!
1477  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1478  * \li Action: Generates the code (literate programming).
1479  * \li Notion: Latex file with extension \literate_extension is generated.
1480                Then LyX invokes \build_command (with a default of``make'') to generate the code and
1481                \build_error_filter to process the compilation error messages. \n
1482                In case you want to process your literate file with a script, or some other program,
1483                just insert in your lyxrc file an entry with:\n
1484                \build_command "my_script my_arguments" \n
1485                The \build_error_filter differs from the \literate_error_filter only in that the
1486                former will identify error messages from your compiler.
1487  * \li Syntax: build-program
1488  * \endvar
1489  */
1490                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1491
1492 /*!
1493  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1494  * \li Action: Saves the current buffer to a temporary file.
1495  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1496                is called automatically by LyX, to "autosave" the current buffer.
1497  * \li Syntax: buffer-auto-save
1498  * \endvar
1499  */
1500                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1501 /*!
1502  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1503  * \li Action: Loads the given child document.
1504  * \li Notion: The current document is treated as a parent.
1505  * \li Syntax: buffer-child-open <FILE>
1506  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1507  * \li Origin: Ale, 28 May 1997
1508  * \endvar
1509  */
1510                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1511 /*!
1512  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1513  * \li Action: Runs chktex for the current document.
1514  * \li Syntax: buffer-chktex
1515  * \li Origin: Asger, 30 Oct 1997
1516  * \endvar
1517  */
1518                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1519 /*!
1520  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1521  * \li Action: Toggles compression of the current document on/off.
1522  * \li Syntax: buffer-toggle-compression
1523  * \li Origin: bpeng, 27 Apr 2006
1524  * \endvar
1525  */
1526                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1527 /*!
1528  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1529  * \li Action: Closes the current buffer.
1530  * \li Notion: Closes the current buffer, asking whether to save it, etc,
1531                if the buffer has been modified.
1532  * \li Syntax: buffer-close
1533  * \endvar
1534  */
1535                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1536 /*!
1537  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1538  * \li Action: Exports the current buffer (document) to the given format.
1539  * \li Syntax: buffer-export <FORMAT>
1540  * \li Params: <FORMAT> is either "custom" or one of the formats which you
1541                         can find in Tools->Preferences->File formats->Format.
1542                         Usual format you will enter is "pdf2" (pdflatex),
1543                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1544                         In case of "custom" you will be asked for a format you
1545                         want to start from and for the command that you want to
1546                         apply to this format. Internally the control is then passed
1547                         to #LFUN_BUFFER_EXPORT_CUSTOM.
1548  * \li Origin: Lgb, 29 Jul 1997
1549  * \endvar
1550  */
1551                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1552 /*!
1553  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1554  * \li Action: Exports the current buffer (document) from the given format using
1555                the given command on it.
1556  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1557  * \li Params: <FORMAT> format to start from (LyX will care to produce such
1558                         intermediate file).\n
1559                <COMMAND> this command will be launched on the file. Note that you can
1560                use "$$FName" string to qualify the intermediate file.
1561  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1562  * \li Origin: leeming, 27 Mar 2004
1563  * \endvar
1564  */
1565                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1566 /*!
1567  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1568  * \li Action: Prints the current document.
1569  * \li Notion: Many settings can be given via the preferences dialog.
1570  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1571  * \li Params: <TARGET> is either "printer" or "file".\n
1572                <TARGER-NAME> is either "default" or file name or printer name.\n
1573                <COMMAND> command ensuring the printing job.
1574  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1575  * \li Origin: leeming, 28 Mar 2004
1576  * \endvar
1577  */
1578                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1579 /*!
1580  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1581  * \li Action: Import a given file as a lyx document.
1582  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1583                defined convertors in preferences. Look into File->Import menu to get
1584                an idea of the currently active import formats.
1585  * \li Syntax: buffer-import <FORMAT> [<FILE>]
1586  * \li Origin: Asger, 24 Jul 1998
1587  * \endvar
1588  */
1589                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1590 /*!
1591  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1592  * \li Action: Creates a new buffer (that is, document).
1593  * \li Notion: Implicit path can be set in Preferences dialog.
1594  * \li Syntax: buffer-new [<FILE>]
1595  * \li Params: <FILE>: filename of created file with absolute path.
1596  * \endvar
1597  */
1598                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1599 /*!
1600  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1601  * \li Action: Creates a new buffer (that is, document) from a template.
1602  * \li Notion: Path for new files and templates can be set in Preferences dialog.
1603                Template will be asked for via Open-dialog.
1604  * \li Syntax: buffer-new-template [<FILE>]
1605  * \li Params: <FILE>: filename of created file with absolute path.
1606  * \endvar
1607  */
1608                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1609 /*!
1610  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1611  * \li Action: Reverts opened document.
1612  * \li Syntax: buffer-reload
1613  * \li Origin: Asger, 2 Feb 1997
1614  * \endvar
1615  */
1616                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1617 /*!
1618  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1619  * \li Action: Switch to the given buffer.
1620  * \li Notion: This is useful also in case you need simultaneously more views of the edited
1621                document in different LyX windows.
1622  * \li Syntax: buffer-new-template <BUFFER>
1623  * \li Params: <BUFFER>: already opened document which is to be shown.
1624  * \endvar
1625  */
1626                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1627 /*!
1628  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1629  * \li Action: Toggle editing mode of the current document between read/write and read-only.
1630  * \li Syntax: buffer-toggle-read-only
1631  * \li Origin: Lgb, 27 May 1997
1632  * \endvar
1633  */
1634                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1635 /*!
1636  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1637  * \li Action: Displays current buffer in chosen format.
1638  * \li Notion: Displays the contents of the current buffer in the chosen
1639                format, for example, PDF or DVI. This runs the necessary
1640                converter, calls the defined viewer, and so forth.
1641  * \li Syntax: buffer-view <FORMAT>
1642  * \li Params: <FORMAT>: The format to display, where this is one of the
1643                          formats defined (in the current GUI) in the
1644                          Tools>Preferences>File Formats dialog.
1645  * \endvar
1646  */
1647                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1648 /*!
1649  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1650  * \li Action: Exports the current document and put the result into the
1651                temporary directory.
1652  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1653                the output will be rewriten - updated. This is useful in case your viewer
1654                is able to detect such changes (e.g. ghostview for postscript).
1655  * \li Syntax: buffer-update <FORMAT>
1656  * \li Params: <FORMAT>: The format to display, where this is one of the
1657                          formats defined (in the current GUI) in the
1658                          Tools>Preferences>File Formats dialog.
1659  * \li Origin: Dekel, 5 Aug 2000
1660  * \endvar
1661  */
1662                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1663
1664 /*!
1665  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1666  * \li Action: Saves the current buffer.
1667  * \li Notion: Saves the current buffer to disk, using the filename that
1668                is already associated with the buffer, asking for one if
1669                none is yet assigned.
1670  * \li Syntax: buffer-write
1671  * \endvar
1672  */
1673                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1674 /*!
1675  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1676  * \li Action: Rename and save current buffer.
1677  * \li Syntax: buffer-write-as <FILENAME>
1678  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1679                is with respect to the original location of the buffer/file.
1680  * \endvar
1681  */
1682                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1683 /*!
1684  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
1685  * \li Action: Save all changed documents.
1686  * \li Syntax: buffer-write-all
1687  * \li Origin: rgh, gpothier 6 Aug 2007
1688  * \endvar
1689  */
1690                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1691 /*!
1692  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
1693  * \li Action: Switch to the next opened document.
1694  * \li Notion: Note that this does not necessarily mean next in tabbar
1695                (for full list see View menu).
1696  * \li Syntax: buffer-next
1697  * \endvar
1698  */
1699                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1700 /*!
1701  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
1702  * \li Action: Switch to the previous opened document.
1703  * \li Syntax: buffer-previous
1704  * \endvar
1705  */
1706                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1707 /*!
1708  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
1709  * \li Action: When run from a child document, this updates (exports) document built
1710                 from the master buffer. If a master is not found, it updates the
1711                 current buffer.
1712  * \li Syntax: master-buffer-update
1713  * \li Author: Tommaso, 20 Sep 2007
1714  * \endvar
1715  */
1716                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1717 /*!
1718  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
1719  * \li Action: When run from a child document, this command shows a preview built
1720                from the master buffer. If a master is not found, it previews the
1721                current buffer.
1722  * \li Syntax: master-buffer-view
1723  * \li Author: Tommaso, 20 Sep 2007
1724  * \endvar
1725  */
1726                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1727 /*!
1728  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
1729  * \li Action: Set language of the current document.
1730  * \li Syntax: buffer-language <LANG>
1731  * \li Params: <LANG>: language name. See lib/languages for list.
1732  * \li Author: leeming, 30 Mar 2004
1733  * \endvar
1734  */
1735                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1736 /*!
1737  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
1738  * \li Action: Save the current document settings as default.
1739  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
1740  * \li Syntax: buffer-save-as-default [<ARGS>]
1741  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1742                        you can find in document header of usual .lyx file.
1743  * \li Author: leeming, 30 Mar 2004
1744  * \endvar
1745  */
1746                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1747 /*!
1748  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
1749  * \li Action: Apply the given settings to the current document.
1750  * \li Syntax: buffer-params-apply [<ARGS>]
1751  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
1752                        you can find in document header of usual .lyx file.
1753  * \li Author: leeming, 30 Mar 2004
1754  * \endvar
1755  */
1756                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1757
1758 /*!
1759  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1760  * \li Action: Inserts another LyX file.
1761  * \li Syntax: file-insert [<FILE>]
1762  * \li Params: <FILE>: Filename to be inserted.
1763  * \endvar
1764  */
1765                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1766 /*!
1767  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1768  * \li Action: Inserts plain text file.
1769  * \li Syntax: file-insert-plaintext [<FILE>]
1770  * \li Params: <FILE>: Filename to be inserted.
1771  * \li Origin: CFO-G, 19 Nov 1997
1772  * \endvar
1773  */
1774                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1775 /*!
1776  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1777  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1778  * \li Syntax: file-insert-plaintext-para [<FILE>]
1779  * \li Params: <FILE>: Filename to be inserted.
1780  * \li Origin: Levon, 14 Feb 2001
1781  * \endvar
1782  */
1783                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1784 /*!
1785  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1786  * \li Action: Open LyX document.
1787  * \li Syntax: file-open [<FILE>]
1788  * \li Params: <FILE>: Filename to be opened.
1789  * \endvar
1790  */
1791                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1792
1793 /*!
1794  * \var lyx::FuncCode lyx::LFUN_CALL
1795  * \li Action: Executes a command defined in a .def file.
1796  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1797                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1798                where <NAME> is the name of the new command and <LFUN> is the lfun code
1799                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1800                \\def_file "FileName" allows to include another .def file. \n
1801                This is particularly useful in connection with toolbar buttons:
1802                Since the name of the button image for this lfun is
1803                lib/images/commands/<NAME>.png this is the way to assign an image
1804                to a complex command-sequence.
1805  * \li Syntax: call <NAME>
1806  * \li Params: <NAME>: Name of the command that must be called.
1807  * \li Origin: broider, 2 Oct 2007
1808  * \endvar
1809  */
1810                 { LFUN_CALL, "call", NoBuffer, System },
1811 /*!
1812  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1813  * \li Action: Simulate halting Meta key (Alt key on PCs).
1814  * \li Notion: Used for buffer editation not for GUI control.
1815  * \li Syntax: meta-prefix
1816  * \endvar
1817  */
1818                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1819 /*!
1820  * \var lyx::FuncCode lyx::LFUN_CANCEL
1821  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1822  * \li Syntax: cancel
1823  * \endvar
1824  */
1825                 { LFUN_CANCEL, "cancel", NoBuffer, System },
1826
1827 /*!
1828  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1829  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1830  * \li Notion: Usually bound to M-x shortcut.
1831  * \li Syntax: command-execute
1832  * \endvar
1833  */
1834                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1835                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1836 /*!
1837  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1838  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1839  * \li Syntax: command-sequence <CMDS>
1840  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1841  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1842  * \li Origin: Andre', 11 Nov 1999
1843  * \endvar
1844  */
1845                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1846
1847 /*!
1848  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1849  * \li Action: Save user preferences.
1850  * \li Syntax: preferences-save
1851  * \li Origin: Lgb, 27 Nov 1999
1852  * \endvar
1853  */
1854                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1855 /*!
1856  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
1857  * \li Action: Reconfigure the automatic settings.
1858  * \li Syntax: reconfigure
1859  * \li Origin: Asger, 14 Feb 1997
1860  * \endvar
1861  */
1862                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1863 /*!
1864  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
1865  * \li Action: Apply the given settings to user preferences.
1866  * \li Syntax: lyxrc-apply <SETTINGS>
1867  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1868                            to get an idea which commands to use and their syntax.
1869                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
1870  * \endvar
1871  */
1872                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1873 /*!
1874  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1875  * \li Action: Determine whether keep cursor inside the editing window regardless
1876                the scrollbar movement.
1877  * \li Syntax: toggle-cursor-follows-scrollbar
1878  * \li Origin: ARRae, 2 Dec 1997
1879  * \endvar
1880  */
1881                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1882 /*!
1883  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
1884  * \li Action: Set the given LyX color to the color defined by the X11 name given.
1885  * \li Notion: A new color entry is created if the color is unknown.
1886                Color names can be stored as a part of user settings.
1887  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1888  * \li Origin: SLior, 11 Jun 2000
1889  * \endvar
1890  */
1891                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1892 /*!
1893  * \var lyx::FuncCode lyx::LFUN_STATISTICS
1894  * \li Action: Count the statistics (number of words and characters)
1895                in the document or in the given selection.
1896  * \li Notion: Note that this function gives the number of words/chars written,
1897                not the number of characters which will be typeset.
1898  * \li Syntax: statistics
1899  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1900  * \endvar
1901  */
1902                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1903 /*!
1904  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1905  * \li Action: Show the inline completion at the cursor position.
1906  * \li Syntax: completion-inline
1907  * \li Origin: sts, Feb 19 2008
1908  * \endvar
1909  */
1910                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1911 /*!
1912  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1913  * \li Action: Show the completion popup at the cursor position.
1914  * \li Syntax: completion-popup
1915  * \li Origin: sts, Feb 19 2008
1916  * \endvar
1917  */
1918                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1919 /*!
1920  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
1921  * \li Action: Try to complete the word or command at the cursor position.
1922  * \li Syntax: completion-complete
1923  * \li Origin: sts, Feb 19 2008
1924  * \endvar
1925  */
1926                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1927
1928                 { LFUN_NOACTION, "", Noop, Hidden }
1929 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1930         };
1931
1932         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1933                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1934         }
1935
1936         init = true;
1937 }
1938 #endif
1939
1940 LyXAction::LyXAction()
1941 {
1942         init();
1943 }
1944
1945
1946 // Returns an action tag from a string.
1947 FuncRequest LyXAction::lookupFunc(string const & func) const
1948 {
1949         string const func2 = trim(func);
1950
1951         if (func2.empty()) {
1952                 return FuncRequest(LFUN_NOACTION);
1953         }
1954
1955         string cmd;
1956         string const arg = split(func2, cmd, ' ');
1957
1958         func_map::const_iterator fit = lyx_func_map.find(cmd);
1959
1960         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1961 }
1962
1963
1964 string const LyXAction::getActionName(FuncCode action) const
1965 {
1966         info_map::const_iterator const it = lyx_info_map.find(action);
1967         return it != lyx_info_map.end() ? it->second.name : string();
1968 }
1969
1970
1971 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
1972 {
1973         info_map::const_iterator const it = lyx_info_map.find(action);
1974         return it != lyx_info_map.end() ? it->second.type : Hidden;
1975 }
1976
1977
1978 bool LyXAction::funcHasFlag(FuncCode action,
1979                             LyXAction::func_attrib flag) const
1980 {
1981         info_map::const_iterator ici = lyx_info_map.find(action);
1982
1983         if (ici == lyx_info_map.end()) {
1984                 LYXERR0("action: " << action << " is not known.");
1985                 LASSERT(false, /**/);
1986         }
1987
1988         return ici->second.attrib & flag;
1989 }
1990
1991
1992 LyXAction::const_func_iterator LyXAction::func_begin() const
1993 {
1994         return lyx_func_map.begin();
1995 }
1996
1997
1998 LyXAction::const_func_iterator LyXAction::func_end() const
1999 {
2000         return lyx_func_map.end();
2001 }
2002
2003
2004 } // namespace lyx