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