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