src/LyXAction.cpp

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