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 /*!
 836  * \var lyx::FuncCode lyx::LFUN_WORD_SELECT
 837  * \li Action: Puts the word where the cursor stands into the selection.
 838  * \li Syntax: word-select
 839  * \endvar
 840  */
 841                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
 842 /*!
 843  * \var lyx::FuncCode lyx::LFUN_WORD_CAPITALIZE
 844  * \li Action: Capitalizes the words in the selection (i.e. the first letters)
 845                or the letter on the cursor position.
 846  * \li Syntax: word-capitalize
 847  * \endvar
 848  */
 849                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
 850 /*!
 851  * \var lyx::FuncCode lyx::LFUN_WORD_UPCASE
 852  * \li Action: Change the words in the selection or from the cursor position
 853                to the end of word to the upper case.
 854  * \li Syntax: word-upcase
 855  * \endvar
 856  */
 857                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
 858 /*!
 859  * \var lyx::FuncCode lyx::LFUN_WORD_LOWCASE
 860  * \li Action: Change the words in the selection or from the cursor position
 861                to the end of word to the lower case.
 862  * \li Syntax: word-lowcase
 863  * \endvar
 864  */
 865                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
 866 /*!
 867  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
 868  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
 869  * \li Syntax: thesaurus-entry
 870  * \li Origin: Levon, 20 Jul 2001
 871  * \endvar
 872  */
 873                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
 874                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
 875                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
 876                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
 877                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
 878
 879                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
 880                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
 881                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
 882                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
 883                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
 884 /*!
 885  * \var lyx::FuncCode lyx::LFUN_COPY
 886  * \li Action: Copies to the clipboard the last edit.
 887  * \li Syntax: copy
 888  * \endvar
 889  */
 890                 { LFUN_COPY, "copy", ReadOnly, Edit },
 891 /*!
 892  * \var lyx::FuncCode lyx::LFUN_CUT
 893  * \li Action: Cuts to the clipboard.
 894  * \li Syntax: cut
 895  * \endvar
 896  */
 897                 { LFUN_CUT, "cut", Noop, Edit },
 898 /*!
 899  * \var lyx::FuncCode lyx::LFUN_PASTE
 900  * \li Action: Pastes from the active clipboard.
 901  * \li Syntax: paste
 902  * \endvar
 903  */
 904                 { LFUN_PASTE, "paste", Noop, Edit },
 905                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
 906 /*!
 907  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
 908  * \li Action: Pastes the material currently selected.
 909  * \li Syntax: primary-selection-paste
 910  * \endvar
 911  */
 912                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
 913 /*!
 914  * \var lyx::FuncCode lyx::LFUN_UNDO
 915  * \li Action: Undoes the last edit.
 916  * \li Syntax: undo
 917  * \endvar
 918  */
 919                 { LFUN_UNDO, "undo", Noop, Edit },
 920 /*!
 921  * \var lyx::FuncCode lyx::LFUN_REDO
 922  * \li Action: Redoes the last thing undone.
 923  * \li Syntax: redo
 924  * \endvar
 925  */
 926                 { LFUN_REDO, "redo", Noop, Edit },
 927 /*!
 928  * \var lyx::FuncCode lyx::LFUN_REPEAT
 929  * \li Action: Repeat the given command.
 930  * \li Syntax: repeat <COUNT> <LFUN-COMMAND>
 931  * \li Author: poenitz, 27 Oct 2003
 932  * \endvar
 933  */
 934                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
 935 /*!
 936  * \var lyx::FuncCode lyx::LFUN_CHARS_TRANSPOSE
 937  * \li Action: Transposes the character at the cursor with the one before it.
 938  * \li Syntax: chars-transpose
 939  * \li Author: Lgb, 25 Apr 2001
 940  * \endvar
 941  */
 942                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
 943
 944                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
 945                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
 946                 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
 947
 948 /*!
 949  * \var lyx::FuncCode lyx::LFUN_FONT_BOLD
 950  * \li Action: Toggles the bold font (selection-wise).
 951  * \li Syntax: font-bold
 952  * \endvar
 953  */
 954                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
 955 /*!
 956  * \var lyx::FuncCode lyx::LFUN_FONT_TYPEWRITER
 957  * \li Action: Toggles the typewriter family font (selection-wise).
 958  * \li Syntax: font-typewriter
 959  * \endvar
 960  */
 961                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
 962 /*!
 963  * \var lyx::FuncCode lyx::LFUN_FONT_UNDERLINE
 964  * \li Action: Toggles underline in the font (selection-wise).
 965  * \li Syntax: font-underline
 966  * \endvar
 967  */
 968                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
 969 /*!
 970  * \var lyx::FuncCode lyx::LFUN_FONT_EMPH
 971  * \li Action: Toggles the emphasis font style (selection-wise).
 972  * \li Syntax: font-emph
 973  * \endvar
 974  */
 975                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
 976 /*!
 977  * \var lyx::FuncCode lyx::LFUN_FONT_NOUN
 978  * \li Action: Toggles Noun text style font (selection-wise).
 979  * \li Syntax: font-noun
 980  * \endvar
 981  */
 982                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
 983 /*!
 984  * \var lyx::FuncCode lyx::LFUN_FONT_ROMAN
 985  * \li Action: Toggles Roman family font (selection-wise).
 986  * \li Syntax: font-roman
 987  * \endvar
 988  */
 989                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
 990 /*!
 991  * \var lyx::FuncCode lyx::LFUN_FONT_SANS
 992  * \li Action: Toggles Sans Serif family font (selection-wise).
 993  * \li Syntax: font-sans
 994  * \endvar
 995  */
 996                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
 997 /*!
 998  * \var lyx::FuncCode lyx::LFUN_FONT_FRAK
 999  * \li Action: Toggles Fraktur family font (math-mode, selection-wise).
1000  * \li Syntax: font-frak
1001  * \li Origin: vermeer, 10 Jan 2002
1002  * \endvar
1003  */
1004                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
1005 /*!
1006  * \var lyx::FuncCode lyx::LFUN_FONT_ITAL
1007  * \li Action: Toggles Italics font shape (math-mode, selection-wise).
1008  * \li Syntax: font-ital
1009  * \li Origin: vermeer, 10 Jan 2002
1010  * \endvar
1011  */
1012                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
1013 /*!
1014  * \var lyx::FuncCode lyx::LFUN_FONT_DEFAULT
1015  * \li Action: Reverts the settings of the font to the default values (selection-wise).
1016  * \li Syntax: font-default
1017  * \endvar
1018  */
1019                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
1020                 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
1021                 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
1022                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
1023                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
1024 /*!
1025  * \var lyx::FuncCode lyx::LFUN_FONT_STATE
1026  * \li Action: Returns the info about the current font.
1027  * \li Syntax: font-state
1028  * \endvar
1029  */
1030                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
1031
1032                 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
1033                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
1034                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
1035                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
1036
1037 /*!
1038  * \var lyx::FuncCode lyx::LFUN_LAYOUT
1039  * \li Action: Sets the layout (that is, environment) for the current paragraph.
1040  * \li Syntax: layout <LAYOUT>
1041  * \li Params: <LAYOUT>: the layout to use
1042  * \endvar
1043  */
1044                 { LFUN_LAYOUT, "layout", Noop, Layout },
1045 /*!
1046  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
1047  * \li Action: Launches the paragraph settings dialog.
1048  * \li Syntax: layout-paragraph
1049  * \endvar
1050  */
1051                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
1052 /*!
1053  * \var lyx::FuncCode lyx::LFUN_LAYOUT_TABULAR
1054  * \li Action: Launches the tabular settings dialog.
1055  * \li Syntax: layout-tabular
1056  * \li Origin: Jug, 31 Jul 2000
1057  * \endvar
1058  */
1059                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
1060 /*!
1061  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
1062  * \li Action: Displays list of layout choices.
1063  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
1064                dropbox allowing for choice of layout.
1065  * \li Syntax: drop-layouts-choice
1066  * \endvar
1067  */
1068                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
1069 /*!
1070  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
1071  * \li Action: Clears the module list.
1072  * \li Notion: Clears the list of included modules for the current buffer.
1073  * \li Syntax: layout-modules-clear
1074  * \li Origin: rgh, 25 August 2007
1075  * \endvar
1076  */
1077                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
1078 /*!
1079  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
1080  * \li Action: Adds a module.
1081  * \li Notion: Adds a module to the list of included modules for the current buffer.
1082  * \li Syntax: layout-module-add <MODULE>
1083  * \li Params: <MODULE>: the module to be added
1084  * \li Origin: rgh, 25 August 2007
1085  * \endvar
1086  */
1087                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
1088 /*!
1089  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
1090  * \li Action: Reloads layout information.
1091  * \li Notion: Reloads all layout information for the current buffer from disk, thus
1092                recognizing any changes that have been made to layout files on the fly.
1093                This is intended to be used only by layout developers and should not be
1094                used when one is trying to do actual work.
1095  * \li Syntax: layout-reload
1096  * \li Origin: rgh, 3 September 2007
1097  * \endvar
1098  */
1099                 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
1100 /*!
1101  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
1102  * \li Action: Sets the text class for the current buffer.
1103  * \li Syntax: textclass-apply <TEXTCLASS>
1104  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
1105                    the filename, minus the ".layout" extension.
1106  * \endvar
1107  */
1108                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
1109 /*!
1110  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
1111  * \li Action: Loads information for a textclass from disk.
1112  * \li Syntax: textclass-load <TEXTCLASS>
1113  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
1114                    the filename, minus the ".layout" extension.
1115  * \endvar
1116  */
1117                 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
1118
1119 /*!
1120  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
1121  * \li Action: Disable selecting of text-region.
1122  * \li Syntax: mark-off
1123  * \endvar
1124  */
1125                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
1126 /*!
1127  * \var lyx::FuncCode lyx::LFUN_MARK_ON
1128  * \li Action: Enable selecting of text-region.
1129  * \li Notion: After enabling you can simply move arrow keys to get selected region.
1130  * \li Syntax: mark-on
1131  * \endvar
1132  */
1133                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
1134 /*!
1135  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
1136  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
1137  * \li Syntax: mark-toggle
1138  * \li Origin: poenitz, May 5 2006
1139  * \endvar
1140  */
1141                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
1142
1143                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
1144                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
1145                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
1146                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
1147                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
1148                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
1149                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
1150                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
1151                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
1152                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
1153                 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
1154                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
1155                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
1156 /*!
1157  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
1158  * \li Action: Toggles numbering of the current formula line.
1159  * \li Notion: Must be in display formula mode.
1160  * \li Syntax: math-number-line-toggle
1161  * \li Origin: Alejandro 18 Jun 1996
1162  * \endvar
1163  */
1164                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
1165 /*!
1166  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
1167  * \li Action: Toggles numbering/labeling of the current formula.
1168  * \li Notion: Must be in display formula mode.
1169  * \li Syntax: math-number-toggle
1170  * \li Origin: Alejandro 4 Jun 1996
1171  * \endvar
1172  */
1173                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
1174                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
1175                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
1176 /*!
1177  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
1178  * \li Action: Unfold a Math Macro.
1179  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
1180                display it as \foo.
1181  * \li Syntax: math-macro-unfold
1182  * \li Origin: sts, 06 January 2008
1183  * \endvar
1184  */
1185                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
1186 /*!
1187  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
1188  * \li Action: Fold a Math Macro.
1189  * \li Notion: Fold the Math Macro the cursor is in if it was
1190                unfolded, i.e. displayed as \foo before.
1191  * \li Syntax: math-macro-fold
1192  * \li Origin: sts, 06 January 2008
1193  * \endvar
1194  */
1195                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
1196 /*!
1197  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
1198  * \li Action: Add a parameter.
1199  * \li Notion: Add a parameter to a Math Macro.
1200  * \li Params: <NUM>: The number of the parameter behind which the new one
1201                will be added (1 for the first, i.e. use 0 for add a
1202                parameter at the left), defaults to the last one.
1203  * \li Syntax: math-macro-add-param <NUM>
1204  * \li Origin: sts, 06 January 2008
1205  * \endvar
1206  */
1207                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
1208 /*!
1209  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
1210  * \li Action: Remove the last parameter.
1211  * \li Notion: Remove the last parameter of a Math Macro and
1212                remove its value in all instances of the macro
1213                in the buffer.
1214  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
1215                the first), defaults to the last one.
1216  * \li Syntax: math-macro-remove-param <NUM>
1217  * \li Origin: sts, 06 January 2008
1218  * \endvar
1219  */
1220                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
1221 /*!
1222  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
1223  * \li Action: Append a greedy parameter.
1224  * \li Notion: Append a greedy parameter to a Math Macro which
1225                eats the following mathed cell in every instance of
1226                the macro in the buffer.
1227  * \li Syntax: math-macro-append-greedy-param
1228  * \li Origin: sts, 06 January 2008
1229  * \endvar
1230  */
1231                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
1232 /*!
1233  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
1234  * \li Action: Remove a greedy parameter.
1235  * \li Notion: Remove a greedy parameter of a Math Macro and spit
1236                out the values of it in every instance of the macro
1237                in the buffer. If it is an optional parameter the [valud]
1238                format is used.
1239  * \li Syntax: math-macro-remove-greedy-param
1240  * \li Origin: sts, 06 January 2008
1241  * \endvar
1242  */
1243                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
1244 /*!
1245  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
1246  * \li Action: Make a parameter optional.
1247  * \li Notion: Turn the first non-optional parameter of a Math Macro
1248                into an optional parameter with a default value.
1249  * \li Syntax: math-macro-make-optional
1250  * \li Origin: sts, 06 January 2008
1251  * \endvar
1252  */
1253                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
1254 /*!
1255  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
1256  * \li Action: Make a parameter non-optional.
1257  * \li Notion: Turn the last optional parameter of a Math Macro
1258                into a non-optional parameter. The default value is
1259                remembered to be reused later if the user changes his mind.
1260  * \li Syntax: math-macro-make-nonoptional
1261  * \li Origin: sts, 06 January 2008
1262  * \endvar
1263  */
1264                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
1265 /*!
1266  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
1267  * \li Action: Add an optional parameter.
1268  * \li Notion: Insert an optional parameter just behind the
1269                already existing optional parameters.
1270  * \li Syntax: math-macro-add-optional-param
1271  * \li Origin: sts, 06 January 2008
1272  * \endvar
1273  */
1274                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
1275 /*!
1276  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
1277  * \li Action: Remove the last optional parameter.
1278  * \li Notion: Remove the last optional parameter of a Math Macro and
1279                remove it in all the instances of the macro in the buffer.
1280  * \li Syntax: math-macro-remove-optional-param
1281  * \li Origin: sts, 06 January 2008
1282  * \endvar
1283  */
1284                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
1285 /*!
1286  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
1287  * \li Action: Add a greedy optional parameter.
1288  * \li Notion: Add a greedy optional parameter which eats the value
1289                from the following cells in mathed which are in the [value]
1290                format.
1291  * \li Syntax: math-macro-add-greedy-optional-param
1292  * \li Origin: sts, 06 January 2008
1293  * \endvar
1294  */
1295                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
1296 /*!
1297  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
1298  * \li Action: Only active in Math Macro definition.
1299  * \li Notion: Dummy function which is only active in a Math Macro definition.
1300                It's used to toggle the Math Macro toolbar if the cursor moves
1301                into a Math Macro definition.
1302  * \li Syntax: in-mathmacrotemplate
1303  * \li Origin: sts, 06 January 2008
1304  * \endvar
1305  */
1306                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
1307
1308 /*!
1309  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
1310  * \li Action: Moves the current paragraph downwards in the document.
1311  * \li Syntax: paragraph-move-down
1312  * \li Origin: Edwin, 8 Apr 2006
1313  * \endvar
1314  */
1315                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
1316 /*!
1317  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
1318  * \li Action: Moves the current paragraph upwards in the document.
1319  * \li Syntax: paragraph-move-up
1320  * \li Origin: Edwin, 8 Apr 2006
1321  * \endvar
1322  */
1323                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
1324
1325 /*!
1326  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP
1327  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1328                in upward direction.
1329  * \li Syntax: paragraph-up
1330  * \li Origin: Asger, 1 Oct 1996
1331  * \endvar
1332  */
1333                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
1334 /*!
1335  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_UP_SELECT
1336  * \li Action: Move the cursor and select the text to the next paragraph (or
1337                begining of the current one) in upward direction.
1338  * \li Syntax: paragraph-up-select
1339  * \li Origin: Asger, 1 Oct 1996
1340  * \endvar
1341  */
1342                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
1343 /*!
1344  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN
1345  * \li Action: Move the cursor to the next paragraph (or begining of the current one)
1346                in downward direction.
1347  * \li Syntax: paragraph-down
1348  * \li Origin: Asger, 1 Oct 1996
1349  * \endvar
1350  */
1351                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
1352 /*!
1353  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_DOWN_SELECT
1354  * \li Action: Move the cursor and select the text to the next paragraph (or
1355                begining of the current one) in downward direction.
1356  * \li Syntax: paragraph-down-select
1357  * \li Origin: Asger, 1 Oct 1996
1358  * \endvar
1359  */
1360                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
1361 /*!
1362  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
1363  * \li Action: Jump to a paragraph given by its id number and optionally the
1364                desired position within the paragraph.
1365  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
1366                seen on the screen. Moreover the id is unique for all opened buffers (documents).
1367  * \li Syntax: paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
1368  * \li Params: <PAR_ID_NUMBER>:  paragraph id
1369                <POSITION_IN_PAR>: desired position within the paragraph
1370  * \li Origin: Dekel, 26 Aug 2000
1371  * \endvar
1372  */
1373                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
1374 /*!
1375  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1376  * \li Action: Breaks the current paragraph at the current location.
1377  * \li Syntax: break-paragraph
1378  * \endvar
1379  */
1380                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
1381 /*!
1382  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
1383  * \li Action: Breaks the current paragraph at the current location.
1384  * \li Notion: Removes the selection.
1385  * \li Syntax: break-paragraph [<LAYOUT>]
1386  * \li Params: <LAYOUT>: "inverse" - decreases depth by one (or change layout
1387                          to default layout) when the cursor is at the end of
1388                          the line.
1389  * \endvar
1390  */
1391                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
1392 /*!
1393  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
1394  * \li Action: Change paragraph settings.
1395  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1396                This function only modifies, and does not override, existing settings.
1397                Note that the "leftindent" indent setting is deprecated.
1398  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1399  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1400                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1401                <ALIGN>:   \\align block|left|right|center|default\n
1402                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1403  * \li Origin: rgh, Aug 15 2007
1404  * \endvar
1405  */
1406                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1407 /*!
1408  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1409  * \li Action: Change paragraph settings.
1410  * \li Notion: Overwrite all nonspecified settings to the default ones.
1411                Use paragraph-params lfun if you don't want to overwrite others settings.
1412  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1413  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1414  * \li Origin: leeming, 30 Mar 2004
1415  * \endvar
1416  */
1417                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1418                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1419
1420 /*!
1421  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
1422  * \li Action: Move the current group in the upward direction in the
1423                structure of the document.
1424  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1425                the whole substructure of the group.
1426  * \li Syntax: outline-up
1427  * \li Origin: Vermeer, 23 Mar 2006
1428  * \endvar
1429  */
1430                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
1431 /*!
1432  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
1433  * \li Action: Move the current group in the downward direction in the
1434                structure of the document.
1435  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
1436                the whole substructure of the group.
1437  * \li Syntax: outline-down
1438  * \li Origin: Vermeer, 23 Mar 2006
1439  * \endvar
1440  */
1441                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
1442 /*!
1443  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
1444  * \li Action: Moves the current group in the downward direction in the
1445                hierarchy of the document structure.
1446  * \li Notion: Part -> Chapter -> Section -> etc.
1447  * \li Syntax: outline-in
1448  * \li Origin: Vermeer, 23 Mar 2006
1449  * \endvar
1450  */
1451                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
1452 /*!
1453  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
1454  * \li Action: Moves the current group in the upward direction in the
1455                hierarchy of the document structure.
1456  * \li Notion: Part <- Chapter <- Section <- etc.
1457  * \li Syntax: outline-out
1458  * \li Origin: Vermeer, 23 Mar 2006
1459  * \endvar
1460  */
1461                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1462 /*!
1463  * \var lyx::FuncCode lyx::LFUN_INSET_EDIT
1464  * \li Action: Edit the inset at cursor with an external application,
1465  *             if one is attributed.
1466  * \li Syntax: inset-edit [<INSET_PARAMS>]
1467  * \li Params: <INSET_PARAMS>: Parameters for the inset.
1468                                Currently only the filename will be considered.
1469  * \li Origin: JSpitzm, 27 Apr 2006
1470  * \endvar
1471  */
1472                 { LFUN_INSET_EDIT, "inset-edit", Noop, Edit },
1473
1474                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1475                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1476                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1477                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1478                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1479
1480                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1481                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1482                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1483                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1484                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1485
1486                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1487                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1488                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1489                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1490                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1491                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1492                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1493                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1494
1495 /*!
1496  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1497  * \li Action: Apply data for an inset.
1498  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1499                be applied. This is either changed to #LFUN_INSET_MODIFY or
1500                #LFUN_INSET_INSERT depending on the context where it is called.
1501  * \li Syntax: inset-apply <ARGS>
1502  * \li Params: See #LFUN_INSET_INSERT .
1503  * \endvar
1504  */
1505                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1506 /*!
1507  * \var lyx::FuncCode lyx::LFUN_INSET_DISSOLVE
1508  * \li Action: Dissolve the current inset into text.
1509  * \li Syntax: inset-dissolve [<INSET>]
1510  * \li Params: <INSET>: this can be used to make sure the right kind of inset
1511                         is dissolved. For example "dissolve" entry in the charstyles
1512                         sub-menu should only dissolve the charstyle inset, even if the
1513                         cursor is inside several nested insets of different type.\n
1514                         For values see #lyx::InsetLayout::lyxtype_ .
1515  * \li Author: JSpitz, 7 Aug 2006
1516  * \endvar
1517  */
1518                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1519 /*!
1520  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1521  * \li Action: Insert new inset (type given by the parameters).
1522  * \li Syntax: inset-insert <INSET> <ARGS>
1523  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1524                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1525                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1526                        explore.
1527  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1528                where <label name> is the name of the referenced label and
1529                <Format> is one of the following: \n
1530                ref -- <reference> \n
1531                eqref -- (<reference>) \n
1532                pageref -- <page> \n
1533                vpageref -- on <page> \n
1534                vref -- <reference> on <page> \n
1535                prettyref -- Formatted reference
1536  * \endvar
1537  */
1538                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1539 /*!
1540  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1541  * \li Action: Modify existing inset.
1542  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1543                bibtex, ert, command, graphics, note, space, vspace, tabular,
1544                bibitem, inlude, ref insets.
1545  * \li Syntax: inset-modify <INSET> <ARGS>
1546  * \li Params: See #LFUN_INSET_INSERT for further details.
1547  * \endvar
1548  */
1549                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1550 /*!
1551  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_MODIFY
1552  * \li Action: Modify the inset at cursor position, if there is one.
1553  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1554                bibtex, ert, command, graphics, note, space, vspace, tabular,
1555                bibitem, inlude, ref insets.
1556  * \li Syntax: next-inset-modify <INSET> <ARGS> or next-inset-modify changetype <TYPE>
1557  * \li Params: See #LFUN_INSET_INSERT for further details.
1558  * \li Origin: JSpitzm, 23 Mar 2008
1559  * \endvar
1560  */
1561                 { LFUN_NEXT_INSET_MODIFY, "next-inset-modify", ReadOnly, Edit },
1562                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1563 /*!
1564  * \var lyx::FuncCode lyx::LFUN_INSET_SETTINGS
1565  * \li Action: Open the inset's properties dialog.
1566  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1567  * \li Syntax: inset-settings <INSET>
1568  * \li Params: <INSET>: <box|branch|ert|float|listings|note|tabular|wrap>
1569  * \endvar
1570  */
1571                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1572 /*!
1573  * \var lyx::FuncCode lyx::LFUN_NEXT_INSET_TOGGLE
1574  * \li Action: Toggles the inset at cursor position. For collapsables, this means it will
1575                be (un-)collapsed, in case of other insets, the editing widget (dialog) will
1576                be entered. Also cf. #LFUN_INSET_SETTINGS.
1577  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1578                bibtex, ert, command, graphics, note, space, vspace, tabular,
1579                bibitem, inlude, ref insets.
1580  * \li Syntax: next-inset-toggle <ARG>
1581  * \li Params: <ARG>: these are passed as arguments to #LFUN_INSET_TOGGLE .
1582  * \li Origin: leeming, 30 Mar 2004
1583  * \endvar
1584  */
1585                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1586 /*!
1587  * \var lyx::FuncCode lyx::LFUN_INSET_TOGGLE
1588  * \li Action: Toggles the collapsable inset we are currently in.
1589  * \li Syntax: inset-toggle [<ARG>]
1590  * \li Params: <ARG>: <open|close|toggle|assign>. \n
1591                open/close/toggle are for collapsable insets. close can be currently used
1592                by #LFUN_NEXT_INSET_TOGGLE. toggle is used when no argument is given.\n
1593                assign is for branch inset.
1594  * \li Origin: lasgouttes, 19 Jul 2001
1595  * \endvar
1596  */
1597                 { LFUN_INSET_TOGGLE, "inset-toggle", ReadOnly, Hidden },
1598 /*!
1599  * \var lyx::FuncCode lyx::LFUN_ALL_INSETS_TOGGLE
1600  * \li Action: Toggles (open/closes) all collapsable insets (of a given type) in the document.
1601  * \li Notion: Used for box, branch, ert, float, listings, note, tabular, wrap insets.
1602  * \li Syntax: all-insets-toggle <STATE> <INSET>
1603  * \li Params: <STATE>: <toggle|open|close> default: toggle \n
1604                <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all insets \n
1605  * \li Origin: leeming, 30 Mar 2004
1606  * \endvar
1607  */
1608                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1609 /*!
1610  * \var lyx::FuncCode lyx::LFUN_GRAPHICS_GROUPS_UNIFY
1611  * \li Action: Unify all graphics insets with the one given as an parameter.
1612  * \li Notion: This is internally used for synchronize certain group of graphics insets.
1613  * \li Syntax: graphics-groups-unigfy <GRAPHICS_PARAMS>
1614  * \li Params: <GRAPHICS_PARAMS>: Parameters for graphics inset
1615                                   (syntax can be seen in .lyx files).
1616  * \li Origin: sanda, 6 May 2008
1617  * \endvar
1618  */
1619                 { LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify", ReadOnly, Edit },
1620 /*!
1621  * \var lyx::FuncCode lyx::LFUN_SET_GRAPHICS_GROUP
1622  * \li Action: Set the group for the graphics inset on the cursor position.
1623  * \li Syntax: set-graphics-group [<GROUP>]
1624  * \li Params: <GROUP>: Id for an existing group. In case tthe Id is an empty string,
1625                         the graphics inset is removed from the current group.
1626  * \li Origin: sanda, 6 May 2008
1627  * \endvar
1628  */
1629                 { LFUN_SET_GRAPHICS_GROUP, "set-graphics-group", ReadOnly, Edit },
1630
1631 /*!
1632  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1633  * \li Action: Moves the cursor out of the current slice, going forward.
1634  * \li Notion: Cursor movement within an inset may be different than cursor
1635                movement in the surrounding text. This action should be called
1636                automatically by the cursor movement within the inset, when
1637                movement within the inset has ceased (reached the end of the
1638                last paragraph, for example), in order to move correctly
1639                back into the surrounding text.
1640  * \endvar
1641  */
1642                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1643 /*!
1644  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1645  * \li Action: Moves the cursor out of the current slice, going backwards.
1646  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1647  * \endvar
1648  */
1649                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1650 /*!
1651  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1652  * \li Action: Moves the cursor out of the current slice, going right.
1653  * \li Notion: See also #LFUN_FINISHED_FORWARD
1654  * \endvar
1655  */
1656                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1657 /*!
1658  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1659  * \li Action: Moves the cursor out of the current slice, going left.
1660  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1661  * \endvar
1662  */
1663                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1664
1665                 { LFUN_LANGUAGE, "language", Noop, Edit },
1666
1667 /*!
1668  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1669  * \li Action: Goto a label.
1670  * \li Syntax: label-goto [<LABEL>]
1671  * \li Params: <LABEL>: Requested label. If no label is given and refernce
1672                         is on cursor position, Bookmark 0 is saved and
1673                         cursor moves to the position of referenced label.
1674  * \li Origin: Ale, 6 Aug 1997
1675  * \endvar
1676  */
1677                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1678 /*!
1679  * \var lyx::FuncCode lyx::LFUN_LABEL_INSERT
1680  * \li Action: Inserts label to text or displayed formula.
1681  * \li Syntax: label-insert [<LABEL>]
1682  * \li Params: <LABEL>: Requested label. If no label is given dialog requesting
1683                         name will be opened.
1684  * \endvar
1685  */
1686                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1687 /*!
1688  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1689  * \li Action: Go to the next label or cross-reference.
1690  * \li Syntax: reference-next
1691  * \li Origin: Dekel, 14 Jan 2001
1692  * \endvar
1693  */
1694                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1695
1696 /*!
1697  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1698  * \li Action: Goto a bookmark.
1699  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1700                if necessary. Note that bookmarsk are saved per-session, not
1701                per file.
1702  * \li Syntax: bookmark-goto <NUMBER>
1703  * \li Params: <NUMBER>: the number of the bookmark to restore.
1704  * \li Origin: Dekel, 27 January 2001
1705  * \endvar
1706  */
1707                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1708 /*!
1709  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1710  * \li Action: Save a bookmark.
1711  * \li Notion: Saves a numbered bookmark to the sessions file. The number
1712                must be between 1 and 9, inclusive. Note that bookmarks are
1713                saved per-session, not per file.
1714  * \li Syntax: bookmark-save <NUMBER>
1715  * \li Params: <NUMBER>: the number of the bookmark to save.
1716  * \li Origin: Dekel, 27 January 2001
1717  * \endvar
1718  */
1719                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1720 /*!
1721  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1722  * \li Action: Clears the list of saved bookmarks.
1723  * \li Syntax: bookmark-clear
1724  * \li Origin: bpeng, 31 October 2006
1725  * \endvar
1726  */
1727                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1728
1729 /*!
1730  * \var lyx::FuncCode lyx::LFUN_HELP_OPEN
1731  * \li Action: Open the given help file according to the language setting.
1732  * \li Syntax: help-open <FILE>[.lyx]
1733  * \li Params: <FILE>: any document from (/usr/share/)doc directory.
1734  * \li Author: Jug, 27 Jun 1999
1735  * \endvar
1736  */
1737                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1738 /*!
1739  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1740  * \li Action: Terminates the current LyX instance.
1741  * \li Notion: Terminates the current LyX instance, asking whether to save
1742                modified documents, etc.
1743  * \li Syntax: lyx-quit
1744  * \endvar
1745  */
1746                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1747 /*!
1748  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1749  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1750  * \li Notion: Skiping "auto" when allowauto is false.
1751  * \li Syntax: toolbar-toggle <NAME> [allowauto]
1752  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1753                        minibuffer|review|view/update|math_panels
1754  * \li Origin: Edwin, 21 May 2007
1755  * \endvar
1756  */
1757                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1758 /*!
1759  * \var lyx::FuncCode lyx::LFUN_MENU_OPEN
1760  * \li Action: Opens the menu given by its name.
1761  * \li Syntax: menu-open <NAME>
1762  * \li Params: <NAME>: menu name. See various .inc files in lib/ui for candidates.
1763  * \endvar
1764  */
1765                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1766 /*!
1767  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1768  * \li Action: Various UI visibility-toggling actions.
1769  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1770  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
1771                menubar    : Toggle visibility of the menubar.\n
1772                scrollbar  : Toggle visibility of the scrollbar.\n
1773                frame      : Toggle visibility of the frames around editing window.\n
1774                fullscreen : Toggle fullscreen mode. This also covers calling the
1775                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1776                             custom tweaks of the toolbars should be used.
1777  * \li Origin: ps, 9 Feb 2007
1778  * \endvar
1779  */
1780                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1781
1782 /*!
1783  * \var lyx::FuncCode lyx::WINDOW_NEW
1784  * \li Action: Creates new empty LyX window.
1785  * \li Notion: Already opened documents from the previous window can be found under View menu.
1786  * \li Syntax: window-new [<GEOMETRY>]
1787  * \li Params: <GEOMETRY>: pass the geometry of the window. This parameter is currently
1788                            accepted only on Windows platform.
1789  * \li Origin: Abdel, 21 Oct 2006
1790  * \endvar
1791  */
1792                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1793 /*!
1794  * \var lyx::FuncCode lyx::LFUN_WINDOW_CLOSE
1795  * \li Action: Closes the current LyX window.
1796  * \li Syntax: window-close
1797  * \li Origin: Abdel, 23 Oct 2006
1798  * \endvar
1799  */
1800                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1801
1802 /*!
1803  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1804  * \li Action: Creates another split view of current buffer.
1805  * \li Notion: All split views act in the same way indpendently.
1806  * \li Syntax: split-view <vertical|horizontal>
1807  * \li Params: horizontal : The work areas are laid out side by side.\n
1808                vertical   : The work areas laid out vertically.\n
1809  * \li Origin: abdel, 20 Feb 2008
1810  * \endvar
1811  */
1812                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1813
1814 /*!
1815  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1816  * \li Action: Close the current tab group.
1817  * \li Notion: This only closes the work areas, not the buffer themselves.
1818                The still opened buffers can be visualized in another tab group.
1819  * \li Syntax: close-tab-group
1820  * \li Origin: abdel, 21 Feb 2008
1821  * \endvar
1822  */
1823                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1824                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1825                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1826                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1827                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1828                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1829                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1830
1831                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1832                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1833                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1834                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1835                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1836
1837                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1838                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1839                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1840                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1841
1842                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1843                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1844                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1845 /*!
1846  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1847  * \li Action: Sets the cursor position based on the row number of generated TeX file.
1848  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1849  * \li Origin: Edmar, 23 Dec 1998
1850  * \endvar
1851  */
1852                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1853                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1854 /*!
1855  * \var lyx::FuncCode lyx::LFUN_SERVER_SET_XY
1856  * \li Action: Sets the cursor position based on the editing area coordinates
1857                (similar as clicking on that point with left mouse button).
1858  * \li Syntax: server-set-xy <X> <Y>
1859  * \endvar
1860  */
1861                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1862 /*!
1863  * \var lyx::FuncCode lyx::LFUN_SERVER_GET_XY
1864  * \li Action: Returns the coordinates of cursor position in the editing area.
1865  * \li Syntax: server-get-xy
1866  * \endvar
1867  */
1868                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1869
1870 /*!
1871  * \var lyx::FuncCode lyx::LFUN_BUILD_PROGRAM
1872  * \li Action: Generates the code (literate programming).
1873  * \li Notion: Latex file with extension \literate_extension is generated.
1874                Then LyX invokes \build_command (with a default of``make'') to generate the code and
1875                \build_error_filter to process the compilation error messages. \n
1876                In case you want to process your literate file with a script, or some other program,
1877                just insert in your lyxrc file an entry with:\n
1878                \build_command "my_script my_arguments" \n
1879                The \build_error_filter differs from the \literate_error_filter only in that the
1880                former will identify error messages from your compiler.
1881  * \li Syntax: build-program
1882  * \endvar
1883  */
1884                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1885
1886 /*!
1887  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1888  * \li Action: Saves the current buffer to a temporary file.
1889  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1890                is called automatically by LyX, to "autosave" the current buffer.
1891  * \li Syntax: buffer-auto-save
1892  * \endvar
1893  */
1894                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1895 /*!
1896  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHILD_OPEN
1897  * \li Action: Loads the given child document.
1898  * \li Notion: The current document is treated as a parent.
1899  * \li Syntax: buffer-child-open <FILE>
1900  * \li Params: <FILE>: Filename of the child. The directory of the parent is assumed by default.
1901  * \li Origin: Ale, 28 May 1997
1902  * \endvar
1903  */
1904                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1905 /*!
1906  * \var lyx::FuncCode lyx::LFUN_BUFFER_CHKTEX
1907  * \li Action: Runs chktex for the current document.
1908  * \li Syntax: buffer-chktex
1909  * \li Origin: Asger, 30 Oct 1997
1910  * \endvar
1911  */
1912                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1913 /*!
1914  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_COMPRESSION
1915  * \li Action: Toggles compression of the current document on/off.
1916  * \li Syntax: buffer-toggle-compression
1917  * \li Origin: bpeng, 27 Apr 2006
1918  * \endvar
1919  */
1920                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1921 /*!
1922  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1923  * \li Action: Closes the current buffer.
1924  * \li Notion: Closes the current buffer, asking whether to save it, etc,
1925                if the buffer has been modified.
1926  * \li Syntax: buffer-close
1927  * \endvar
1928  */
1929                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1930 /*!
1931  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1932  * \li Action: Exports the current buffer (document) to the given format.
1933  * \li Syntax: buffer-export <FORMAT>
1934  * \li Params: <FORMAT> is either "custom" or one of the formats which you
1935                         can find in Tools->Preferences->File formats->Format.
1936                         Usual format you will enter is "pdf2" (pdflatex),
1937                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1938                         In case of "custom" you will be asked for a format you
1939                         want to start from and for the command that you want to
1940                         apply to this format. Internally the control is then passed
1941                         to #LFUN_BUFFER_EXPORT_CUSTOM.
1942  * \li Origin: Lgb, 29 Jul 1997
1943  * \endvar
1944  */
1945                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1946 /*!
1947  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1948  * \li Action: Exports the current buffer (document) from the given format using
1949                the given command on it.
1950  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1951  * \li Params: <FORMAT> format to start from (LyX will care to produce such
1952                         intermediate file).\n
1953                <COMMAND> this command will be launched on the file. Note that you can
1954                use "$$FName" string to qualify the intermediate file.
1955  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1956  * \li Origin: leeming, 27 Mar 2004
1957  * \endvar
1958  */
1959                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1960 /*!
1961  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1962  * \li Action: Prints the current document.
1963  * \li Notion: Many settings can be given via the preferences dialog.
1964  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1965  * \li Params: <TARGET> is either "printer" or "file".\n
1966                <TARGER-NAME> is either "default" or file name or printer name.\n
1967                <COMMAND> command ensuring the printing job.
1968  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1969  * \li Origin: leeming, 28 Mar 2004
1970  * \endvar
1971  */
1972                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1973 /*!
1974  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1975  * \li Action: Import a given file as a lyx document.
1976  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1977                defined convertors in preferences. Look into File->Import menu to get
1978                an idea of the currently active import formats.
1979  * \li Syntax: buffer-import <FORMAT> [<FILE>]
1980  * \li Origin: Asger, 24 Jul 1998
1981  * \endvar
1982  */
1983                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1984 /*!
1985  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1986  * \li Action: Creates a new buffer (that is, document).
1987  * \li Notion: Implicit path can be set in Preferences dialog.
1988  * \li Syntax: buffer-new [<FILE>]
1989  * \li Params: <FILE>: filename of created file with absolute path.
1990  * \endvar
1991  */
1992                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1993 /*!
1994  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1995  * \li Action: Creates a new buffer (that is, document) from a template.
1996  * \li Notion: Path for new files and templates can be set in Preferences dialog.
1997                Template will be asked for via Open-dialog.
1998  * \li Syntax: buffer-new-template [<FILE>]
1999  * \li Params: <FILE>: filename of created file with absolute path.
2000  * \endvar
2001  */
2002                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
2003 /*!
2004  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
2005  * \li Action: Reverts opened document.
2006  * \li Syntax: buffer-reload
2007  * \li Origin: Asger, 2 Feb 1997
2008  * \endvar
2009  */
2010                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
2011 /*!
2012  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
2013  * \li Action: Switch to the given buffer.
2014  * \li Notion: This is useful also in case you need simultaneously more views of the edited
2015                document in different LyX windows.
2016  * \li Syntax: buffer-new-template <BUFFER>
2017  * \li Params: <BUFFER>: already opened document which is to be shown.
2018  * \endvar
2019  */
2020                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
2021 /*!
2022  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
2023  * \li Action: Toggle editing mode of the current document between read/write and read-only.
2024  * \li Syntax: buffer-toggle-read-only
2025  * \li Origin: Lgb, 27 May 1997
2026  * \endvar
2027  */
2028                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
2029 /*!
2030  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
2031  * \li Action: Displays current buffer in chosen format.
2032  * \li Notion: Displays the contents of the current buffer in the chosen
2033                format, for example, PDF or DVI. This runs the necessary
2034                converter, calls the defined viewer, and so forth.
2035  * \li Syntax: buffer-view <FORMAT>
2036  * \li Params: <FORMAT>: The format to display, where this is one of the
2037                          formats defined (in the current GUI) in the
2038                          Tools>Preferences>File Formats dialog.
2039  * \endvar
2040  */
2041                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
2042 /*!
2043  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
2044  * \li Action: Exports the current document and put the result into the
2045                temporary directory.
2046  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
2047                the output will be rewriten - updated. This is useful in case your viewer
2048                is able to detect such changes (e.g. ghostview for postscript).
2049  * \li Syntax: buffer-update <FORMAT>
2050  * \li Params: <FORMAT>: The format to display, where this is one of the
2051                          formats defined (in the current GUI) in the
2052                          Tools>Preferences>File Formats dialog.
2053  * \li Origin: Dekel, 5 Aug 2000
2054  * \endvar
2055  */
2056                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
2057
2058 /*!
2059  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
2060  * \li Action: Saves the current buffer.
2061  * \li Notion: Saves the current buffer to disk, using the filename that
2062                is already associated with the buffer, asking for one if
2063                none is yet assigned.
2064  * \li Syntax: buffer-write
2065  * \endvar
2066  */
2067                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
2068 /*!
2069  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
2070  * \li Action: Rename and save current buffer.
2071  * \li Syntax: buffer-write-as <FILENAME>
2072  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
2073                is with respect to the original location of the buffer/file.
2074  * \endvar
2075  */
2076                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
2077 /*!
2078  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_ALL
2079  * \li Action: Save all changed documents.
2080  * \li Syntax: buffer-write-all
2081  * \li Origin: rgh, gpothier 6 Aug 2007
2082  * \endvar
2083  */
2084                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
2085 /*!
2086  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEXT
2087  * \li Action: Switch to the next opened document.
2088  * \li Notion: Note that this does not necessarily mean next in tabbar
2089                (for full list see View menu).
2090  * \li Syntax: buffer-next
2091  * \endvar
2092  */
2093                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
2094 /*!
2095  * \var lyx::FuncCode lyx::LFUN_BUFFER_PREVIOUS
2096  * \li Action: Switch to the previous opened document.
2097  * \li Syntax: buffer-previous
2098  * \endvar
2099  */
2100                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
2101 /*!
2102  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_UPDATE
2103  * \li Action: When run from a child document, this updates (exports) document built
2104                 from the master buffer. If a master is not found, it updates the
2105                 current buffer.
2106  * \li Syntax: master-buffer-update
2107  * \li Author: Tommaso, 20 Sep 2007
2108  * \endvar
2109  */
2110                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
2111 /*!
2112  * \var lyx::FuncCode lyx::LFUN_MASTER_BUFFER_VIEW
2113  * \li Action: When run from a child document, this command shows a preview built
2114                from the master buffer. If a master is not found, it previews the
2115                current buffer.
2116  * \li Syntax: master-buffer-view
2117  * \li Author: Tommaso, 20 Sep 2007
2118  * \endvar
2119  */
2120                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
2121 /*!
2122  * \var lyx::FuncCode lyx::LFUN_BUFFER_LANGUAGE
2123  * \li Action: Set language of the current document.
2124  * \li Syntax: buffer-language <LANG>
2125  * \li Params: <LANG>: language name. See lib/languages for list.
2126  * \li Author: leeming, 30 Mar 2004
2127  * \endvar
2128  */
2129                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
2130 /*!
2131  * \var lyx::FuncCode lyx::LFUN_BUFFER_SAVE_AS_DEFAULT
2132  * \li Action: Save the current document settings as default.
2133  * \li Notion: The file will will be saved into ~/.lyx/templates/defaults.lyx .
2134  * \li Syntax: buffer-save-as-default [<ARGS>]
2135  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2136                        you can find in document header of usual .lyx file.
2137  * \li Author: leeming, 30 Mar 2004
2138  * \endvar
2139  */
2140                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
2141 /*!
2142  * \var lyx::FuncCode lyx::LFUN_BUFFER_PARAMS_APPLY
2143  * \li Action: Apply the given settings to the current document.
2144  * \li Syntax: buffer-params-apply [<ARGS>]
2145  * \li Params: <ARGS>: contains the particular settings to be saved. They obey the syntax
2146                        you can find in document header of usual .lyx file.
2147  * \li Author: leeming, 30 Mar 2004
2148  * \endvar
2149  */
2150                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
2151
2152 /*!
2153  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
2154  * \li Action: Inserts another LyX file.
2155  * \li Syntax: file-insert [<FILE>]
2156  * \li Params: <FILE>: Filename to be inserted.
2157  * \endvar
2158  */
2159                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
2160 /*!
2161  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
2162  * \li Action: Inserts plain text file.
2163  * \li Syntax: file-insert-plaintext [<FILE>]
2164  * \li Params: <FILE>: Filename to be inserted.
2165  * \li Origin: CFO-G, 19 Nov 1997
2166  * \endvar
2167  */
2168                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
2169 /*!
2170  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
2171  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
2172  * \li Syntax: file-insert-plaintext-para [<FILE>]
2173  * \li Params: <FILE>: Filename to be inserted.
2174  * \li Origin: Levon, 14 Feb 2001
2175  * \endvar
2176  */
2177                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
2178 /*!
2179  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
2180  * \li Action: Open LyX document.
2181  * \li Syntax: file-open [<FILE>]
2182  * \li Params: <FILE>: Filename to be opened.
2183  * \endvar
2184  */
2185                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
2186
2187 /*!
2188  * \var lyx::FuncCode lyx::LFUN_CALL
2189  * \li Action: Executes a command defined in a .def file.
2190  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
2191                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
2192                where <NAME> is the name of the new command and <LFUN> is the lfun code
2193                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
2194                \\def_file "FileName" allows to include another .def file. \n
2195                This is particularly useful in connection with toolbar buttons:
2196                Since the name of the button image for this lfun is
2197                lib/images/commands/<NAME>.png this is the way to assign an image
2198                to a complex command-sequence.
2199  * \li Syntax: call <NAME>
2200  * \li Params: <NAME>: Name of the command that must be called.
2201  * \li Origin: broider, 2 Oct 2007
2202  * \endvar
2203  */
2204                 { LFUN_CALL, "call", NoBuffer, System },
2205 /*!
2206  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
2207  * \li Action: Simulate halting Meta key (Alt key on PCs).
2208  * \li Notion: Used for buffer editation not for GUI control.
2209  * \li Syntax: meta-prefix
2210  * \endvar
2211  */
2212                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
2213 /*!
2214  * \var lyx::FuncCode lyx::LFUN_CANCEL
2215  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
2216  * \li Syntax: cancel
2217  * \endvar
2218  */
2219                 { LFUN_CANCEL, "cancel", NoBuffer, System },
2220
2221 /*!
2222  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
2223  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
2224  * \li Notion: Usually bound to M-x shortcut.
2225  * \li Syntax: command-execute
2226  * \endvar
2227  */
2228                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
2229                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
2230 /*!
2231  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
2232  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
2233  * \li Syntax: command-sequence <CMDS>
2234  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
2235  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
2236  * \li Origin: Andre', 11 Nov 1999
2237  * \endvar
2238  */
2239                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
2240 /*!
2241  * \var lyx::FuncCode lyx::LFUN_MESSAGE
2242  * \li Action: Shows message in statusbar (for script purposes).
2243  * \li Syntax: message <STRING>
2244  * \li Origin: Lgb, 8 Apr 2001
2245  * \endvar
2246  */
2247                 { LFUN_MESSAGE, "message", NoBuffer, System },
2248 /*!
2249  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
2250  * \li Action: Save user preferences.
2251  * \li Syntax: preferences-save
2252  * \li Origin: Lgb, 27 Nov 1999
2253  * \endvar
2254  */
2255                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
2256 /*!
2257  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
2258  * \li Action: Reconfigure the automatic settings.
2259  * \li Syntax: reconfigure
2260  * \li Origin: Asger, 14 Feb 1997
2261  * \endvar
2262  */
2263                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
2264 /*!
2265  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
2266  * \li Action: Apply the given settings to user preferences.
2267  * \li Syntax: lyxrc-apply <SETTINGS>
2268  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
2269                            to get an idea which commands to use and their syntax.
2270                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
2271  * \endvar
2272  */
2273                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
2274 /*!
2275  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
2276  * \li Action: Determine whether keep cursor inside the editing window regardless
2277                the scrollbar movement.
2278  * \li Syntax: toggle-cursor-follows-scrollbar
2279  * \li Origin: ARRae, 2 Dec 1997
2280  * \endvar
2281  */
2282                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
2283 /*!
2284  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
2285  * \li Action: Set the given LyX color to the color defined by the X11 name given.
2286  * \li Notion: A new color entry is created if the color is unknown.
2287                Color names can be stored as a part of user settings.
2288  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
2289  * \li Origin: SLior, 11 Jun 2000
2290  * \endvar
2291  */
2292                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
2293 /*!
2294  * \var lyx::FuncCode lyx::LFUN_STATISTICS
2295  * \li Action: Count the statistics (number of words and characters)
2296                in the document or in the given selection.
2297  * \li Notion: Note that this function gives the number of words/chars written,
2298                not the number of characters which will be typeset.
2299  * \li Syntax: statistics
2300  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
2301  * \endvar
2302  */
2303                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
2304 /*!
2305  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
2306  * \li Action: Show the inline completion at the cursor position.
2307  * \li Syntax: completion-inline
2308  * \li Origin: sts, Feb 19 2008
2309  * \endvar
2310  */
2311                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
2312 /*!
2313  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
2314  * \li Action: Show the completion popup at the cursor position.
2315  * \li Syntax: completion-popup
2316  * \li Origin: sts, Feb 19 2008
2317  * \endvar
2318  */
2319                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
2320 /*!
2321  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
2322  * \li Action: Try to complete the word or command at the cursor position.
2323  * \li Syntax: completion-complete
2324  * \li Origin: sts, Feb 19 2008
2325  * \endvar
2326  */
2327                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
2328 /*!
2329  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2330  * \li Action: Activate the branch
2331  * \li Syntax: branch-activate <BRANCH>
2332  * \li Params: <BRANCH>: The branch to activate
2333  * \li Sample: lyx -e pdf2 -x "branch-activate answers" finalexam.lyx \n
2334                could be used to export a pdf with the answers branch included
2335                without one's having to open LyX and activate the branch manually.
2336  * \li Origin: rgh, 27 May 2008
2337  * \endvar
2338  */
2339                 { LFUN_BRANCH_ACTIVATE, "branch-activate", Argument, Buffer },
2340 /*!
2341  * \var lyx::FuncCode lyx::LFUN_BRANCH_ACTIVATE
2342  * \li Action: De-activate the branch
2343  * \li Syntax: branch-deactivate <BRANCH>
2344  * \li Params: <BRANCH>: The branch to deactivate
2345  * \li Origin: rgh, 27 May 2008
2346  * \endvar
2347  */
2348                 { LFUN_BRANCH_DEACTIVATE, "branch-deactivate", Argument, Buffer },
2349
2350                 { LFUN_NOACTION, "", Noop, Hidden }
2351 #ifndef DOXYGEN_SHOULD_SKIP_THIS
2352         };
2353
2354         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
2355                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
2356         }
2357
2358         init = true;
2359 }
2360 #endif
2361
2362 LyXAction::LyXAction()
2363 {
2364         init();
2365 }
2366
2367
2368 // Returns an action tag from a string.
2369 FuncRequest LyXAction::lookupFunc(string const & func) const
2370 {
2371         string const func2 = trim(func);
2372
2373         if (func2.empty()) {
2374                 return FuncRequest(LFUN_NOACTION);
2375         }
2376
2377         string cmd;
2378         string const arg = split(func2, cmd, ' ');
2379
2380         func_map::const_iterator fit = lyx_func_map.find(cmd);
2381
2382         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
2383 }
2384
2385
2386 string const LyXAction::getActionName(FuncCode action) const
2387 {
2388         info_map::const_iterator const it = lyx_info_map.find(action);
2389         return it != lyx_info_map.end() ? it->second.name : string();
2390 }
2391
2392
2393 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
2394 {
2395         info_map::const_iterator const it = lyx_info_map.find(action);
2396         return it != lyx_info_map.end() ? it->second.type : Hidden;
2397 }
2398
2399
2400 bool LyXAction::funcHasFlag(FuncCode action,
2401                             LyXAction::func_attrib flag) const
2402 {
2403         info_map::const_iterator ici = lyx_info_map.find(action);
2404
2405         if (ici == lyx_info_map.end()) {
2406                 LYXERR0("action: " << action << " is not known.");
2407                 LASSERT(false, /**/);
2408         }
2409
2410         return ici->second.attrib & flag;
2411 }
2412
2413
2414 LyXAction::const_func_iterator LyXAction::func_begin() const
2415 {
2416         return lyx_func_map.begin();
2417 }
2418
2419
2420 LyXAction::const_func_iterator LyXAction::func_end() const
2421 {
2422         return lyx_func_map.end();
2423 }
2424
2425
2426 } // namespace lyx