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