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