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_NEXT_INSET_TOGGLE, "next-inset-toggle", ReadOnly, Edit },
1032                 { LFUN_INSET_TOGGLE, "", ReadOnly, Hidden },
1033                 { LFUN_ALL_INSETS_TOGGLE, "all-insets-toggle", ReadOnly, Edit },
1034
1035 /*!
1036  * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS
1037  * \li Action: Change paragraph settings.
1038  * \li Notion: Modifies the current paragraph, or currently selected paragraphs.
1039                This function only modifies, and does not override, existing settings.
1040                Note that the "leftindent" indent setting is deprecated.
1041  * \li Syntax: paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
1042  * \li Params: <INDENT>:  \\noindent|\\indent|\\indent-toggle|\\leftindent LENGTH\n
1043                <SPACING>: \\paragraph_spacing default|single|onehalf|double|other\n
1044                <ALIGN>:   \\align block|left|right|center|default\n
1045                <OTHERS>:  \\labelwidthstring WIDTH|\\start_of_appendix\n
1046  * \li Origin: rgh, Aug 15 2007
1047  * \endvar
1048  */
1049                 { LFUN_PARAGRAPH_PARAMS, "paragraph-params", Noop, Edit },
1050 /*!
1051  * \var lyx::kb_action lyx::LFUN_PARAGRAPH_PARAMS_APPLY
1052  * \li Action: Change paragraph settings.
1053  * \li Notion: Overwrite all nonspecified settings to the default ones.
1054                Use paragraph-params lfun if you don't want to overwrite others settings.
1055  * \li Syntax: paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
1056  * \li Params: For parameters see #LFUN_PARAGRAPH_PARAMS
1057  * \li Origin: leeming, 30 Mar 2004
1058  * \endvar
1059  */
1060                 { LFUN_PARAGRAPH_PARAMS_APPLY, "paragraph-params-apply", Noop, Edit },
1061                 { LFUN_PARAGRAPH_UPDATE, "", Noop, Hidden },
1062
1063 /*!
1064  * \var lyx::kb_action lyx::LFUN_FINISHED_FORWARD
1065  * \li Action: Moves the cursor out of the current slice, going forward.
1066  * \li Notion: Cursor movement within an inset may be different than cursor
1067                movement in the surrounding text. This action should be called
1068                automatically by the cursor movement within the inset, when
1069                movement within the inset has ceased (reached the end of the
1070                last paragraph, for example), in order to move correctly
1071                back into the surrounding text.
1072  * \li Syntax: finished-forward
1073  * \endvar
1074  */
1075                 { LFUN_FINISHED_FORWARD, "", ReadOnly, Hidden },
1076 /*!
1077  * \var lyx::kb_action lyx::LFUN_FINISHED_BACKWARD
1078  * \li Action: Moves the cursor out of the current slice, going backwards.
1079  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1080  * \li Syntax: finished-backward
1081  * \endvar
1082  */
1083                 { LFUN_FINISHED_BACKWARD, "", ReadOnly, Hidden },
1084 /*!
1085  * \var lyx::kb_action lyx::LFUN_FINISHED_RIGHT
1086  * \li Action: Moves the cursor out of the current slice, going right.
1087  * \li Notion: See also #LFUN_FINISHED_FORWARD
1088  * \li Syntax: finished-right
1089  * \endvar
1090  */
1091                 { LFUN_FINISHED_RIGHT, "", ReadOnly, Hidden },
1092 /*!
1093  * \var lyx::kb_action lyx::LFUN_FINISHED_LEFT
1094  * \li Action: Moves the cursor out of the current slice, going left.
1095  * \li Notion: See also #LFUN_FINISHED_FORWARD.
1096  * \li Syntax: finished-left
1097  * \endvar
1098  */
1099                 { LFUN_FINISHED_LEFT, "", ReadOnly, Hidden },
1100
1101                 { LFUN_LANGUAGE, "language", Noop, Edit },
1102
1103                 { LFUN_LABEL_GOTO, "label-goto", ReadOnly, Edit },
1104                 { LFUN_LABEL_INSERT, "label-insert", Noop, Edit },
1105                 { LFUN_REFERENCE_NEXT, "reference-next", ReadOnly, Edit },
1106
1107 /*!
1108  * \var lyx::kb_action lyx::LFUN_BOOKMARK_GOTO
1109  * \li Action: Goto a bookmark.
1110  * \li Notion: Moves the cursor to the numbered bookmark, opening the file
1111                if necessary. Note that bookmarsk are saved per-session, not
1112                per file.
1113  * \li Syntax: bookmark-goto <NUMBER>
1114  * \li Params: <NUMBER>: the number of the bookmark to restore.
1115  * \li Origin: Dekel, 27 January 2001
1116  * \endvar
1117  */
1118                 { LFUN_BOOKMARK_GOTO, "bookmark-goto", NoBuffer, Edit },
1119 /*!
1120  * \var lyx::kb_action lyx::LFUN_BOOKMARK_SAVE
1121  * \li Action: Save a bookmark.
1122  * \li Notion: Saves a numbered bookmark to the sessions file. The number
1123                must be between 1 and 9, inclusive. Note that bookmarks are
1124                saved per-session, not per file.
1125  * \li Syntax: bookmark-save <NUMBER>
1126  * \li Params: <NUMBER>: the number of the bookmark to save.
1127  * \li Origin: Dekel, 27 January 2001
1128  * \endvar
1129  */
1130                 { LFUN_BOOKMARK_SAVE, "bookmark-save", ReadOnly, Edit },
1131 /*!
1132  * \var lyx::kb_action lyx::LFUN_BOOKMARK_CLEAR
1133  * \li Action: Clears the list of saved bookmarks.
1134  * \li Syntax: bookmark-clear
1135  * \li Origin: bpeng, 31 October 2006
1136  * \endvar
1137  */
1138                 { LFUN_BOOKMARK_CLEAR, "bookmark-clear", NoBuffer, Edit },
1139
1140                 { LFUN_HELP_OPEN, "help-open", NoBuffer | Argument, Buffer },
1141 /*!
1142  * \var lyx::kb_action lyx::LFUN_LYX_QUIT
1143  * \li Action: Terminates the current LyX instance.
1144  * \li Notion: Terminates the current LyX instance, asking whether to save
1145                modified documents, etc.
1146  * \li Syntax: lyx-quit
1147  * \endvar
1148  */
1149                 { LFUN_LYX_QUIT, "lyx-quit", NoBuffer, Buffer },
1150 /*!
1151  * \var lyx::kb_action lyx::LFUN_TOOLBAR_TOGGLE
1152  * \li Action: Toggles visibility of a given toolbar between on/off/auto.
1153  * \li Notion: Skiping "auto" when allowauto is false.
1154  * \li Syntax: toolbar-toggle <NAME> [allowauto]
1155  * \li Params: <NAME>: standard|extra|table|math|mathmacrotemplate|
1156                        minibuffer|review|view/update|math_panels
1157  * \li Origin: Edwin, 21 May 2007
1158  * \endvar
1159  */
1160                 { LFUN_TOOLBAR_TOGGLE, "toolbar-toggle", NoBuffer, Buffer },
1161                 { LFUN_MENU_OPEN, "menu-open", NoBuffer, Buffer },
1162 /*!
1163  * \var lyx::kb_action lyx::LFUN_UI_TOGGLE
1164  * \li Action: Various UI visibility-toggling actions.
1165  * \li Syntax: ui-toggle <statusbar|menubar|frame|fullscreen>
1166  * \li Params: statusbar  : Toggle visibility of the statusbar.\n
1167                menubar    : Toggle visibility of the menubar.\n
1168                scrollbar  : Toggle visibility of the scrollbar.\n
1169                frame      : Toggle visibility of the frames around editing window.\n
1170                fullscreen : Toggle fullscreen mode. This also covers calling the
1171                             previous functions. However #LFUN_TOOLBAR_TOGGLE for the
1172                             custom tweaks of the toolbars should be used.
1173  * \li Origin: ps, 9 Feb 2007
1174  * \endvar
1175  */
1176                 { LFUN_UI_TOGGLE, "ui-toggle", NoBuffer, Buffer },
1177
1178                 { LFUN_WINDOW_NEW, "window-new", NoBuffer, Buffer },
1179                 { LFUN_WINDOW_CLOSE, "window-close", NoBuffer, Buffer },
1180
1181 /*!
1182  * \var lyx::kb_action lyx::LFUN_SPLIT_VIEW
1183  * \li Action: Creates another split view of current buffer.
1184  * \li Notion: All split views act in the same way indpendently.
1185  * \li Syntax: split-view <vertical|horizontal>
1186  * \li Params: horizontal : The work areas are laid out side by side.\n
1187                vertical   : The work areas laid out vertically.\n
1188  * \li Origin: abdel, 20 Feb 2008
1189  * \endvar
1190  */
1191                 { LFUN_SPLIT_VIEW, "split-view", ReadOnly, Buffer },
1192
1193 /*!
1194  * \var lyx::kb_action lyx::LFUN_CLOSE_TAB_GROUP
1195  * \li Action: Close the current tab group.
1196  * \li Notion: This only closes the work areas, not the buffer themselves.
1197                The still opened buffers can be visualized in another tab group.
1198  * \li Syntax: close-tab-group
1199  * \li Origin: abdel, 21 Feb 2008
1200  * \endvar
1201  */
1202                 { LFUN_CLOSE_TAB_GROUP, "close-tab-group", ReadOnly, Buffer },
1203                 { LFUN_DIALOG_SHOW, "dialog-show", NoBuffer, Edit },
1204                 { LFUN_DIALOG_SHOW_NEW_INSET, "dialog-show-new-inset", Noop, Edit },
1205                 { LFUN_DIALOG_UPDATE, "dialog-update", NoBuffer, Edit },
1206                 { LFUN_DIALOG_HIDE, "dialog-hide", NoBuffer, Edit },
1207                 { LFUN_DIALOG_TOGGLE, "dialog-toggle", NoBuffer, Edit },
1208                 { LFUN_DIALOG_DISCONNECT_INSET, "dialog-disconnect-inset", Noop, Edit },
1209
1210                 { LFUN_MOUSE_PRESS, "", ReadOnly, Hidden },
1211                 { LFUN_MOUSE_MOTION, "", ReadOnly | SingleParUpdate, Hidden },
1212                 { LFUN_MOUSE_RELEASE, "", ReadOnly, Hidden },
1213                 { LFUN_MOUSE_DOUBLE, "", ReadOnly, Hidden },
1214                 { LFUN_MOUSE_TRIPLE, "", ReadOnly, Hidden },
1215
1216                 { LFUN_KEYMAP_OFF, "keymap-off", ReadOnly, Edit },
1217                 { LFUN_KEYMAP_PRIMARY, "keymap-primary", ReadOnly, Edit },
1218                 { LFUN_KEYMAP_SECONDARY, "keymap-secondary", ReadOnly, Edit },
1219                 { LFUN_KEYMAP_TOGGLE, "keymap-toggle", ReadOnly, Edit },
1220
1221                 { LFUN_MESSAGE, "message", NoBuffer, System },
1222                 { LFUN_FLOAT_LIST, "float-list", Noop, Edit },
1223                 { LFUN_ESCAPE, "escape", ReadOnly, Edit },
1224
1225                 { LFUN_SERVER_CHAR_AFTER, "server-char-after", ReadOnly, System },
1226                 { LFUN_SERVER_GET_FONT, "server-get-font", ReadOnly, System },
1227                 { LFUN_SERVER_GET_LAYOUT, "server-get-layout", ReadOnly, System },
1228                 { LFUN_SERVER_GET_NAME, "server-get-name", ReadOnly, System },
1229                 { LFUN_SERVER_GET_XY, "server-get-xy", ReadOnly, System },
1230                 { LFUN_SERVER_GOTO_FILE_ROW, "server-goto-file-row", ReadOnly, System },
1231                 { LFUN_SERVER_NOTIFY, "server-notify", ReadOnly, System },
1232                 { LFUN_SERVER_SET_XY, "server-set-xy", ReadOnly, System },
1233
1234                 { LFUN_BUILD_PROGRAM, "build-program", ReadOnly, Buffer },
1235
1236 /*!
1237  * \var lyx::kb_action lyx::LFUN_BUFFER_AUTO_SAVE
1238  * \li Action: Saves the current buffer to a temporary file.
1239  * \li Notion: Saves the current buffer to a file named "#filename#". This LFUN
1240                is called automatically by LyX, to "autosave" the current buffer.
1241         * \li Syntax: buffer-auto-save
1242  * \endvar
1243  */
1244                 { LFUN_BUFFER_AUTO_SAVE, "buffer-auto-save", Noop, Buffer },
1245                 { LFUN_BUFFER_CHILD_OPEN, "buffer-child-open", ReadOnly, Buffer },
1246                 { LFUN_BUFFER_CHKTEX, "buffer-chktex", ReadOnly, Buffer },
1247                 { LFUN_BUFFER_TOGGLE_COMPRESSION, "buffer-toggle-compression", Noop, Buffer },
1248                 { LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding", Noop, Buffer },
1249 /*!
1250  * \var lyx::kb_action lyx::LFUN_BUFFER_CLOSE
1251  * \li Action: Closes the current buffer.
1252  * \li Notion: Closes the current buffer, asking whether to save it, etc,
1253                if the buffer has been modified.
1254  * \li Syntax: buffer-close
1255  * \endvar
1256  */
1257                 { LFUN_BUFFER_CLOSE, "buffer-close", ReadOnly, Buffer },
1258 /*!
1259  * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT
1260  * \li Action: Exports the current buffer (document) to the given format.
1261  * \li Syntax: buffer-export <FORMAT>
1262  * \li Params: <FORMAT> is either "custom" or one of the formats which you
1263                         can find in Tools->Preferences->File formats->Format.
1264                         Usual format you will enter is "pdf2" (pdflatex),
1265                         "pdflatex" (plain tex for pdflatex) or "ps" for postscript.\n
1266                         In case of "custom" you will be asked for a format you
1267                         want to start from and for the command that you want to
1268                         apply to this format. Internally the control is then passed
1269                         to #LFUN_BUFFER_EXPORT_CUSTOM.
1270  * \li Origin: Lgb, 29 Jul 1997
1271  * \endvar
1272  */
1273                 { LFUN_BUFFER_EXPORT, "buffer-export", ReadOnly, Buffer },
1274 /*!
1275  * \var lyx::kb_action lyx::LFUN_BUFFER_EXPORT_CUSTOM
1276  * \li Action: Exports the current buffer (document) from the given format using
1277                the given command on it.
1278  * \li Syntax: buffer-export-custom <FORMAT> <COMMAND>
1279  * \li Params: <FORMAT> format to start from (LyX will care to produce such
1280                         intermediate file).\n
1281                <COMMAND> this command will be launched on the file. Note that you can
1282                use "$$FName" string to qualify the intermediate file.
1283  * \li Sample: buffer-export-custom dvi dvips -f $$FName -o myfile.ps
1284  * \li Origin: leeming, 27 Mar 2004
1285  * \endvar
1286  */
1287                 { LFUN_BUFFER_EXPORT_CUSTOM, "buffer-export-custom", ReadOnly, Buffer },
1288 /*!
1289  * \var lyx::kb_action lyx::LFUN_BUFFER_PRINT
1290  * \li Action: Prints the current document.
1291  * \li Notion: Many settings can be given via the preferences dialog.
1292  * \li Syntax: buffer-print <TARGET> <TARGET-NAME> <COMMAND>
1293  * \li Params: <TARGET> is either "printer" or "file".\n
1294                <TARGER-NAME> is either "default" or file name or printer name.\n
1295                <COMMAND> command ensuring the printing job.
1296  * \li Sample: buffer-print file "/trash/newfile1.ps" "dvips"
1297  * \li Origin: leeming, 28 Mar 2004
1298  * \endvar
1299  */
1300                 { LFUN_BUFFER_PRINT, "buffer-print", ReadOnly, Buffer },
1301 /*!
1302  * \var lyx::kb_action lyx::LFUN_BUFFER_IMPORT
1303  * \li Action: Import a given file as a lyx document.
1304  * \li Notion: File can be imported iff lyx file format is (transitively) reachable via
1305                defined convertors in preferences. Look into File->Import menu to get
1306                an idea of the currently active import formats.
1307  * \li Syntax: buffer-import <FORMAT> [<FILE>]
1308  * \li Origin: Asger, 24 Jul 1998
1309  * \endvar
1310  */
1311                 { LFUN_BUFFER_IMPORT, "buffer-import", NoBuffer, Buffer },
1312 /*!
1313  * \var lyx::kb_action lyx::LFUN_BUFFER_NEW
1314  * \li Action: Creates a new buffer (that is, document).
1315  * \li Notion: Implicit path can be set in Preferences dialog.
1316  * \li Syntax: buffer-new [<FILE>]
1317  * \li Params: <FILE>: filename of created file with absolute path.
1318  * \endvar
1319  */
1320                 { LFUN_BUFFER_NEW, "buffer-new", NoBuffer, Buffer },
1321 /*!
1322  * \var lyx::kb_action lyx::LFUN_BUFFER_NEW_TEMPLATE
1323  * \li Action: Creates a new buffer (that is, document) from a template.
1324  * \li Notion: Path for new files and templates can be set in Preferences dialog.
1325                Template will be asked for via Open-dialog.
1326  * \li Syntax: buffer-new-template [<FILE>]
1327  * \li Params: <FILE>: filename of created file with absolute path.
1328  * \endvar
1329  */
1330                 { LFUN_BUFFER_NEW_TEMPLATE,"buffer-new-template", NoBuffer, Buffer },
1331                 { LFUN_BUFFER_RELOAD, "buffer-reload", ReadOnly, Buffer },
1332 /*!
1333  * \var lyx::kb_action lyx::LFUN_BUFFER_SWITCH
1334  * \li Action: Switch to the given buffer.
1335  * \li Notion: This is useful also in case you need simultaneously more views of the edited
1336                document in different LyX windows.
1337  * \li Syntax: buffer-new-template <BUFFER>
1338  * \li Params: <BUFFER>: already opened document which is to be shown.
1339  * \endvar
1340  */
1341                 { LFUN_BUFFER_SWITCH, "buffer-switch", NoBuffer | ReadOnly, Buffer },
1342 /*!
1343  * \var lyx::kb_action lyx::LFUN_BUFFER_TOGGLE_READ_ONLY
1344  * \li Action: Toggle editing mode of the current document between read/write and read-only.
1345  * \li Syntax: buffer-toggle-read-only
1346  * \li Origin: Lgb, 27 May 1997
1347  * \endvar
1348  */
1349                 { LFUN_BUFFER_TOGGLE_READ_ONLY, "buffer-toggle-read-only", ReadOnly, Buffer },
1350 /*!
1351  * \var lyx::kb_action lyx::LFUN_BUFFER_VIEW
1352  * \li Action: Displays current buffer in chosen format.
1353  * \li Notion: Displays the contents of the current buffer in the chosen
1354                format, for example, PDF or DVI. This runs the necessary
1355                converter, calls the defined viewer, and so forth.
1356  * \li Syntax: buffer-view <FORMAT>
1357  * \li Params: <FORMAT>: The format to display, where this is one of the
1358                          formats defined (in the current GUI) in the
1359                          Tools>Preferences>File Formats dialog.
1360  * \endvar
1361  */
1362                 { LFUN_BUFFER_VIEW, "buffer-view", ReadOnly, Buffer },
1363 /*!
1364  * \var lyx::kb_action lyx::LFUN_BUFFER_UPDATE
1365  * \li Action: Exports the current document and put the result into the
1366                temporary directory.
1367  * \li Notion: In case you are already viewing the exported document (see #LFUN_BUFFER_VIEW)
1368                the output will be rewriten - updated. This is useful in case your viewer
1369                is able to detect such changes (e.g. ghostview for postscript).
1370  * \li Syntax: buffer-update <FORMAT>
1371  * \li Params: <FORMAT>: The format to display, where this is one of the
1372                          formats defined (in the current GUI) in the
1373                          Tools>Preferences>File Formats dialog.
1374  * \li Origin: Dekel, 5 Aug 2000
1375  * \endvar
1376  */
1377                 { LFUN_BUFFER_UPDATE, "buffer-update", ReadOnly, Buffer },
1378
1379 /*!
1380  * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE
1381  * \li Action: Saves the current buffer.
1382  * \li Notion: Saves the current buffer to disk, using the filename that
1383                is already associated with the buffer, asking for one if
1384                none is yet assigned.
1385  * \li Syntax: buffer-write
1386  * \endvar
1387  */
1388                 { LFUN_BUFFER_WRITE, "buffer-write", ReadOnly, Buffer },
1389 /*!
1390  * \var lyx::kb_action lyx::LFUN_BUFFER_WRITE_AS
1391  * \li Action: Rename and save current buffer.
1392  * \li Syntax: buffer-write-as <FILENAME>
1393  * \li Params: <FILENAME>: New name of the buffer/file. A relative path
1394                is with respect to the original location of the buffer/file.
1395  * \endvar
1396  */
1397                 { LFUN_BUFFER_WRITE_AS, "buffer-write-as", ReadOnly, Buffer },
1398                 { LFUN_BUFFER_WRITE_ALL, "buffer-write-all", ReadOnly, Buffer },
1399                 { LFUN_BUFFER_NEXT, "buffer-next", ReadOnly, Buffer },
1400                 { LFUN_BUFFER_PREVIOUS, "buffer-previous", ReadOnly, Buffer },
1401                 { LFUN_MASTER_BUFFER_UPDATE, "master-buffer-update", ReadOnly, Buffer },
1402                 { LFUN_MASTER_BUFFER_VIEW, "master-buffer-view", ReadOnly, Buffer },
1403                 { LFUN_BUFFER_LANGUAGE, "buffer-language", Noop, Buffer },
1404                 { LFUN_BUFFER_SAVE_AS_DEFAULT, "buffer-save-as-default", Noop, Buffer },
1405                 { LFUN_BUFFER_PARAMS_APPLY, "buffer-params-apply", Noop, Buffer },
1406
1407 /*!
1408  * \var lyx::kb_action lyx::LFUN_FILE_INSERT
1409  * \li Action: Inserts another LyX file.
1410  * \li Syntax: file-insert [<FILE>]
1411  * \li Params: <FILE>: Filename to be inserted.
1412  * \endvar
1413  */
1414                 { LFUN_FILE_INSERT, "file-insert", Noop, Edit },
1415 /*!
1416  * \var lyx::kb_action lyx::LFUN_FILE_INSERT_PLAINTEXT
1417  * \li Action: Inserts plain text file.
1418  * \li Syntax: file-insert-plaintext [<FILE>]
1419  * \li Params: <FILE>: Filename to be inserted.
1420  * \li Origin: CFO-G, 19 Nov 1997
1421  * \endvar
1422  */
1423                 { LFUN_FILE_INSERT_PLAINTEXT, "file-insert-plaintext", Noop, Edit },
1424 /*!
1425  * \var lyx::kb_action lyx::LFUN_FILE_INSERT_PLAINTEXT_PARA
1426  * \li Action: Inserts plain text file as paragraph (i.e. join lines).
1427  * \li Syntax: file-insert-plaintext-para [<FILE>]
1428  * \li Params: <FILE>: Filename to be inserted.
1429  * \li Origin: Levon, 14 Feb 2001
1430  * \endvar
1431  */
1432                 { LFUN_FILE_INSERT_PLAINTEXT_PARA, "file-insert-plaintext-para", Noop, Edit },
1433 /*!
1434  * \var lyx::kb_action lyx::LFUN_FILE_OPEN
1435  * \li Action: Open LyX document.
1436  * \li Syntax: file-open [<FILE>]
1437  * \li Params: <FILE>: Filename to be opened.
1438  * \endvar
1439  */
1440                 { LFUN_FILE_OPEN, "file-open", NoBuffer, Buffer },
1441
1442
1443 /*!
1444  * \var lyx::kb_action lyx::LFUN_CALL
1445  * \li Action: Executes a command defined in a .def file.
1446  * \li Notion: The definitions are by default read from lib/commands/default.def.\n
1447                A .def file allows to define a command with \\define "<NAME>" "<LFUN>"
1448                where <NAME> is the name of the new command and <LFUN> is the lfun code
1449                to be executed (see e.g. #LFUN_COMMAND_SEQUENCE).
1450                \\def_file "FileName" allows to include another .def file. \n
1451                This is particularly useful in connection with toolbar buttons:
1452                Since the name of the button image for this lfun is
1453                lib/images/commands/<NAME>.png this is the way to assign an image
1454                to a complex command-sequence.
1455  * \li Syntax: call <NAME>
1456  * \li Params: <NAME>: Name of the command that must be called.
1457  * \li Origin: broider, 2 Oct 2007
1458  * \endvar
1459  */
1460                 { LFUN_CALL, "call", NoBuffer, System },
1461 /*!
1462  * \var lyx::kb_action lyx::LFUN_META_PREFIX
1463  * \li Action: Simulate halting Meta key (Alt key on PCs).
1464  * \li Notion: Used for buffer editation not for GUI control.
1465  * \li Syntax: meta-prefix
1466  * \endvar
1467  */
1468                 { LFUN_META_PREFIX, "meta-prefix", NoBuffer, System },
1469 /*!
1470  * \var lyx::kb_action lyx::LFUN_CANCEL
1471  * \li Action: Cancels sequence prepared by #LFUN_META_PREFIX .
1472  * \li Syntax: cancel
1473  * \endvar
1474  */
1475                 { LFUN_CANCEL, "cancel", NoBuffer, System },
1476
1477 /*!
1478  * \var lyx::kb_action lyx::LFUN_COMMAND_EXECUTE
1479  * \li Action: Opens the minibuffer toolbar so that the user can type in there.
1480  * \li Notion: Usually bound to M-x shortcut.
1481  * \li Syntax: command-execute
1482  * \endvar
1483  */
1484                 { LFUN_COMMAND_EXECUTE, "command-execute", NoBuffer, Edit },
1485                 { LFUN_COMMAND_PREFIX, "command-prefix", NoBuffer, Hidden },
1486 /*!
1487  * \var lyx::kb_action lyx::LFUN_COMMAND_SEQUENCE
1488  * \li Action: Run more commands (LFUN and its parameters) in a sequence.
1489  * \li Syntax: command-sequence <CMDS>
1490  * \li Params: <CMDS>: Sequence of commands separated by semicolons.
1491  * \li Sample: command-sequence cut; ert-insert; self-insert \; paste; self-insert {}; inset-toggle;
1492  * \li Origin: Andre', 11 Nov 1999
1493  * \endvar
1494  */
1495                 { LFUN_COMMAND_SEQUENCE, "command-sequence", NoBuffer, System },
1496
1497 /*!
1498  * \var lyx::kb_action lyx::LFUN_PREFERENCES_SAVE
1499  * \li Action: Save user preferences.
1500  * \li Syntax: preferences-save
1501  * \li Origin: Lgb, 27 Nov 1999
1502  * \endvar
1503  */
1504                 { LFUN_PREFERENCES_SAVE, "preferences-save", NoBuffer, System },
1505 /*!
1506  * \var lyx::kb_action lyx::LFUN_RECONFIGURE
1507  * \li Action: Reconfigure the automatic settings.
1508  * \li Syntax: reconfigure
1509  * \li Origin: Asger, 14 Feb 1997
1510  * \endvar
1511  */
1512                 { LFUN_RECONFIGURE, "reconfigure", NoBuffer, System },
1513 /*!
1514  * \var lyx::kb_action lyx::LFUN_LYXRC_APPLY
1515  * \li Action: Apply the given settings to user preferences.
1516  * \li Syntax: lyxrc-apply <SETTINGS>
1517  * \li Params: <SETTINGS>: settings which are to be set. Take a look into ~/.lyx/preferences
1518                            to get an idea which commands to use and their syntax.
1519                            #lyx::LyXRC::LyXRCTags has the list of possible commands.
1520  * \endvar
1521  */
1522                 { LFUN_LYXRC_APPLY, "lyxrc-apply", NoBuffer, System },
1523 /*!
1524  * \var lyx::kb_action lyx::LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR
1525  * \li Action: Determine whether keep cursor inside the editing window regardless
1526                the scrollbar movement.
1527  * \li Syntax: toggle-cursor-follows-scrollbar
1528  * \li Origin: ARRae, 2 Dec 1997
1529  * \endvar
1530  */
1531                 { LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR, "toggle-cursor-follows-scrollbar", ReadOnly, System },
1532 /*!
1533  * \var lyx::kb_action lyx::LFUN_SET_COLOR
1534  * \li Action: Set the given LyX color to the color defined by the X11 name given.
1535  * \li Notion: A new color entry is created if the color is unknown.
1536                Color names can be stored as a part of user settings.
1537  * \li Syntax: set-color <LYX_NAME> <X11_NAME>
1538  * \li Origin: SLior, 11 Jun 2000
1539  * \endvar
1540  */
1541                 { LFUN_SET_COLOR, "set-color", ReadOnly | NoBuffer, System },
1542 /*!
1543  * \var lyx::kb_action lyx::LFUN_STATISTICS
1544  * \li Action: Count the statistics (number of words and characters)
1545                in the document or in the given selection.
1546  * \li Notion: Note that this function gives the number of words/chars written,
1547                not the number of characters which will be typeset.
1548  * \li Syntax: statistics
1549  * \li Origin: lasgouttes, Jan 27 2004; ps, Jan 8 2008
1550  * \endvar
1551  */
1552                 { LFUN_STATISTICS, "statistics", ReadOnly, System },
1553 /*!
1554  * \var lyx::kb_action lyx::LFUN_COMPLETION_INLINE
1555  * \li Action: Show the inline completion at the cursor position.
1556  * \li Syntax: completion-inline
1557  * \li Origin: sts, Feb 19 2008
1558  * \endvar
1559  */
1560                 { LFUN_COMPLETION_INLINE, "completion-inline", ReadOnly | NoUpdate, Edit },
1561 /*!
1562  * \var lyx::kb_action lyx::LFUN_COMPLETION_POPUP
1563  * \li Action: Show the completion popup at the cursor position.
1564  * \li Syntax: completion-popup
1565  * \li Origin: sts, Feb 19 2008
1566  * \endvar
1567  */
1568                 { LFUN_COMPLETION_POPUP, "completion-popup", ReadOnly | NoUpdate, Edit },
1569 /*!
1570  * \var lyx::kb_action lyx::LFUN_COMPLETION_COMPLETE
1571  * \li Action: Try to complete the word or command at the cursor position.
1572  * \li Syntax: complete
1573  * \li Origin: sts, Feb 19 2008
1574  * \endvar
1575  */
1576                 { LFUN_COMPLETION_COMPLETE, "complete", SingleParUpdate, Edit },
1577
1578                 { LFUN_NOACTION, "", Noop, Hidden }
1579 #ifndef DOXYGEN_SHOULD_SKIP_THIS
1580         };
1581
1582         for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
1583                 newFunc(items[i].action, items[i].name, items[i].attrib, items[i].type);
1584         }
1585
1586         init = true;
1587 }
1588 #endif
1589
1590 LyXAction::LyXAction()
1591 {
1592         init();
1593 }
1594
1595
1596 // Returns an action tag from a string.
1597 FuncRequest LyXAction::lookupFunc(string const & func) const
1598 {
1599         string const func2 = trim(func);
1600
1601         if (func2.empty()) {
1602                 return FuncRequest(LFUN_NOACTION);
1603         }
1604
1605         string cmd;
1606         string const arg = split(func2, cmd, ' ');
1607
1608         func_map::const_iterator fit = lyx_func_map.find(cmd);
1609
1610         return fit != lyx_func_map.end() ? FuncRequest(fit->second, arg) : FuncRequest(LFUN_UNKNOWN_ACTION);
1611 }
1612
1613
1614 string const LyXAction::getActionName(kb_action action) const
1615 {
1616         info_map::const_iterator const it = lyx_info_map.find(action);
1617         return it != lyx_info_map.end() ? it->second.name : string();
1618 }
1619
1620
1621 LyXAction::func_type const LyXAction::getActionType(kb_action action) const
1622 {
1623         info_map::const_iterator const it = lyx_info_map.find(action);
1624         return it != lyx_info_map.end() ? it->second.type : Hidden;
1625 }
1626
1627
1628 bool LyXAction::funcHasFlag(kb_action action,
1629                             LyXAction::func_attrib flag) const
1630 {
1631         info_map::const_iterator ici = lyx_info_map.find(action);
1632
1633         if (ici == lyx_info_map.end()) {
1634                 LYXERR0("action: " << action << " is not known.");
1635                 BOOST_ASSERT(false);
1636         }
1637
1638         return ici->second.attrib & flag;
1639 }
1640
1641
1642 LyXAction::const_func_iterator LyXAction::func_begin() const
1643 {
1644         return lyx_func_map.begin();
1645 }
1646
1647
1648 LyXAction::const_func_iterator LyXAction::func_end() const
1649 {
1650         return lyx_func_map.end();
1651 }
1652
1653
1654 } // namespace lyx