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 <boost/assert.hpp>
  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                 { LFUN_ACCENT_SPECIAL_CARON, "accent-special-caron", Noop, Edit },
 196 /*!
 197  * \var lyx::FuncCode lyx::LFUN_ACCENT_TIE
 198  * \li Action: Adds a tie \htmlonly (a&#865;)\endhtmlonly
 199                over the next two character typed.
 200  * \li Notion: the following char will finish the tie.
 201  * \li Syntax: accent-tie
 202  * \endvar
 203  */
 204                 { LFUN_ACCENT_TIE, "accent-tie", Noop, Edit },
 205 /*!
 206  * \var lyx::FuncCode lyx::LFUN_ACCENT_TILDE
 207  * \li Action: Adds a tilde \htmlonly (&atilde;)\endhtmlonly
 208                over the next character typed.
 209  * \li Syntax: accent-tilde
 210  * \endvar
 211  */
 212                 { LFUN_ACCENT_TILDE, "accent-tilde", Noop, Edit },
 213 /*!
 214  * \var lyx::FuncCode lyx::LFUN_ACCENT_UMLAUT
 215  * \li Action: Adds an umlaut \htmlonly (&auml;)\endhtmlonly
 216                over the next character typed.
 217  * \li Syntax: accent-umlaut
 218  * \endvar
 219  */
 220                 { LFUN_ACCENT_UMLAUT, "accent-umlaut", Noop, Edit },
 221 /*!
 222  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERBAR
 223  * \li Action: Adds a bar \htmlonly (a&#800;)\endhtmlonly
 224                under the next character typed.
 225  * \li Syntax: accent-underbar
 226  * \endvar
 227  */
 228                 { LFUN_ACCENT_UNDERBAR, "accent-underbar", Noop, Edit },
 229 /*!
 230  * \var lyx::FuncCode lyx::LFUN_ACCENT_UNDERDOT
 231  * \li Action: Adds a dot \htmlonly (&#7841;)\endhtmlonly
 232                under the next character typed.
 233  * \li Syntax: accent-underdot
 234  * \endvar
 235  */
 236                 { LFUN_ACCENT_UNDERDOT, "accent-underdot", Noop, Edit },
 237
 238 /*!
 239  * \var lyx::FuncCode lyx::LFUN_CAPTION_INSERT
 240  * \li Action: Inserts a caption inset.
 241  * \li Syntax: caption-insert
 242  * \li Origin: Lgb, 18 Jul 2000
 243  * \endvar
 244  */
 245                 { LFUN_CAPTION_INSERT, "caption-insert", Noop, Edit },
 246 /*!
 247  * \var lyx::FuncCode lyx::LFUN_DATE_INSERT
 248  * \li Action: Inserts the current date.
 249  * \li Syntax: date-insert [<ARG>]
 250  * \li Params: <ARG>: Format of date. The default value (%x) can be set
 251                      in Preferences->Date format. For possible formats
 252                      see manual page of strftime function.
 253  * \li Origin: jdblair, 31 Jan 2000
 254  * \endvar
 255  */
 256                 { LFUN_DATE_INSERT, "date-insert", Noop, Edit },
 257 /*!
 258  * \var lyx::FuncCode lyx::LFUN_FOOTNOTE_INSERT
 259  * \li Action: Inserts a footnote inset.
 260  * \li Syntax: footnote-insert
 261  * \li Origin: Jug, 7 Mar 2000
 262  * \endvar
 263  */
 264                 { LFUN_FOOTNOTE_INSERT, "footnote-insert", Noop, Edit },
 265 /*!
 266  * \var lyx::FuncCode lyx::LFUN_ERT_INSERT
 267  * \li Action: Inserts an ERT inset.
 268  * \li Syntax: ert-insert
 269  * \li Origin: Jug, 18 Feb 2000
 270  * \endvar
 271  */
 272                 { LFUN_ERT_INSERT, "ert-insert", Noop, Edit },
 273                 { LFUN_FLOAT_INSERT, "float-insert", Noop, Edit },
 274                 { LFUN_FLOAT_WIDE_INSERT, "float-wide-insert", Noop, Edit },
 275                 { LFUN_WRAP_INSERT, "wrap-insert", Noop, Edit },
 276 /*!
 277  * \var lyx::FuncCode lyx::LFUN_OPTIONAL_INSERT
 278  * \li Action: Inserts an optional-argument (short title) inset.
 279  * \li Syntax: optional-insert
 280  * \li Origin: Martin, 12 Aug 2002
 281  * \endvar
 282  */
 283                 { LFUN_OPTIONAL_INSERT, "optional-insert", Noop, Edit },
 284 /*!
 285  * \var lyx::FuncCode lyx::LFUN_LINE_INSERT
 286  * \li Action: Inserts a horizontal line.
 287  * \li Syntax: line-insert
 288  * \li Origin: poenitz,  Oct 27 2003
 289  * \endvar
 290  */
 291                 { LFUN_LINE_INSERT, "line-insert", Noop, Edit },
 292 /*!
 293  * \var lyx::FuncCode lyx::LFUN_NEWPAGE_INSERT
 294  * \li Action: Inserts a new page.
 295  * \li Syntax: newpage-insert
 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_PAGEBREAK_INSERT
 302  * \li Action: Inserts a pagebreak.
 303  * \li Syntax: pagebreak-insert
 304  * \li Origin: poenitz,  Oct 27 2003
 305  * \endvar
 306  */
 307                 { LFUN_PAGEBREAK_INSERT, "pagebreak-insert", Noop, Edit },
 308 /*!
 309  * \var lyx::FuncCode lyx::LFUN_MARGINALNOTE_INSERT
 310  * \li Action: Inserts a marginal note.
 311  * \li Syntax: marginalnote-insert
 312  * \li Origin: Lgb, 26 Jun 2000
 313  * \endvar
 314  */
 315                 { LFUN_MARGINALNOTE_INSERT, "marginalnote-insert", Noop, Edit },
 316 /*!
 317  * \var lyx::FuncCode lyx::LFUN_UNICODE_INSERT
 318  * \li Action: Inserts a single unicode character.
 319  * \li Syntax: unicode-insert <CHAR>
 320  * \li Params: <CHAR>: The character to insert, given as its code
 321                        point, in hexadecimal, e.g.: unicode-insert 0x0100.
 322  * \li Origin: Lgb, 22 Oct 2006
 323  * \endvar
 324  */
 325                 { LFUN_UNICODE_INSERT, "unicode-insert", Noop, Edit },
 326 /*!
 327  * \var lyx::FuncCode lyx::LFUN_LISTING_INSERT
 328  * \li Action: Inserts a new listings inset.
 329  * \li Syntax: listing-insert
 330  * \li Origin: Herbert, 10 Nov 2001; bpeng, 2 May 2007
 331  * \endvar
 332  */
 333                 { LFUN_LISTING_INSERT, "listing-insert", Noop, Edit },
 334                 { LFUN_QUOTE_INSERT, "quote-insert", Noop, Edit },
 335                 { LFUN_INFO_INSERT, "info-insert", Noop, Edit },
 336                 { LFUN_BRANCH_INSERT, "branch-insert", Noop, Edit },
 337                 { LFUN_BOX_INSERT, "box-insert", Noop, Edit },
 338 /*!
 339  * \var lyx::FuncCode lyx::LFUN_FLEX_INSERT
 340  * \li Action: Inserts CharStyle, Custom inset or XML short element.
 341  * \li Notion: Look into the Customization manual for more information about
 342                these elements.\n
 343                For dissolving the element see #LFUN_INSET_DISSOLVE.
 344  * \li Syntax: flex-insert <TYPE:Name>
 345  * \li Params: TYPE: CharStyle|Custom|Element|Standard
 346                      Identifies whether this is a Character Style, a
 347                      Custom Inset or an XML Element, and which dynamical
 348                      sub-menu this flex inset is in on the LyX menu tree.
 349                      If Standard (currently unused): none of these.
 350                Name: This name must be defined either in your layout file
 351                      or imported by some module. The definition is\n
 352                      InsetLayout <TYPE:Name>
 353  * \li Sample: flex-insert CharStyle:Code
 354  * \endvar
 355  */
 356                 { LFUN_FLEX_INSERT, "flex-insert", Noop, Edit },
 357                 { LFUN_SELF_INSERT, "self-insert", SingleParUpdate, Hidden },
 358 /*!
 359  * \var lyx::FuncCode lyx::LFUN_SPACE_INSERT
 360  * \li Action: Inserts one of horizontal space insets.
 361  * \li Syntax: space-insert <NAME> [<LEN>]
 362  * \li Params: <NAME>: normal, protected, thin, quad, qquad, enspace, enskip,
 363                        negthinspace, hfill, dotfill, hrulefill, hspace, hspace* \n
 364                <LEN>: length for custom spaces (hspace, hspace* for protected)
 365  * \li Origin: JSpitzm, 20 May 2003, Mar 17 2008
 366  * \endvar
 367  */
 368                 { LFUN_SPACE_INSERT, "space-insert", Noop, Edit },
 369                 { LFUN_HYPERLINK_INSERT, "href-insert", Noop, Edit },
 370                 { LFUN_SPECIALCHAR_INSERT, "specialchar-insert", Noop, Edit },
 371                 { LFUN_CLEARPAGE_INSERT, "clearpage-insert", Noop, Edit },
 372                 { LFUN_CLEARDOUBLEPAGE_INSERT, "cleardoublepage-insert", Noop, Edit },
 373                 { LFUN_TOC_INSERT, "toc-insert", Noop, Edit },
 374                 { LFUN_APPENDIX, "appendix", Noop, Edit },
 375
 376 #if 0
 377                 { LFUN_LIST_INSERT, "list-insert", Noop, Edit },
 378 #endif
 379
 380                 { LFUN_DELETE_BACKWARD_SKIP, "delete-backward-skip", Noop, Edit },
 381                 { LFUN_DELETE_FORWARD_SKIP, "delete-forward-skip", Noop, Edit },
 382                 { LFUN_DOWN, "down", ReadOnly | NoUpdate, Edit },
 383                 { LFUN_DOWN_SELECT, "down-select", ReadOnly | SingleParUpdate, Edit },
 384                 { LFUN_UP, "up", ReadOnly | NoUpdate, Edit },
 385                 { LFUN_UP_SELECT, "up-select", ReadOnly | SingleParUpdate, Edit },
 386                 { LFUN_SCREEN_DOWN, "screen-down", ReadOnly, Edit },
 387                 { LFUN_SCREEN_DOWN_SELECT, "screen-down-select", ReadOnly, Edit },
 388 /*!
 389  * \var lyx::FuncCode lyx::LFUN_SCROLL
 390  * \li Action: Scroll the buffer view.
 391  * \li Notion: Only scrolls the screen up or down; does not move the cursor.
 392  * \li Syntax: scroll <TYPE> <QUANTITY>
 393  * \li Params: <TYPE>:  line|page\n
 394                <QUANTITY>: up|down|<number>
 395  * \li Origin: Abdelrazak Younes, Dec 27 2007
 396  * \endvar
 397  */
 398                 { LFUN_SCROLL, "scroll", ReadOnly, Edit },
 399 /*!
 400  * \var lyx::FuncCode lyx::LFUN_SCREEN_RECENTER
 401  * \li Action: Recenters the screen on the current cursor position.
 402  * \li Syntax: screen-recenter
 403  * \endvar
 404  */
 405                 { LFUN_SCREEN_RECENTER, "screen-recenter", ReadOnly, Edit },
 406                 { LFUN_SCREEN_UP, "screen-up", ReadOnly, Edit },
 407                 { LFUN_SCREEN_UP_SELECT, "screen-up-select", ReadOnly, Edit },
 408
 409                 { LFUN_ERROR_NEXT, "error-next", ReadOnly, Edit },
 410 /*!
 411  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD
 412  * \li Action: Moves the cursor one position logically backwards.
 413  * \li Notion: This is not the action which should be bound to the arrow keys,
 414                because backwards may be left or right, depending on the
 415                language. The arrow keys should be bound to #LFUN_CHAR_LEFT or
 416                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
 417  * \li Syntax: char-backward
 418  * \endvar
 419  */
 420                 { LFUN_CHAR_BACKWARD, "char-backward", ReadOnly | NoUpdate, Edit },
 421 /*!
 422  * \var lyx::FuncCode lyx::LFUN_CHAR_BACKWARD_SELECT
 423  * \li Action: Moves the cursor one position logically backwards, adding
 424                traversed position to the selection.
 425  * \li Notion: See also #LFUN_CHAR_BACKWARD.
 426  * \li Syntax: char-backward-select
 427  * \endvar
 428  */
 429                 { LFUN_CHAR_BACKWARD_SELECT, "char-backward-select", ReadOnly | SingleParUpdate, Edit },
 430                 { LFUN_CHAR_DELETE_BACKWARD, "delete-backward", SingleParUpdate, Edit },
 431                 { LFUN_CHAR_DELETE_FORWARD, "delete-forward", SingleParUpdate, Edit },
 432 /*!
 433  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD
 434  * \li Action: Moves the cursor one position logically forward.
 435  * \li Notion: This is not the action which should be bound to the arrow keys,
 436                because forward may be left or right, depending on the language.
 437                The arrow keys should be bound to #LFUN_CHAR_LEFT or
 438                #LFUN_CHAR_RIGHT actions, which in turn may employ this one.
 439  * \li Syntax: char-forward
 440  * \endvar
 441  */
 442                 { LFUN_CHAR_FORWARD, "char-forward", ReadOnly | NoUpdate, Edit },
 443 /*!
 444  * \var lyx::FuncCode lyx::LFUN_CHAR_FORWARD_SELECT
 445  * \li Action: Moves the cursor one position logically forward, adding
 446                traversed position to the selection.
 447  * \li Notion: See also #LFUN_CHAR_FORWARD.
 448  * \li Syntax: char-forward-select
 449  * \endvar
 450  */
 451                 { LFUN_CHAR_FORWARD_SELECT, "char-forward-select", ReadOnly | SingleParUpdate, Edit },
 452 /*!
 453  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT
 454  * \li Action: Moves the cursor one position "to the left".
 455  * \li Notion: This is the action which should be taken when the "left" key
 456                is pressed. Generally, it moves the cursor one position to the
 457                left. However, in Bidi text this become slightly more
 458                complicated, and there are different modes of cursor movement.
 459                In "visual mode", this moves left, plain and simple. In "logical
 460                mode", movement is logically forward in RTL paragraphs, and
 461                logically backwards in LTR paragraphs.
 462  * \li Syntax: char-left
 463  * \endvar
 464  */
 465                 { LFUN_CHAR_LEFT, "char-left", ReadOnly | NoUpdate, Edit },
 466 /*!
 467  * \var lyx::FuncCode lyx::LFUN_CHAR_LEFT_SELECT
 468  * \li Action: Moves the cursor one position "to the left", adding
 469                traversed position to the selection.
 470  * \li Notion: See also #LFUN_CHAR_LEFT for exact details of the movement.
 471  * \li Syntax: char-left-select
 472  * \endvar
 473  */
 474                 { LFUN_CHAR_LEFT_SELECT, "char-left-select", ReadOnly | SingleParUpdate, Edit },
 475 /*!
 476  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT
 477  * \li Action: Moves the cursor one position "to the right".
 478  * \li Notion: This is the action which should be taken when the "right" key
 479                is pressed. Generally, it moves the cursor one position to the
 480                right. However, in Bidi text this become slightly more
 481                complicated, and there are different modes of cursor movement.
 482                In "visual mode", this moves right, plain and simple. In "logical
 483                mode", movement is logically forward in LTR paragraphs, and
 484                logically backwards in RTL paragraphs.
 485  * \li Syntax: char-right
 486  * \endvar
 487  */
 488                 { LFUN_CHAR_RIGHT, "char-right", ReadOnly | NoUpdate, Edit },
 489 /*!
 490  * \var lyx::FuncCode lyx::LFUN_CHAR_RIGHT_SELECT
 491  * \li Action: Moves the cursor one position "to the right", adding
 492                traversed position to the selection.
 493  * \li Notion: See also #LFUN_CHAR_RIGHT for exact details of the movement.
 494  * \li Syntax: char-right-select
 495  * \endvar
 496  */
 497                 { LFUN_CHAR_RIGHT_SELECT, "char-right-select", ReadOnly | SingleParUpdate, Edit },
 498
 499                 { LFUN_WORD_BACKWARD, "word-backward", ReadOnly | NoUpdate, Edit },
 500                 { LFUN_WORD_BACKWARD_SELECT, "word-backward-select", ReadOnly | SingleParUpdate, Edit },
 501                 { LFUN_WORD_CAPITALIZE, "word-capitalize", Noop, Edit },
 502                 { LFUN_WORD_DELETE_BACKWARD, "word-delete-backward", Noop, Edit },
 503                 { LFUN_WORD_DELETE_FORWARD, "word-delete-forward", Noop, Edit },
 504                 { LFUN_WORD_FIND_BACKWARD, "word-find-backward", ReadOnly, Edit },
 505                 { LFUN_WORD_FIND_FORWARD, "word-find-forward", ReadOnly, Edit },
 506                 { LFUN_WORD_FORWARD, "word-forward", ReadOnly | NoUpdate, Edit },
 507                 { LFUN_WORD_FORWARD_SELECT, "word-forward-select", ReadOnly | SingleParUpdate, Edit },
 508                 { LFUN_WORD_LEFT, "word-left", ReadOnly | NoUpdate, Edit },
 509                 { LFUN_WORD_LEFT_SELECT, "word-left-select", ReadOnly | SingleParUpdate, Edit },
 510                 { LFUN_WORD_LOWCASE, "word-lowcase", Noop, Edit },
 511                 { LFUN_WORD_RIGHT, "word-right", ReadOnly | NoUpdate, Edit },
 512                 { LFUN_WORD_RIGHT_SELECT, "word-right-select", ReadOnly | SingleParUpdate, Edit },
 513                 { LFUN_WORD_SELECT, "word-select", ReadOnly, Edit },
 514                 { LFUN_WORD_UPCASE, "word-upcase", Noop, Edit },
 515                 { LFUN_WORD_FIND, "word-find", ReadOnly, Edit },
 516                 { LFUN_WORD_REPLACE, "word-replace", Noop, Edit },
 517 /*!
 518  * \var lyx::FuncCode lyx::LFUN_THESAURUS_ENTRY
 519  * \li Action: Look up thesaurus entries with respect to the word under the cursor.
 520  * \li Syntax: thesaurus-entry
 521  * \li Origin: Levon, 20 Jul 2001
 522  * \endvar
 523  */
 524                 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", ReadOnly, Edit },
 525                 { LFUN_BUFFER_BEGIN, "buffer-begin", ReadOnly, Edit },
 526                 { LFUN_BUFFER_BEGIN_SELECT, "buffer-begin-select", ReadOnly, Edit },
 527                 { LFUN_BUFFER_END, "buffer-end", ReadOnly, Edit },
 528                 { LFUN_BUFFER_END_SELECT, "buffer-end-select", ReadOnly, Edit },
 529
 530                 { LFUN_LINE_BEGIN, "line-begin", ReadOnly | NoUpdate, Edit },
 531                 { LFUN_LINE_BEGIN_SELECT, "line-begin-select", ReadOnly | SingleParUpdate, Edit },
 532                 { LFUN_LINE_BREAK, "line-break", Noop, Edit },
 533                 { LFUN_LINE_DELETE, "line-delete-forward", Noop, Edit }, // there is no line-delete-backward
 534                 { LFUN_LINE_END, "line-end", ReadOnly | NoUpdate, Edit },
 535                 { LFUN_LINE_END_SELECT, "line-end-select", ReadOnly | SingleParUpdate, Edit },
 536                 { LFUN_NEW_LINE, "new-line", Noop, Edit },
 537
 538 /*!
 539  * \var lyx::FuncCode lyx::LFUN_COPY
 540  * \li Action: Copies to the clipboard the last edit.
 541  * \li Syntax: copy
 542  * \endvar
 543  */
 544                 { LFUN_COPY, "copy", ReadOnly, Edit },
 545 /*!
 546  * \var lyx::FuncCode lyx::LFUN_CUT
 547  * \li Action: Cuts to the clipboard.
 548  * \li Syntax: cut
 549  * \endvar
 550  */
 551                 { LFUN_CUT, "cut", Noop, Edit },
 552 /*!
 553  * \var lyx::FuncCode lyx::LFUN_PASTE
 554  * \li Action: Pastes from the active clipboard.
 555  * \li Syntax: paste
 556  * \endvar
 557  */
 558                 { LFUN_PASTE, "paste", Noop, Edit },
 559                 { LFUN_CLIPBOARD_PASTE, "clipboard-paste", Noop, Edit },
 560 /*!
 561  * \var lyx::FuncCode lyx::LFUN_PRIMARY_SELECTION_PASTE
 562  * \li Action: Pastes the material currently selected.
 563  * \li Syntax: primary-selection-paste
 564  * \endvar
 565  */
 566                 { LFUN_PRIMARY_SELECTION_PASTE, "primary-selection-paste", Noop, Edit },
 567 /*!
 568  * \var lyx::FuncCode lyx::LFUN_UNDO
 569  * \li Action: Undoes the last edit.
 570  * \li Syntax: undo
 571  * \endvar
 572  */
 573                 { LFUN_UNDO, "undo", Noop, Edit },
 574 /*!
 575  * \var lyx::FuncCode lyx::LFUN_REDO
 576  * \li Action: Redoes the last thing undone.
 577  * \li Syntax: redo
 578  * \endvar
 579  */
 580                 { LFUN_REDO, "redo", Noop, Edit },
 581                 { LFUN_REPEAT, "repeat", NoBuffer, Edit },
 582                 { LFUN_CHARS_TRANSPOSE, "chars-transpose", Noop, Edit },
 583
 584                 { LFUN_DEPTH_DECREMENT, "depth-decrement", Noop, Edit },
 585                 { LFUN_DEPTH_INCREMENT, "depth-increment", Noop, Edit },
 586                 { LFUN_ENVIRONMENT_INSERT, "environment-insert", Noop, Edit },
 587
 588                 { LFUN_FONT_BOLD, "font-bold", Noop, Layout },
 589                 { LFUN_FONT_TYPEWRITER, "font-typewriter", Noop, Layout },
 590                 { LFUN_FONT_DEFAULT, "font-default", Noop, Layout },
 591                 { LFUN_FONT_EMPH, "font-emph", Noop, Layout },
 592                 { LFUN_FONT_FREE_APPLY, "font-free-apply", Noop, Layout },
 593                 { LFUN_FONT_FREE_UPDATE, "font-free-update", Noop, Layout },
 594                 { LFUN_FONT_NOUN, "font-noun", Noop, Layout },
 595                 { LFUN_FONT_ROMAN, "font-roman", Noop, Layout },
 596                 { LFUN_FONT_SANS, "font-sans", Noop, Layout },
 597                 { LFUN_FONT_FRAK, "font-frak", Noop, Layout },
 598                 { LFUN_FONT_ITAL, "font-ital", Noop, Layout },
 599                 { LFUN_FONT_SIZE, "font-size", Noop, Layout },
 600                 { LFUN_FONT_STATE, "font-state", ReadOnly, Layout },
 601                 { LFUN_FONT_UNDERLINE, "font-underline", Noop, Layout },
 602                 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update", NoBuffer, Layout },
 603
 604                 { LFUN_INDEX_INSERT, "index-insert", Noop, Edit },
 605                 { LFUN_INDEX_PRINT, "index-print", Noop, Edit },
 606
 607                 { LFUN_NOMENCL_INSERT, "nomencl-insert", Noop, Edit },
 608                 { LFUN_NOMENCL_PRINT, "nomencl-print", Noop, Edit },
 609
 610                 { LFUN_NOTE_INSERT, "note-insert", Noop, Edit },
 611                 { LFUN_NOTE_NEXT, "note-next", ReadOnly, Edit },
 612
 613                 { LFUN_BIBITEM_INSERT, "bibitem-insert", Noop, Edit },
 614                 { LFUN_CITATION_INSERT, "citation-insert", Noop, Edit },
 615                 { LFUN_BIBTEX_DATABASE_ADD, "bibtex-database-add", Noop, Edit },
 616                 { LFUN_BIBTEX_DATABASE_DEL, "bibtex-database-del", Noop, Edit },
 617
 618 /*!
 619  * \var lyx::FuncCode lyx::LFUN_LAYOUT
 620  * \li Action: Sets the layout (that is, environment) for the current paragraph.
 621  * \li Syntax: layout <LAYOUT>
 622  * \li Params: <LAYOUT>: the layout to use
 623  * \endvar
 624  */
 625                 { LFUN_LAYOUT, "layout", Noop, Layout },
 626 /*!
 627  * \var lyx::FuncCode lyx::LFUN_LAYOUT_PARAGRAPH
 628  * \li Action: Launches the paragraph settings dialog.
 629  * \li Syntax: layout-paragraph
 630  * \endvar
 631  */
 632                 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", ReadOnly, Layout },
 633                 { LFUN_LAYOUT_TABULAR, "layout-tabular", Noop, Layout },
 634 /*!
 635  * \var lyx::FuncCode lyx::LFUN_DROP_LAYOUTS_CHOICE
 636  * \li Action: Displays list of layout choices.
 637  * \li Notion: In the current (as of 2007) Qt4 frontend, this LFUN opens the
 638                dropbox allowing for choice of layout.
 639  * \li Syntax: drop-layouts-choice
 640  * \endvar
 641  */
 642                 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice", ReadOnly, Layout },
 643 /*!
 644  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULES_CLEAR
 645  * \li Action: Clears the module list.
 646  * \li Notion: Clears the list of included modules for the current buffer.
 647  * \li Syntax: layout-modules-clear
 648  * \li Origin: rgh, 25 August 2007
 649  * \endvar
 650  */
 651                 { LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear", Noop, Layout },
 652 /*!
 653  * \var lyx::FuncCode lyx::LFUN_LAYOUT_MODULE_ADD
 654  * \li Action: Adds a module.
 655  * \li Notion: Adds a module to the list of included modules for the current buffer.
 656  * \li Syntax: layout-module-add <MODULE>
 657  * \li Params: <MODULE>: the module to be added
 658  * \li Origin: rgh, 25 August 2007
 659  * \endvar
 660  */
 661                 { LFUN_LAYOUT_MODULE_ADD, "layout-module-add", Noop, Layout },
 662 /*!
 663  * \var lyx::FuncCode lyx::LFUN_LAYOUT_RELOAD
 664  * \li Action: Reloads layout information.
 665  * \li Notion: Reloads all layout information for the current buffer from disk, thus
 666                recognizing any changes that have been made to layout files on the fly.
 667                This is intended to be used only by layout developers and should not be
 668                used when one is trying to do actual work.
 669  * \li Syntax: layout-reload
 670  * \li Origin: rgh, 3 September 2007
 671  * \endvar
 672  */
 673                 { LFUN_LAYOUT_RELOAD, "layout-reload", Noop, Layout },
 674 /*!
 675  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_APPLY
 676  * \li Action: Sets the text class for the current buffer.
 677  * \li Syntax: textclass-apply <TEXTCLASS>
 678  * \li Params: <TEXTCLASS>: the textclass to set. Note that this must be
 679                    the filename, minus the ".layout" extension.
 680  * \endvar
 681  */
 682                 { LFUN_TEXTCLASS_APPLY, "textclass-apply", Noop, Layout },
 683 /*!
 684  * \var lyx::FuncCode lyx::LFUN_TEXTCLASS_LOAD
 685  * \li Action: Loads information for a textclass from disk.
 686  * \li Syntax: textclass-load <TEXTCLASS>
 687  * \li Params: <TEXTCLASS>: the textclass to load. Note that this must be
 688                    the filename, minus the ".layout" extension.
 689  * \endvar
 690  */
 691                 { LFUN_TEXTCLASS_LOAD, "textclass-load", Noop, Layout },
 692
 693 /*!
 694  * \var lyx::FuncCode lyx::LFUN_MARK_OFF
 695  * \li Action: Disable selecting of text-region.
 696  * \li Syntax: mark-off
 697  * \endvar
 698  */
 699                 { LFUN_MARK_OFF, "mark-off", ReadOnly, Edit },
 700 /*!
 701  * \var lyx::FuncCode lyx::LFUN_MARK_ON
 702  * \li Action: Enable selecting of text-region.
 703  * \li Notion: After enabling you can simply move arrow keys to get selected region.
 704  * \li Syntax: mark-on
 705  * \endvar
 706  */
 707                 { LFUN_MARK_ON, "mark-on", ReadOnly, Edit },
 708 /*!
 709  * \var lyx::FuncCode lyx::LFUN_MARK_TOGGLE
 710  * \li Action: Toggle between #LFUN_MARK_ON and #LFUN_MARK_OFF .
 711  * \li Syntax: mark-toggle
 712  * \li Origin: poenitz, May 5 2006
 713  * \endvar
 714  */
 715                 { LFUN_MARK_TOGGLE, "mark-toggle", ReadOnly, Edit },
 716
 717                 { LFUN_MATH_DELIM, "math-delim", Noop, Math },
 718                 { LFUN_MATH_BIGDELIM, "math-bigdelim", Noop, Math },
 719                 { LFUN_MATH_DISPLAY, "math-display", Noop, Math },
 720                 { LFUN_MATH_INSERT, "math-insert", Noop, Math },
 721                 { LFUN_MATH_SUBSCRIPT, "math-subscript", Noop, Math },
 722                 { LFUN_MATH_SUPERSCRIPT, "math-superscript", Noop, Math },
 723                 { LFUN_MATH_LIMITS, "math-limits", Noop, Math },
 724                 { LFUN_MATH_MACRO, "math-macro", Noop, Math },
 725                 { LFUN_MATH_MUTATE, "math-mutate", Noop, Math },
 726                 { LFUN_MATH_SPACE, "math-space", Noop, Math },
 727                 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", Noop, Math },
 728                 { LFUN_MATH_MATRIX, "math-matrix", Noop, Math },
 729                 { LFUN_MATH_MODE, "math-mode", Noop, Math },
 730 /*!
 731  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_LINE_TOGGLE
 732  * \li Action: Toggles numbering of the current formula line.
 733  * \li Notion: Must be in display formula mode.
 734  * \li Syntax: math-number-line-toggle
 735  * \li Origin: Alejandro 18 Jun 1996
 736  * \endvar
 737  */
 738                 { LFUN_MATH_NUMBER_LINE_TOGGLE, "math-number-line-toggle", Noop, Math },
 739 /*!
 740  * \var lyx::FuncCode lyx::LFUN_MATH_NUMBER_TOGGLE
 741  * \li Action: Toggles numbering/labeling of the current formula.
 742  * \li Notion: Must be in display formula mode.
 743  * \li Syntax: math-number-toggle
 744  * \li Origin: Alejandro 4 Jun 1996
 745  * \endvar
 746  */
 747                 { LFUN_MATH_NUMBER_TOGGLE, "math-number-toggle", Noop, Math },
 748                 { LFUN_MATH_EXTERN, "math-extern", Noop, Math },
 749                 { LFUN_MATH_SIZE, "math-size", Noop, Math },
 750 /*!
 751  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_UNFOLD
 752  * \li Action: Unfold a Math Macro.
 753  * \li Notion: Unfold the Math Macro the cursor is in, i.e.
 754                display it as \foo.
 755  * \li Syntax: math-macro-unfold
 756  * \li Origin: sts, 06 January 2008
 757  * \endvar
 758  */
 759                 { LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold", ReadOnly | SingleParUpdate, Math },
 760 /*!
 761  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_FOLD
 762  * \li Action: Fold a Math Macro.
 763  * \li Notion: Fold the Math Macro the cursor is in if it was
 764                unfolded, i.e. displayed as \foo before.
 765  * \li Syntax: math-macro-fold
 766  * \li Origin: sts, 06 January 2008
 767  * \endvar
 768  */
 769                 { LFUN_MATH_MACRO_FOLD, "math-macro-fold", ReadOnly | SingleParUpdate, Math },
 770 /*!
 771  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_PARAM
 772  * \li Action: Add a parameter.
 773  * \li Notion: Add a parameter to a Math Macro.
 774  * \li Params: <NUM>: The number of the parameter behind which the new one
 775                will be added (1 for the first, i.e. use 0 for add a
 776                parameter at the left), defaults to the last one.
 777  * \li Syntax: math-macro-add-param <NUM>
 778  * \li Origin: sts, 06 January 2008
 779  * \endvar
 780  */
 781                 { LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param", Noop, Math },
 782 /*!
 783  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_PARAM
 784  * \li Action: Remove the last parameter.
 785  * \li Notion: Remove the last parameter of a Math Macro and
 786                remove its value in all instances of the macro
 787                in the buffer.
 788  * \li Params: <NUM>: The number of the parameter to be deleted (1 for
 789                the first), defaults to the last one.
 790  * \li Syntax: math-macro-remove-param <NUM>
 791  * \li Origin: sts, 06 January 2008
 792  * \endvar
 793  */
 794                 { LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param", Noop, Math },
 795 /*!
 796  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
 797  * \li Action: Append a greedy parameter.
 798  * \li Notion: Append a greedy parameter to a Math Macro which
 799                eats the following mathed cell in every instance of
 800                the macro in the buffer.
 801  * \li Syntax: math-macro-append-greedy-param
 802  * \li Origin: sts, 06 January 2008
 803  * \endvar
 804  */
 805                 { LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param", Noop, Math },
 806 /*!
 807  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
 808  * \li Action: Remove a greedy parameter.
 809  * \li Notion: Remove a greedy parameter of a Math Macro and spit
 810                out the values of it in every instance of the macro
 811                in the buffer. If it is an optional parameter the [valud]
 812                format is used.
 813  * \li Syntax: math-macro-remove-greedy-param
 814  * \li Origin: sts, 06 January 2008
 815  * \endvar
 816  */
 817                 { LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param", Noop, Math },
 818 /*!
 819  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_OPTIONAL
 820  * \li Action: Make a parameter optional.
 821  * \li Notion: Turn the first non-optional parameter of a Math Macro
 822                into an optional parameter with a default value.
 823  * \li Syntax: math-macro-make-optional
 824  * \li Origin: sts, 06 January 2008
 825  * \endvar
 826  */
 827                 { LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional", Noop, Math },
 828 /*!
 829  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_MAKE_NONOPTIONAL
 830  * \li Action: Make a parameter non-optional.
 831  * \li Notion: Turn the last optional parameter of a Math Macro
 832                into a non-optional parameter. The default value is
 833                remembered to be reused later if the user changes his mind.
 834  * \li Syntax: math-macro-make-nonoptional
 835  * \li Origin: sts, 06 January 2008
 836  * \endvar
 837  */
 838                 { LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional", Noop, Math },
 839 /*!
 840  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
 841  * \li Action: Add an optional parameter.
 842  * \li Notion: Insert an optional parameter just behind the
 843                already existing optional parameters.
 844  * \li Syntax: math-macro-add-optional-param
 845  * \li Origin: sts, 06 January 2008
 846  * \endvar
 847  */
 848                 { LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param", Noop, Math },
 849 /*!
 850  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
 851  * \li Action: Remove the last optional parameter.
 852  * \li Notion: Remove the last optional parameter of a Math Macro and
 853                remove it in all the instances of the macro in the buffer.
 854  * \li Syntax: math-macro-remove-optional-param
 855  * \li Origin: sts, 06 January 2008
 856  * \endvar
 857  */
 858                 { LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param", Noop, Math },
 859 /*!
 860  * \var lyx::FuncCode lyx::LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
 861  * \li Action: Add a greedy optional parameter.
 862  * \li Notion: Add a greedy optional parameter which eats the value
 863                from the following cells in mathed which are in the [value]
 864                format.
 865  * \li Syntax: math-macro-add-greedy-optional-param
 866  * \li Origin: sts, 06 January 2008
 867  * \endvar
 868  */
 869                 { LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param", Noop, Math },
 870 /*!
 871  * \var lyx::FuncCode lyx::LFUN_IN_MATHMACROTEMPLATE
 872  * \li Action: Only active in Math Macro definition.
 873  * \li Notion: Dummy function which is only active in a Math Macro definition.
 874                It's used to toggle the Math Macro toolbar if the cursor moves
 875                into a Math Macro definition.
 876  * \li Syntax: in-mathmacrotemplate
 877  * \li Origin: sts, 06 January 2008
 878  * \endvar
 879  */
 880                 { LFUN_IN_MATHMACROTEMPLATE, "in-mathmacrotemplate", Noop, Math },
 881
 882 /*!
 883  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_DOWN
 884  * \li Action: Moves the current paragraph downwards in the document.
 885  * \li Syntax: paragraph-move-down
 886  * \li Origin: Edwin, 8 Apr 2006
 887  * \endvar
 888  */
 889                 { LFUN_PARAGRAPH_MOVE_DOWN, "paragraph-move-down", Noop, Edit },
 890 /*!
 891  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_MOVE_UP
 892  * \li Action: Moves the current paragraph upwards in the document.
 893  * \li Syntax: paragraph-move-up
 894  * \li Origin: Edwin, 8 Apr 2006
 895  * \endvar
 896  */
 897                 { LFUN_PARAGRAPH_MOVE_UP, "paragraph-move-up", Noop, Edit },
 898
 899                 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", Noop, Edit },
 900                 { LFUN_PARAGRAPH_UP, "paragraph-up", ReadOnly | NoUpdate, Edit },
 901                 { LFUN_PARAGRAPH_UP_SELECT, "paragraph-up-select", ReadOnly, Edit },
 902                 { LFUN_PARAGRAPH_DOWN, "paragraph-down", ReadOnly | NoUpdate, Edit },
 903                 { LFUN_PARAGRAPH_DOWN_SELECT, "paragraph-down-select", ReadOnly, Edit },
 904 /*!
 905  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_GOTO
 906  * \li Action: Jump to a paragraph given by its id number.
 907  * \li Notion: Note that id number of paragraph is not the sequential number of paragraph
 908                seen on the screen. Moreover the id is unique for all opened buffers (documents).
 909  * \li Syntax: paragraph-goto <PAR_ID_NUMBER>
 910  * \li Origin: Dekel, 26 Aug 2000
 911  * \endvar
 912  */
 913                 { LFUN_PARAGRAPH_GOTO, "paragraph-goto", ReadOnly, Edit },
 914 /*!
 915  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH
 916  * \li Action: Breaks the current paragraph at the current location.
 917  * \li Syntax: break-paragraph
 918  * \endvar
 919  */
 920                 { LFUN_BREAK_PARAGRAPH, "break-paragraph", Noop, Edit },
 921 /*!
 922  * \var lyx::FuncCode lyx::LFUN_BREAK_PARAGRAPH_SKIP
 923  * \li Action: Breaks the current paragraph at the current location,
 924                unless used at the beginning of a line, where it sets
 925                the label width string to empty.
 926  * \li Syntax: break-paragraph-skip
 927  * \endvar
 928  */
 929                 { LFUN_BREAK_PARAGRAPH_SKIP, "break-paragraph-skip", Noop, Edit },
 930 /*!
 931  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS
 932  * \li Action: Change paragraph settings.
 933  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
 934                This function only modifies, and does not override, existing settings.
 935                Note that the "leftindent" indent setting is deprecated.
 936  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
 937  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
 938                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
 939                <ALIGN>:   \\align block|left|right|center|default\n
 940                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
 941  * \li Origin: rgh, Aug 15 2007
 942  * \endvar
 943  */
 944                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
 945 /*!
 946  * \var lyx::FuncCode lyx::LFUN_PARAGRAPH_PARAMS_APPLY
 947  * \li Action: Change paragraph settings.
 948  * \li Notion: Overwrite all nonspecified settings to the default ones.
 949                Use paragraph-params lfun if you don't want to overwrite others settings.
 950  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
 951  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
 952  * \li Origin: leeming, 30 Mar 2004
 953  * \endvar
 954  */
 955                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
 956                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
 957
 958 /*!
 959  * \var lyx::FuncCode lyx::LFUN_OUTLINE_UP
 960  * \li Action: Move the current group in the upward direction in the
 961                structure of the document.
 962  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
 963                the whole substructure of the group.
 964  * \li Syntax: outline-up
 965  * \li Origin: Vermeer, 23 Mar 2006
 966  * \endvar
 967  */
 968                 { LFUN_OUTLINE_UP, "outline-up", Noop, Edit },
 969 /*!
 970  * \var lyx::FuncCode lyx::LFUN_OUTLINE_DOWN
 971  * \li Action: Move the current group in the downward direction in the
 972                structure of the document.
 973  * \li Notion: The "group" can be Part/Chapter/Section/etc. It moves
 974                the whole substructure of the group.
 975  * \li Syntax: outline-down
 976  * \li Origin: Vermeer, 23 Mar 2006
 977  * \endvar
 978  */
 979                 { LFUN_OUTLINE_DOWN, "outline-down", Noop, Edit },
 980 /*!
 981  * \var lyx::FuncCode lyx::LFUN_OUTLINE_IN
 982  * \li Action: Moves the current group in the downward direction in the
 983                hierarchy of the document structure.
 984  * \li Notion: Part -> Chapter -> Section -> etc.
 985  * \li Syntax: outline-in
 986  * \li Origin: Vermeer, 23 Mar 2006
 987  * \endvar
 988  */
 989                 { LFUN_OUTLINE_IN, "outline-in", Noop, Edit },
 990 /*!
 991  * \var lyx::FuncCode lyx::LFUN_OUTLINE_OUT
 992  * \li Action: Moves the current group in the upward direction in the
 993                hierarchy of the document structure.
 994  * \li Notion: Part <- Chapter <- Section <- etc.
 995  * \li Syntax: outline-out
 996  * \li Origin: Vermeer, 23 Mar 2006
 997  * \endvar
 998  */
 999                 { LFUN_OUTLINE_OUT, "outline-out", Noop, Edit },
1000
1001                 { LFUN_EXTERNAL_EDIT, "external-edit", Noop, Edit },
1002                 { LFUN_GRAPHICS_EDIT, "graphics-edit", Noop, Edit },
1003
1004                 { LFUN_CELL_BACKWARD, "cell-backward", Noop, Edit },
1005                 { LFUN_CELL_FORWARD, "cell-forward", Noop, Edit },
1006                 { LFUN_CELL_SPLIT, "cell-split", Noop, Edit },
1007                 { LFUN_TABULAR_INSERT, "tabular-insert", Noop, Edit },
1008                 { LFUN_TABULAR_FEATURE, "tabular-feature", Noop, Edit },
1009
1010                 { LFUN_VC_CHECK_IN, "vc-check-in", ReadOnly, System },
1011                 { LFUN_VC_CHECK_OUT, "vc-check-out", ReadOnly, System },
1012                 { LFUN_VC_REGISTER, "vc-register", ReadOnly, System },
1013                 { LFUN_VC_REVERT, "vc-revert", ReadOnly, System },
1014                 { LFUN_VC_UNDO_LAST, "vc-undo-last", ReadOnly, System },
1015
1016                 { LFUN_CHANGES_TRACK, "changes-track", Noop, Edit },
1017                 { LFUN_CHANGES_OUTPUT, "changes-output", Noop, Edit },
1018                 { LFUN_CHANGE_NEXT, "change-next", ReadOnly, Edit },
1019                 { LFUN_CHANGES_MERGE, "changes-merge", Noop, Edit },
1020                 { LFUN_CHANGE_ACCEPT, "change-accept", Noop, Edit },
1021                 { LFUN_CHANGE_REJECT, "change-reject", Noop, Edit },
1022                 { LFUN_ALL_CHANGES_ACCEPT, "all-changes-accept", Noop, Edit },
1023                 { LFUN_ALL_CHANGES_REJECT, "all-changes-reject", Noop, Edit },
1024
1025 /*!
1026  * \var lyx::FuncCode lyx::LFUN_INSET_APPLY
1027  * \li Action: Apply data for an inset.
1028  * \li Notion: LFUN_INSET_APPLY is sent from the dialogs when the data should
1029                be applied. This is either changed to #LFUN_INSET_MODIFY or
1030                #LFUN_INSET_INSERT depending on the context where it is called.
1031  * \li Syntax: inset-apply <ARGS>
1032  * \li Params: See #LFUN_INSET_INSERT .
1033  * \endvar
1034  */
1035                 { LFUN_INSET_APPLY, "inset-apply", Noop, Edit },
1036                 { LFUN_INSET_DISSOLVE, "inset-dissolve", Noop, Edit },
1037 /*!
1038  * \var lyx::FuncCode lyx::LFUN_INSET_INSERT
1039  * \li Action: Insert new inset (type given by the parameters).
1040  * \li Syntax: inset-insert <INSET> <ARGS>
1041  * \li Params: <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics|
1042                          hyperlink|include|index|label|nomencl|vspace|ref|toc>\n
1043                <ARGS>: depends on the given inset. Use "lyx -dbg action" to
1044                        explore.
1045  * \li Sample: inset-insert ref LatexCommand <Format> reference "<label name>"\end_inset \n
1046                where <label name> is the name of the referenced label and
1047                <Format> is one of the following: \n
1048                ref -- <reference> \n
1049                eqref -- (<reference>) \n
1050                pageref -- <page> \n
1051                vpageref -- on <page> \n
1052                vref -- <reference> on <page> \n
1053                prettyref -- Formatted reference
1054  * \endvar
1055  */
1056                 { LFUN_INSET_INSERT, "inset-insert", Noop, Edit },
1057 /*!
1058  * \var lyx::FuncCode lyx::LFUN_INSET_MODIFY
1059  * \li Action: Modify existing inset.
1060  * \li Notion: Used for label, floats, listings, box, branch, external, wrap
1061                bibtex, ert, command, grahocs, note, vspace, tabular, bibitem,
1062                inlude, ref insets.
1063  * \li Syntax: inset-modify <INSET> <ARGS>
1064  * \li Params: See #LFUN_INSET_INSERT for further details.
1065  * \endvar
1066  */
1067                 { LFUN_INSET_MODIFY, "", Noop, Hidden },
1068                 { LFUN_INSET_DIALOG_UPDATE, "", Noop, Hidden },
1069                 { LFUN_INSET_SETTINGS, "inset-settings", ReadOnly, Edit },
1070                 { LFUN_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1071                 { LFUN_INSET_TOGGLE, "", ReadOnly, Hidden },
1072                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1073
1074 /*!
1075  * \var lyx::FuncCode lyx::LFUN_FINISHED_FORWARD
1076  * \li Action: Moves the cursor out of the current slice, going forward.
1077  * \li Notion: Cursor movement within an inset may be different than cursor
1078                movement in the surrounding text. This action should be called
1079                automatically by the cursor movement within the inset, when
1080                movement within the inset has ceased (reached the end of the
1081                last paragraph, for example), in order to move correctly
1082                back into the surrounding text.
1083  * \endvar
1084  */
1085                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1086 /*!
1087  * \var lyx::FuncCode lyx::LFUN_FINISHED_BACKWARD
1088  * \li Action: Moves the cursor out of the current slice, going backwards.
1089  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1090  * \endvar
1091  */
1092                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1093 /*!
1094  * \var lyx::FuncCode lyx::LFUN_FINISHED_RIGHT
1095  * \li Action: Moves the cursor out of the current slice, going right.
1096  * \li Notion: See also #LFUN_FINISHED_FORWARD
1097  * \endvar
1098  */
1099                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1100 /*!
1101  * \var lyx::FuncCode lyx::LFUN_FINISHED_LEFT
1102  * \li Action: Moves the cursor out of the current slice, going left.
1103  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1104  * \endvar
1105  */
1106                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1107
1108                 { LFUN_LANGUAGE, "language", Noop, Edit },
1109
1110 /*!
1111  * \var lyx::FuncCode lyx::LFUN_LABEL_GOTO
1112  * \li Action: Goto a label.
1113  * \li Syntax: label-goto [<LABEL>]
1114  * \li Params: <LABEL>: Requested label. If no label is given and refernce
1115                         is on cursor position, Bookmark 0 is saved and
1116                         cursor moves to the position of referenced label.
1117  * \li Origin: Ale, 6 Aug 1997
1118  * \endvar
1119  */
1120                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1121                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1122 /*!
1123  * \var lyx::FuncCode lyx::LFUN_REFERENCE_NEXT
1124  * \li Action: Go to the next label or cross-reference.
1125  * \li Syntax: reference-next
1126  * \li Origin: Dekel, 14 Jan 2001
1127  * \endvar
1128  */
1129                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1130
1131 /*!
1132  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_GOTO
1133  * \li Action: Goto a bookmark.
1134  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1135                if necessary. Note that bookmarsk are saved per-session, not
1136                per file.
1137  * \li Syntax: bookmark-goto <NUMBER>
1138  * \li Params: <NUMBER>: the number of the bookmark to restore.
1139  * \li Origin: Dekel, 27 January 2001
1140  * \endvar
1141  */
1142                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1143 /*!
1144  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_SAVE
1145  * \li Action: Save a bookmark.
1146  * \li Notion: Saves a numbered bookmark to the sessions file. The number
1147                must be between 1 and 9, inclusive. Note that bookmarks are
1148                saved per-session, not per file.
1149  * \li Syntax: bookmark-save <NUMBER>
1150  * \li Params: <NUMBER>: the number of the bookmark to save.
1151  * \li Origin: Dekel, 27 January 2001
1152  * \endvar
1153  */
1154                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1155 /*!
1156  * \var lyx::FuncCode lyx::LFUN_BOOKMARK_CLEAR
1157  * \li Action: Clears the list of saved bookmarks.
1158  * \li Syntax: bookmark-clear
1159  * \li Origin: bpeng, 31 October 2006
1160  * \endvar
1161  */
1162                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1163
1164                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1165 /*!
1166  * \var lyx::FuncCode lyx::LFUN_LYX_QUIT
1167  * \li Action: Terminates the current LyX instance.
1168  * \li Notion: Terminates the current LyX instance, asking whether to save
1169                modified documents, etc.
1170  * \li Syntax: lyx-quit
1171  * \endvar
1172  */
1173                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1174 /*!
1175  * \var lyx::FuncCode lyx::LFUN_TOOLBAR_TOGGLE
1176  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1177  * \li Notion: Skiping "auto" when allowauto is false.
1178  * \li Syntax: toolbar-toggle <NAME> [allowauto]
1179  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1180                        minibuffer|review|view/update|math_panels
1181  * \li Origin: Edwin, 21 May 2007
1182  * \endvar
1183  */
1184                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1185                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1186 /*!
1187  * \var lyx::FuncCode lyx::LFUN_UI_TOGGLE
1188  * \li Action: Various UI visibility-toggling actions.
1189  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1190  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
1191                menubar    : Toggle visibility of the menubar.\n
1192                scrollbar  : Toggle visibility of the scrollbar.\n
1193                frame      : Toggle visibility of the frames around editing window.\n
1194                fullscreen : Toggle fullscreen mode. This also covers calling the
1195                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1196                             custom tweaks of the toolbars should be used.
1197  * \li Origin: ps, 9 Feb 2007
1198  * \endvar
1199  */
1200                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1201
1202                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1203                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1204
1205 /*!
1206  * \var lyx::FuncCode lyx::LFUN_SPLIT_VIEW
1207  * \li Action: Creates another split view of current buffer.
1208  * \li Notion: All split views act in the same way indpendently.
1209  * \li Syntax: split-view <vertical|horizontal>
1210  * \li Params: horizontal : The work areas are laid out side by side.\n
1211                vertical   : The work areas laid out vertically.\n
1212  * \li Origin: abdel, 20 Feb 2008
1213  * \endvar
1214  */
1215                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1216
1217 /*!
1218  * \var lyx::FuncCode lyx::LFUN_CLOSE_TAB_GROUP
1219  * \li Action: Close the current tab group.
1220  * \li Notion: This only closes the work areas, not the buffer themselves.
1221                The still opened buffers can be visualized in another tab group.
1222  * \li Syntax: close-tab-group
1223  * \li Origin: abdel, 21 Feb 2008
1224  * \endvar
1225  */
1226                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1227                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1228                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1229                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1230                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1231                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1232                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1233
1234                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1235                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1236                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1237                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1238                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1239
1240                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1241                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1242                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1243                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1244
1245                 { LFUN_MESSAGE, "message", NoBuffer, System },
1246                 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1247                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1248
1249                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1250                 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1251                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1252                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1253                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1254 /*!
1255  * \var lyx::FuncCode lyx::LFUN_SERVER_GOTO_FILE_ROW
1256  * \li Action: Sets the cursor position based on the row number of generated TeX file.
1257  * \li Syntax: server-goto-file-row <LYX_FILE_NAME> <ROW_NUMBER>
1258  * \li Origin: Edmar, 23 Dec 1998
1259  * \endvar
1260  */
1261                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1262                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1263                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1264
1265                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1266
1267 /*!
1268  * \var lyx::FuncCode lyx::LFUN_BUFFER_AUTO_SAVE
1269  * \li Action: Saves the current buffer to a temporary file.
1270  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1271                is called automatically by LyX, to "autosave" the current buffer.
1272         * \li Syntax: buffer-auto-save
1273  * \endvar
1274  */
1275                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1276                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1277                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1278                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1279                 { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
1280 /*!
1281  * \var lyx::FuncCode lyx::LFUN_BUFFER_CLOSE
1282  * \li Action: Closes the current buffer.
1283  * \li Notion: Closes the current buffer, asking whether to save it, etc,
1284                if the buffer has been modified.
1285  * \li Syntax: buffer-close
1286  * \endvar
1287  */
1288                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1289 /*!
1290  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT
1291  * \li Action: Exports the current buffer (document) to the given format.
1292  * \li Syntax: buffer-export <FORMAT>
1293  * \li Params: <FORMAT> is either "custom" or one of the formats which you
1294                         can find in Tools->Preferences->File formats->Format.
1295                         Usual format you will enter is "pdf2" (pdflatex),
1296                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1297                         In case of "custom" you will be asked for a format you
1298                         want to start from and for the command that you want to
1299                         apply to this format. Internally the control is then passed
1300                         to #LFUN_BUFFER_EXPORT_CUSTOM.
1301  * \li Origin: Lgb, 29 Jul 1997
1302  * \endvar
1303  */
1304                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1305 /*!
1306  * \var lyx::FuncCode lyx::LFUN_BUFFER_EXPORT_CUSTOM
1307  * \li Action: Exports the current buffer (document) from the given format using
1308                the given command on it.
1309  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1310  * \li Params: <FORMAT> format to start from (LyX will care to produce such
1311                         intermediate file).\n
1312                <COMMAND> this command will be launched on the file. Note that you can
1313                use "$$FName" string to qualify the intermediate file.
1314  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1315  * \li Origin: leeming, 27 Mar 2004
1316  * \endvar
1317  */
1318                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1319 /*!
1320  * \var lyx::FuncCode lyx::LFUN_BUFFER_PRINT
1321  * \li Action: Prints the current document.
1322  * \li Notion: Many settings can be given via the preferences dialog.
1323  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1324  * \li Params: <TARGET> is either "printer" or "file".\n
1325                <TARGER-NAME> is either "default" or file name or printer name.\n
1326                <COMMAND> command ensuring the printing job.
1327  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1328  * \li Origin: leeming, 28 Mar 2004
1329  * \endvar
1330  */
1331                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1332 /*!
1333  * \var lyx::FuncCode lyx::LFUN_BUFFER_IMPORT
1334  * \li Action: Import a given file as a lyx document.
1335  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1336                defined convertors in preferences. Look into File->Import menu to get
1337                an idea of the currently active import formats.
1338  * \li Syntax: buffer-import <FORMAT> [<FILE>]
1339  * \li Origin: Asger, 24 Jul 1998
1340  * \endvar
1341  */
1342                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1343 /*!
1344  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW
1345  * \li Action: Creates a new buffer (that is, document).
1346  * \li Notion: Implicit path can be set in Preferences dialog.
1347  * \li Syntax: buffer-new [<FILE>]
1348  * \li Params: <FILE>: filename of created file with absolute path.
1349  * \endvar
1350  */
1351                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1352 /*!
1353  * \var lyx::FuncCode lyx::LFUN_BUFFER_NEW_TEMPLATE
1354  * \li Action: Creates a new buffer (that is, document) from a template.
1355  * \li Notion: Path for new files and templates can be set in Preferences dialog.
1356                Template will be asked for via Open-dialog.
1357  * \li Syntax: buffer-new-template [<FILE>]
1358  * \li Params: <FILE>: filename of created file with absolute path.
1359  * \endvar
1360  */
1361                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1362 /*!
1363  * \var lyx::FuncCode lyx::LFUN_BUFFER_RELOAD
1364  * \li Action: Reverts opened document.
1365  * \li Syntax: buffer-reload
1366  * \li Origin: Asger, 2 Feb 1997
1367  * \endvar
1368  */
1369                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1370 /*!
1371  * \var lyx::FuncCode lyx::LFUN_BUFFER_SWITCH
1372  * \li Action: Switch to the given buffer.
1373  * \li Notion: This is useful also in case you need simultaneously more views of the edited
1374                document in different LyX windows.
1375  * \li Syntax: buffer-new-template <BUFFER>
1376  * \li Params: <BUFFER>: already opened document which is to be shown.
1377  * \endvar
1378  */
1379                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1380 /*!
1381  * \var lyx::FuncCode lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1382  * \li Action: Toggle editing mode of the current document between read/write and read-only.
1383  * \li Syntax: buffer-toggle-read-only
1384  * \li Origin: Lgb, 27 May 1997
1385  * \endvar
1386  */
1387                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1388 /*!
1389  * \var lyx::FuncCode lyx::LFUN_BUFFER_VIEW
1390  * \li Action: Displays current buffer in chosen format.
1391  * \li Notion: Displays the contents of the current buffer in the chosen
1392                format, for example, PDF or DVI. This runs the necessary
1393                converter, calls the defined viewer, and so forth.
1394  * \li Syntax: buffer-view <FORMAT>
1395  * \li Params: <FORMAT>: The format to display, where this is one of the
1396                          formats defined (in the current GUI) in the
1397                          Tools>Preferences>File Formats dialog.
1398  * \endvar
1399  */
1400                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1401 /*!
1402  * \var lyx::FuncCode lyx::LFUN_BUFFER_UPDATE
1403  * \li Action: Exports the current document and put the result into the
1404                temporary directory.
1405  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1406                the output will be rewriten - updated. This is useful in case your viewer
1407                is able to detect such changes (e.g. ghostview for postscript).
1408  * \li Syntax: buffer-update <FORMAT>
1409  * \li Params: <FORMAT>: The format to display, where this is one of the
1410                          formats defined (in the current GUI) in the
1411                          Tools>Preferences>File Formats dialog.
1412  * \li Origin: Dekel, 5 Aug 2000
1413  * \endvar
1414  */
1415                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1416
1417 /*!
1418  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE
1419  * \li Action: Saves the current buffer.
1420  * \li Notion: Saves the current buffer to disk, using the filename that
1421                is already associated with the buffer, asking for one if
1422                none is yet assigned.
1423  * \li Syntax: buffer-write
1424  * \endvar
1425  */
1426                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1427 /*!
1428  * \var lyx::FuncCode lyx::LFUN_BUFFER_WRITE_AS
1429  * \li Action: Rename and save current buffer.
1430  * \li Syntax: buffer-write-as <FILENAME>
1431  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1432                is with respect to the original location of the buffer/file.
1433  * \endvar
1434  */
1435                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1436                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1437                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1438                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1439                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1440                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1441                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1442                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1443                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1444
1445 /*!
1446  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT
1447  * \li Action: Inserts another LyX file.
1448  * \li Syntax: file-insert [<FILE>]
1449  * \li Params: <FILE>: Filename to be inserted.
1450  * \endvar
1451  */
1452                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1453 /*!
1454  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT
1455  * \li Action: Inserts plain text file.
1456  * \li Syntax: file-insert-plaintext [<FILE>]
1457  * \li Params: <FILE>: Filename to be inserted.
1458  * \li Origin: CFO-G, 19 Nov 1997
1459  * \endvar
1460  */
1461                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1462 /*!
1463  * \var lyx::FuncCode lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1464  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1465  * \li Syntax: file-insert-plaintext-para [<FILE>]
1466  * \li Params: <FILE>: Filename to be inserted.
1467  * \li Origin: Levon, 14 Feb 2001
1468  * \endvar
1469  */
1470                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1471 /*!
1472  * \var lyx::FuncCode lyx::LFUN_FILE_OPEN
1473  * \li Action: Open LyX document.
1474  * \li Syntax: file-open [<FILE>]
1475  * \li Params: <FILE>: Filename to be opened.
1476  * \endvar
1477  */
1478                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1479
1480 /*!
1481  * \var lyx::FuncCode lyx::LFUN_CALL
1482  * \li Action: Executes a command defined in a .def file.
1483  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1484                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1485                where <NAME> is the name of the new command and <LFUN> is the lfun code
1486                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1487                \\def_file "FileName" allows to include another .def file. \n
1488                This is particularly useful in connection with toolbar buttons:
1489                Since the name of the button image for this lfun is
1490                lib/images/commands/<NAME>.png this is the way to assign an image
1491                to a complex command-sequence.
1492  * \li Syntax: call <NAME>
1493  * \li Params: <NAME>: Name of the command that must be called.
1494  * \li Origin: broider, 2 Oct 2007
1495  * \endvar
1496  */
1497                 { LFUN_CALL, "call", NoBuffer, System },
1498 /*!
1499  * \var lyx::FuncCode lyx::LFUN_META_PREFIX
1500  * \li Action: Simulate halting Meta key (Alt key on PCs).
1501  * \li Notion: Used for buffer editation not for GUI control.
1502  * \li Syntax: meta-prefix
1503  * \endvar
1504  */
1505                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1506 /*!
1507  * \var lyx::FuncCode lyx::LFUN_CANCEL
1508  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1509  * \li Syntax: cancel
1510  * \endvar
1511  */
1512                 { LFUN_CANCEL, "cancel", NoBuffer, System },
1513
1514 /*!
1515  * \var lyx::FuncCode lyx::LFUN_COMMAND_EXECUTE
1516  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1517  * \li Notion: Usually bound to M-x shortcut.
1518  * \li Syntax: command-execute
1519  * \endvar
1520  */
1521                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1522                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1523 /*!
1524  * \var lyx::FuncCode lyx::LFUN_COMMAND_SEQUENCE
1525  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1526  * \li Syntax: command-sequence <CMDS>
1527  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1528  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1529  * \li Origin: Andre', 11 Nov 1999
1530  * \endvar
1531  */
1532                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1533
1534 /*!
1535  * \var lyx::FuncCode lyx::LFUN_PREFERENCES_SAVE
1536  * \li Action: Save user preferences.
1537  * \li Syntax: preferences-save
1538  * \li Origin: Lgb, 27 Nov 1999
1539  * \endvar
1540  */
1541                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1542 /*!
1543  * \var lyx::FuncCode lyx::LFUN_RECONFIGURE
1544  * \li Action: Reconfigure the automatic settings.
1545  * \li Syntax: reconfigure
1546  * \li Origin: Asger, 14 Feb 1997
1547  * \endvar
1548  */
1549                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1550 /*!
1551  * \var lyx::FuncCode lyx::LFUN_LYXRC_APPLY
1552  * \li Action: Apply the given settings to user preferences.
1553  * \li Syntax: lyxrc-apply <SETTINGS>
1554  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1555                            to get an idea which commands to use and their syntax.
1556                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
1557  * \endvar
1558  */
1559                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1560 /*!
1561  * \var lyx::FuncCode lyx::LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
1562  * \li Action: Determine whether keep cursor inside the editing window regardless
1563                the scrollbar movement.
1564  * \li Syntax: toggle-cursor-follows-scrollbar
1565  * \li Origin: ARRae, 2 Dec 1997
1566  * \endvar
1567  */
1568                 { LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, "cursor-follows-scrollbar-toggle", ReadOnly, System },
1569 /*!
1570  * \var lyx::FuncCode lyx::LFUN_SET_COLOR
1571  * \li Action: Set the given LyX color to the color defined by the X11 name given.
1572  * \li Notion: A new color entry is created if the color is unknown.
1573                Color names can be stored as a part of user settings.
1574  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1575  * \li Origin: SLior, 11 Jun 2000
1576  * \endvar
1577  */
1578                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1579 /*!
1580  * \var lyx::FuncCode lyx::LFUN_STATISTICS
1581  * \li Action: Count the statistics (number of words and characters)
1582                in the document or in the given selection.
1583  * \li Notion: Note that this function gives the number of words/chars written,
1584                not the number of characters which will be typeset.
1585  * \li Syntax: statistics
1586  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1587  * \endvar
1588  */
1589                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1590 /*!
1591  * \var lyx::FuncCode lyx::LFUN_COMPLETION_INLINE
1592  * \li Action: Show the inline completion at the cursor position.
1593  * \li Syntax: completion-inline
1594  * \li Origin: sts, Feb 19 2008
1595  * \endvar
1596  */
1597                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1598 /*!
1599  * \var lyx::FuncCode lyx::LFUN_COMPLETION_POPUP
1600  * \li Action: Show the completion popup at the cursor position.
1601  * \li Syntax: completion-popup
1602  * \li Origin: sts, Feb 19 2008
1603  * \endvar
1604  */
1605                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1606 /*!
1607  * \var lyx::FuncCode lyx::LFUN_COMPLETION_COMPLETE
1608  * \li Action: Try to complete the word or command at the cursor position.
1609  * \li Syntax: completion-complete
1610  * \li Origin: sts, Feb 19 2008
1611  * \endvar
1612  */
1613                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1614
1615                 { LFUN_NOACTION, "", Noop, Hidden }
1616 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1617         };
1618
1619         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1620                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1621         }
1622
1623         init = true;
1624 }
1625 #endif
1626
1627 LyXAction::LyXAction()
1628 {
1629         init();
1630 }
1631
1632
1633 // Returns an action tag from a string.
1634 FuncRequest LyXAction::lookupFunc(string const & func) const
1635 {
1636         string const func2 = trim(func);
1637
1638         if (func2.empty()) {
1639                 return FuncRequest(LFUN_NOACTION);
1640         }
1641
1642         string cmd;
1643         string const arg = split(func2, cmd, ' ');
1644
1645         func_map::const_iterator fit = lyx_func_map.find(cmd);
1646
1647         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1648 }
1649
1650
1651 string const LyXAction::getActionName(FuncCode action) const
1652 {
1653         info_map::const_iterator const it = lyx_info_map.find(action);
1654         return it != lyx_info_map.end() ? it->second.name : string();
1655 }
1656
1657
1658 LyXAction::func_type const LyXAction::getActionType(FuncCode action) const
1659 {
1660         info_map::const_iterator const it = lyx_info_map.find(action);
1661         return it != lyx_info_map.end() ? it->second.type : Hidden;
1662 }
1663
1664
1665 bool LyXAction::funcHasFlag(FuncCode action,
1666                             LyXAction::func_attrib flag) const
1667 {
1668         info_map::const_iterator ici = lyx_info_map.find(action);
1669
1670         if (ici == lyx_info_map.end()) {
1671                 LYXERR0("action: " << action << " is not known.");
1672                 BOOST_ASSERT(false);
1673         }
1674
1675         return ici->second.attrib & flag;
1676 }
1677
1678
1679 LyXAction::const_func_iterator LyXAction::func_begin() const
1680 {
1681         return lyx_func_map.begin();
1682 }
1683
1684
1685 LyXAction::const_func_iterator LyXAction::func_end() const
1686 {
1687         return lyx_func_map.end();
1688 }
1689
1690
1691 } // namespace lyx