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