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