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