src/LyXAction.cpp

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