lib/doc/LFUNs.lyx

   1 #LyX 1.6.5svn created this file. For more info see http://www.lyx.org/
   2 \lyxformat 345
   3 \begin_document
   4 \begin_header
   5 \textclass article
   6 \use_default_options false
   7 \language english
   8 \inputencoding auto
   9 \font_roman default
  10 \font_sans default
  11 \font_typewriter default
  12 \font_default_family default
  13 \font_sc false
  14 \font_osf false
  15 \font_sf_scale 100
  16 \font_tt_scale 100
  17
  18 \graphics default
  19 \paperfontsize default
  20 \spacing single
  21 \use_hyperref false
  22 \papersize default
  23 \use_geometry true
  24 \use_amsmath 1
  25 \use_esint 1
  26 \cite_engine basic
  27 \use_bibtopic false
  28 \paperorientation portrait
  29 \leftmargin 2.5cm
  30 \topmargin 2cm
  31 \rightmargin 3cm
  32 \bottommargin 1cm
  33 \secnumdepth 3
  34 \tocdepth 3
  35 \paragraph_separation indent
  36 \defskip medskip
  37 \quotes_language english
  38 \papercolumns 1
  39 \papersides 1
  40 \paperpagestyle default
  41 \tracking_changes false
  42 \output_changes false
  43 \author ""
  44 \author ""
  45 \end_header
  46
  47 \begin_body
  48
  49 \begin_layout Section*
  50 LFUNs documentation automatically generated 2009-10-07
  51 \end_layout
  52
  53 \begin_layout Standard
  54 \begin_inset ERT
  55 status collapsed
  56
  57 \begin_layout Plain Layout
  58
  59
  60 \backslash
  61 thispagestyle{empty}
  62 \end_layout
  63
  64 \end_inset
  65
  66
  67 \begin_inset VSpace 1cm
  68 \end_inset
  69
  70
  71 \end_layout
  72
  73 \begin_layout Subsection*
  74 LFUN_ACCENT_ACUTE
  75 \end_layout
  76
  77 \begin_layout Description
  78 Action Adds an acute accent to the next character typed.
  79 \end_layout
  80
  81 \begin_layout Description
  82 Syntax accent-acute
  83 \end_layout
  84
  85 \begin_layout Subsection*
  86 LFUN_ACCENT_BREVE
  87 \end_layout
  88
  89 \begin_layout Description
  90 Action Adds a breve accent to the next character typed.
  91 \end_layout
  92
  93 \begin_layout Description
  94 Syntax accent-breve
  95 \end_layout
  96
  97 \begin_layout Subsection*
  98 LFUN_ACCENT_CARON
  99 \end_layout
 100
 101 \begin_layout Description
 102 Action Adds a caron to the next character typed.
 103 \end_layout
 104
 105 \begin_layout Description
 106 Syntax accent-caron
 107 \end_layout
 108
 109 \begin_layout Subsection*
 110 LFUN_ACCENT_CEDILLA
 111 \end_layout
 112
 113 \begin_layout Description
 114 Action Adds a cedilla to the next character typed.
 115 \end_layout
 116
 117 \begin_layout Description
 118 Syntax accent-cedilla
 119 \end_layout
 120
 121 \begin_layout Subsection*
 122 LFUN_ACCENT_CIRCLE
 123 \end_layout
 124
 125 \begin_layout Description
 126 Action Adds a circle accent to the next character typed.
 127 \end_layout
 128
 129 \begin_layout Description
 130 Syntax accent-circle
 131 \end_layout
 132
 133 \begin_layout Subsection*
 134 LFUN_ACCENT_CIRCUMFLEX
 135 \end_layout
 136
 137 \begin_layout Description
 138 Action Adds a circumflex to the next character typed.
 139 \end_layout
 140
 141 \begin_layout Description
 142 Syntax accent-circumflex
 143 \end_layout
 144
 145 \begin_layout Subsection*
 146 LFUN_ACCENT_DOT
 147 \end_layout
 148
 149 \begin_layout Description
 150 Action Adds a dot accent to the next character typed.
 151 \end_layout
 152
 153 \begin_layout Description
 154 Syntax accent-dot
 155 \end_layout
 156
 157 \begin_layout Subsection*
 158 LFUN_ACCENT_GRAVE
 159 \end_layout
 160
 161 \begin_layout Description
 162 Action Adds a grave accent to the next character typed.
 163 \end_layout
 164
 165 \begin_layout Description
 166 Syntax accent-grave
 167 \end_layout
 168
 169 \begin_layout Subsection*
 170 LFUN_ACCENT_HUNGARIAN_UMLAUT
 171 \end_layout
 172
 173 \begin_layout Description
 174 Action Adds a Hungarian umlaut to the next character typed.
 175 \end_layout
 176
 177 \begin_layout Description
 178 Syntax accent-grave
 179 \end_layout
 180
 181 \begin_layout Subsection*
 182 LFUN_ACCENT_MACRON
 183 \end_layout
 184
 185 \begin_layout Description
 186 Action Adds a macron to the next character typed.
 187 \end_layout
 188
 189 \begin_layout Description
 190 Syntax accent-macron
 191 \end_layout
 192
 193 \begin_layout Subsection*
 194 LFUN_ACCENT_OGONEK
 195 \end_layout
 196
 197 \begin_layout Description
 198 Action Adds an ogonek accent to the next character typed.
 199 \end_layout
 200
 201 \begin_layout Description
 202 Syntax accent-ogonek
 203 \end_layout
 204
 205 \begin_layout Subsection*
 206 LFUN_ACCENT_TIE
 207 \end_layout
 208
 209 \begin_layout Description
 210 Action Adds a tie over the next two character typed.
 211 \end_layout
 212
 213 \begin_layout Description
 214 Notion The following char will finish the tie.
 215 \end_layout
 216
 217 \begin_layout Description
 218 Syntax accent-tie
 219 \end_layout
 220
 221 \begin_layout Subsection*
 222 LFUN_ACCENT_TILDE
 223 \end_layout
 224
 225 \begin_layout Description
 226 Action Adds a tilde over the next character typed.
 227 \end_layout
 228
 229 \begin_layout Description
 230 Syntax accent-tilde
 231 \end_layout
 232
 233 \begin_layout Subsection*
 234 LFUN_ACCENT_UMLAUT
 235 \end_layout
 236
 237 \begin_layout Description
 238 Action Adds an umlaut over the next character typed.
 239 \end_layout
 240
 241 \begin_layout Description
 242 Syntax accent-umlaut
 243 \end_layout
 244
 245 \begin_layout Subsection*
 246 LFUN_ACCENT_UNDERBAR
 247 \end_layout
 248
 249 \begin_layout Description
 250 Action Adds a bar under the next character typed.
 251 \end_layout
 252
 253 \begin_layout Description
 254 Syntax accent-underbar
 255 \end_layout
 256
 257 \begin_layout Subsection*
 258 LFUN_ACCENT_UNDERDOT
 259 \end_layout
 260
 261 \begin_layout Description
 262 Action Adds a dot under the next character typed.
 263 \end_layout
 264
 265 \begin_layout Description
 266 Syntax accent-underdot
 267 \end_layout
 268
 269 \begin_layout Subsection*
 270 LFUN_CAPTION_INSERT
 271 \end_layout
 272
 273 \begin_layout Description
 274 Action Inserts a caption inset.
 275 \end_layout
 276
 277 \begin_layout Description
 278 Syntax caption-insert
 279 \end_layout
 280
 281 \begin_layout Description
 282 Origin Lgb, 18 Jul 2000
 283 \end_layout
 284
 285 \begin_layout Subsection*
 286 LFUN_DATE_INSERT
 287 \end_layout
 288
 289 \begin_layout Description
 290 Action Inserts the current date.
 291 \end_layout
 292
 293 \begin_layout Description
 294 Syntax date-insert [<ARG>]
 295 \end_layout
 296
 297 \begin_layout Description
 298 Params <ARG>: Format of date.
 299  The default value (%x) can be set in Preferences->Date format.
 300  For possible formats see manual page of strftime function.
 301 \end_layout
 302
 303 \begin_layout Description
 304 Origin jdblair, 31 Jan 2000
 305 \end_layout
 306
 307 \begin_layout Subsection*
 308 LFUN_FOOTNOTE_INSERT
 309 \end_layout
 310
 311 \begin_layout Description
 312 Action Inserts a footnote inset.
 313 \end_layout
 314
 315 \begin_layout Description
 316 Syntax footnote-insert
 317 \end_layout
 318
 319 \begin_layout Description
 320 Origin Jug, 7 Mar 2000
 321 \end_layout
 322
 323 \begin_layout Subsection*
 324 LFUN_ERT_INSERT
 325 \end_layout
 326
 327 \begin_layout Description
 328 Action Inserts an ERT inset.
 329 \end_layout
 330
 331 \begin_layout Description
 332 Syntax ert-insert
 333 \end_layout
 334
 335 \begin_layout Description
 336 Origin Jug, 18 Feb 2000
 337 \end_layout
 338
 339 \begin_layout Subsection*
 340 LFUN_FLOAT_INSERT
 341 \end_layout
 342
 343 \begin_layout Description
 344 Action Inserts a float inset.
 345 \end_layout
 346
 347 \begin_layout Description
 348 Syntax float-insert <TYPE>
 349 \end_layout
 350
 351 \begin_layout Description
 352 Params <TYPE>: type of float depends on the used textclass.
 353  Usually "algorithm", "table", "figure" parameters can be given.
 354 \end_layout
 355
 356 \begin_layout Description
 357 Origin Lgb, 27 Jun 2000
 358 \end_layout
 359
 360 \begin_layout Subsection*
 361 LFUN_FLOAT_WIDE_INSERT
 362 \end_layout
 363
 364 \begin_layout Description
 365 Action Inserts float insets as in LFUN_FLOAT_INSERT but span multiple columns.
 366 \end_layout
 367
 368 \begin_layout Description
 369 Notion Corresponds to the starred floats (figure*, table*, etc.) in LaTeX.
 370 \end_layout
 371
 372 \begin_layout Description
 373 Syntax float-wide-insert <TYPE>
 374 \end_layout
 375
 376 \begin_layout Description
 377 Params <TYPE>: type of float depends on the used textclass.
 378  Usually "algorithm", "table", "figure" parameters can be given.
 379 \end_layout
 380
 381 \begin_layout Description
 382 Origin Lgb, 31 Oct 2001
 383 \end_layout
 384
 385 \begin_layout Subsection*
 386 LFUN_FLOAT_LIST_INSERT
 387 \end_layout
 388
 389 \begin_layout Description
 390 Action Inserts the list of floats in the document.
 391 \end_layout
 392
 393 \begin_layout Description
 394 Syntax float-list-insert <TYPE>
 395 \end_layout
 396
 397 \begin_layout Description
 398 Params <TYPE>: type of float depends on the used textclass.
 399  Usually "algorithm", "table", "figure" parameters can be given.
 400 \end_layout
 401
 402 \begin_layout Description
 403 Origin Lgb, 3 May 2001
 404 \end_layout
 405
 406 \begin_layout Subsection*
 407 LFUN_WRAP_INSERT
 408 \end_layout
 409
 410 \begin_layout Description
 411 Action Inserts floats wrapped by the text around.
 412 \end_layout
 413
 414 \begin_layout Description
 415 Syntax wrap-insert <TYPE>
 416 \end_layout
 417
 418 \begin_layout Description
 419 Params <TYPE>: table|figure
 420 \end_layout
 421
 422 \begin_layout Description
 423 Origin Dekel, 7 Apr 2002
 424 \end_layout
 425
 426 \begin_layout Subsection*
 427 LFUN_OPTIONAL_INSERT
 428 \end_layout
 429
 430 \begin_layout Description
 431 Action Inserts an optional-argument (short title) inset.
 432 \end_layout
 433
 434 \begin_layout Description
 435 Syntax optional-insert
 436 \end_layout
 437
 438 \begin_layout Description
 439 Origin vermeer, 12 Aug 2002
 440 \end_layout
 441
 442 \begin_layout Subsection*
 443 LFUN_LINE_INSERT
 444 \end_layout
 445
 446 \begin_layout Description
 447 Action Inserts a horizontal line.
 448 \end_layout
 449
 450 \begin_layout Description
 451 Syntax line-insert
 452 \end_layout
 453
 454 \begin_layout Description
 455 Origin Andre, Oct 27 2003
 456 \end_layout
 457
 458 \begin_layout Subsection*
 459 LFUN_NEWPAGE_INSERT
 460 \end_layout
 461
 462 \begin_layout Description
 463 Action Inserts a new page.
 464 \end_layout
 465
 466 \begin_layout Description
 467 Syntax newpage-insert <ARG>
 468 \end_layout
 469
 470 \begin_layout Description
 471 Params <ARG>: <newpage|pagebreak|clearpage|cleardoublepage> default: newpage
 472 \end_layout
 473
 474 \begin_layout Description
 475 Origin uwestoehr, 24 Nov 2007
 476 \end_layout
 477
 478 \begin_layout Subsection*
 479 LFUN_MARGINALNOTE_INSERT
 480 \end_layout
 481
 482 \begin_layout Description
 483 Action Inserts a marginal note.
 484 \end_layout
 485
 486 \begin_layout Description
 487 Syntax marginalnote-insert
 488 \end_layout
 489
 490 \begin_layout Description
 491 Origin Lgb, 26 Jun 2000
 492 \end_layout
 493
 494 \begin_layout Subsection*
 495 LFUN_UNICODE_INSERT
 496 \end_layout
 497
 498 \begin_layout Description
 499 Action Inserts a single unicode character.
 500 \end_layout
 501
 502 \begin_layout Description
 503 Syntax unicode-insert <CHAR>
 504 \end_layout
 505
 506 \begin_layout Description
 507 Params <CHAR>: The character to insert, given as its code point, in hexadecimal.
 508 \end_layout
 509
 510 \begin_layout Description
 511 Sample unicode-insert 0x0100
 512 \end_layout
 513
 514 \begin_layout Description
 515 Origin Lgb, 22 Oct 2006
 516 \end_layout
 517
 518 \begin_layout Subsection*
 519 LFUN_LISTING_INSERT
 520 \end_layout
 521
 522 \begin_layout Description
 523 Action Inserts a new listings inset.
 524 \end_layout
 525
 526 \begin_layout Description
 527 Syntax listing-insert
 528 \end_layout
 529
 530 \begin_layout Description
 531 Origin Herbert, 10 Nov 2001; bpeng, 2 May 2007
 532 \end_layout
 533
 534 \begin_layout Subsection*
 535 LFUN_TAB_INSERT
 536 \end_layout
 537
 538 \begin_layout Description
 539 Action Insert a tab into a listings inset.
 540 \end_layout
 541
 542 \begin_layout Description
 543 Notion It also works on a selection.
 544 \end_layout
 545
 546 \begin_layout Description
 547 Syntax tab-insert
 548 \end_layout
 549
 550 \begin_layout Description
 551 Origin vfr, Sep 30 2008
 552 \end_layout
 553
 554 \begin_layout Subsection*
 555 LFUN_TAB_DELETE
 556 \end_layout
 557
 558 \begin_layout Description
 559 Action Delete a tab or up to an equivalent amount of spaces from a listings
 560  inset.
 561 \end_layout
 562
 563 \begin_layout Description
 564 Notion It also works on a selection - it removes a tab or spaces from the
 565  beginning of each line spanned by the selection.
 566  This is useful if you want to indent/unindent multiple lines in one action.
 567 \end_layout
 568
 569 \begin_layout Description
 570 Syntax tab-delete
 571 \end_layout
 572
 573 \begin_layout Description
 574 Origin vfr, Sep 30 2008
 575 \end_layout
 576
 577 \begin_layout Subsection*
 578 LFUN_QUOTE_INSERT
 579 \end_layout
 580
 581 \begin_layout Description
 582 Action Inserts quotes according to the type and quote-language preference.
 583 \end_layout
 584
 585 \begin_layout Description
 586 Notion Currently English, Swedish, German, Polish, French, Danish quotes
 587  are distinguished.
 588 \end_layout
 589
 590 \begin_layout Description
 591 Syntax quote-insert [<TYPE>]
 592 \end_layout
 593
 594 \begin_layout Description
 595 Params <TYPE>: 'single' for single quotes, otherwise double quotes will
 596  be used.
 597 \end_layout
 598
 599 \begin_layout Subsection*
 600 LFUN_INFO_INSERT
 601 \end_layout
 602
 603 \begin_layout Description
 604 Action Displays shortcuts, lyxrc, package and textclass availability and
 605  menu information in a non-editable boxed InsetText.
 606 \end_layout
 607
 608 \begin_layout Description
 609 Notion Apart from lfun arguments you can use the following method:
 610 \begin_inset Newline newline
 611 \end_inset
 612
 613 1.
 614  input the type and argument of this inset, e.g.
 615  "menu paste", in the work area.
 616 \begin_inset Newline newline
 617 \end_inset
 618
 619 2.
 620  select the text and run info-insert lfun.
 621 \end_layout
 622
 623 \begin_layout Description
 624 Syntax info-insert <TYPE> <ARG>
 625 \end_layout
 626
 627 \begin_layout Description
 628 Params <TYPE>: shortcut[s]|lyxrc|package|textclass|menu|buffer
 629 \begin_inset Newline newline
 630 \end_inset
 631
 632 <ARG>: argument for a given type.
 633  Look into InsetInfo.h for detailed description.
 634 \begin_inset Newline newline
 635 \end_inset
 636
 637                       shortcut[s]: name of lfun (e.g math-insert
 638 \backslash
 639 alpha)
 640 \begin_inset Newline newline
 641 \end_inset
 642
 643                       lyxrc: name of rc_entry (e.g.
 644  bind_file)
 645 \begin_inset Newline newline
 646 \end_inset
 647
 648                       package: name of latex package (e.g.
 649  listings)
 650 \begin_inset Newline newline
 651 \end_inset
 652
 653                       textclass: name of textclass (e.g.
 654  article)
 655 \begin_inset Newline newline
 656 \end_inset
 657
 658                       menu: name of lfun used in menu
 659 \begin_inset Newline newline
 660 \end_inset
 661
 662                       icon: name of lfun used in toolbar
 663 \begin_inset Newline newline
 664 \end_inset
 665
 666                       buffer: "name"|"path"|"class"
 667 \end_layout
 668
 669 \begin_layout Description
 670 Sample command-sequence info-insert buffer path; info-insert buffer name
 671 \end_layout
 672
 673 \begin_layout Description
 674 Origin bpeng, 7 Oct 2007
 675 \end_layout
 676
 677 \begin_layout Subsection*
 678 LFUN_BRANCH_INSERT
 679 \end_layout
 680
 681 \begin_layout Description
 682 Action Inserts branch inset.
 683 \end_layout
 684
 685 \begin_layout Description
 686 Syntax branch-insert <BRANCH-NAME>
 687 \end_layout
 688
 689 \begin_layout Description
 690 Origin vermeer, 17 Aug 2003
 691 \end_layout
 692
 693 \begin_layout Subsection*
 694 LFUN_BOX_INSERT
 695 \end_layout
 696
 697 \begin_layout Description
 698 Action Inserts Box inset.
 699 \end_layout
 700
 701 \begin_layout Description
 702 Syntax box-insert [<TYPE>]
 703 \end_layout
 704
 705 \begin_layout Description
 706 Params <TYPE>: Boxed|Frameless|Framed|ovalbox|Ovalbox|Shadowbox|Shaded|Doublebox
 707 \begin_inset Newline newline
 708 \end_inset
 709
 710 Framed is the default one.
 711 \end_layout
 712
 713 \begin_layout Description
 714 Origin vermeer, 7 Oct 2003
 715 \end_layout
 716
 717 \begin_layout Subsection*
 718 LFUN_FLEX_INSERT
 719 \end_layout
 720
 721 \begin_layout Description
 722 Action Inserts CharStyle, Custom inset or XML short element.
 723 \end_layout
 724
 725 \begin_layout Description
 726 Notion Look into the Customization manual for more information about these
 727  elements.
 728 \begin_inset Newline newline
 729 \end_inset
 730
 731 To make this command enabled the layout file for the document class you're
 732  using has to load the character styles.
 733  There are a few contained in the Logical Markup module.
 734  You can also of course create some yourself.
 735 \begin_inset Newline newline
 736 \end_inset
 737
 738 For dissolving the element see LFUN_INSET_DISSOLVE.
 739 \end_layout
 740
 741 \begin_layout Description
 742 Syntax flex-insert <TYPE:Name>
 743 \end_layout
 744
 745 \begin_layout Description
 746 Params TYPE: CharStyle|Custom|Element|Standard
 747 \begin_inset Newline newline
 748 \end_inset
 749
 750 Identifies whether this is a Character Style, a Custom Inset or an XML Element,
 751  and which dynamical sub-menu this flex inset is in on the LyX menu tree.
 752  If Standard (currently unused): none of these.
 753 \begin_inset Newline newline
 754 \end_inset
 755
 756 Name: This name must be defined either in your layout file or imported by
 757  some module.
 758  The definition is InsetLayout <TYPE:Name>
 759 \end_layout
 760
 761 \begin_layout Description
 762 Sample flex-insert CharStyle:Code
 763 \end_layout
 764
 765 \begin_layout Subsection*
 766 LFUN_SELF_INSERT
 767 \end_layout
 768
 769 \begin_layout Description
 770 Action Inserts the given string (accordingly to the correct keymap).
 771 \end_layout
 772
 773 \begin_layout Description
 774 Notion Automatically replace the currently selected text.
 775  Depends on lyxrc settings "auto_region_delete".
 776 \end_layout
 777
 778 \begin_layout Description
 779 Syntax self-insert <STRING>
 780 \end_layout
 781
 782 \begin_layout Subsection*
 783 LFUN_SPACE_INSERT
 784 \end_layout
 785
 786 \begin_layout Description
 787 Action Inserts one of horizontal space insets.
 788 \end_layout
 789
 790 \begin_layout Description
 791 Syntax space-insert <NAME> [<LEN>]
 792 \end_layout
 793
 794 \begin_layout Description
 795 Params <NAME>: normal, protected, thin, quad, qquad, enspace, enskip, negthinspa
 796 ce, hfill, hfill*, dotfill, hrulefill, hspace, hspace*
 797 \begin_inset Newline newline
 798 \end_inset
 799
 800 <LEN>: length for custom spaces (hspace, hspace* for protected)
 801 \end_layout
 802
 803 \begin_layout Description
 804 Origin JSpitzm, 20 May 2003, Mar 17 2008
 805 \end_layout
 806
 807 \begin_layout Subsection*
 808 LFUN_HYPERLINK_INSERT
 809 \end_layout
 810
 811 \begin_layout Description
 812 Action Inserts hyperlinks into the document (clickable in pdf output).
 813 \end_layout
 814
 815 \begin_layout Description
 816 Notion Hyperlink target can be set via selection + hyperlink-insert function.
 817 \end_layout
 818
 819 \begin_layout Description
 820 Syntax href-insert [<TARGET>]
 821 \end_layout
 822
 823 \begin_layout Description
 824 Origin CFO-G, 21 Nov 1997
 825 \end_layout
 826
 827 \begin_layout Subsection*
 828 LFUN_SPECIALCHAR_INSERT
 829 \end_layout
 830
 831 \begin_layout Description
 832 Action Inserts various characters into the document.
 833 \end_layout
 834
 835 \begin_layout Description
 836 Syntax specialchar-insert <CHAR>
 837 \end_layout
 838
 839 \begin_layout Description
 840 Params <CHAR>: hyphenation, ligature-break, slash, nobreakdash, dots, end-of-sen
 841 tence, menu-separator.
 842 \end_layout
 843
 844 \begin_layout Description
 845 Origin JSpitzm, 6 Dec 2007
 846 \end_layout
 847
 848 \begin_layout Subsection*
 849 LFUN_TOC_INSERT
 850 \end_layout
 851
 852 \begin_layout Description
 853 Action Inserts table of contents.
 854 \end_layout
 855
 856 \begin_layout Description
 857 Syntax toc-insert
 858 \end_layout
 859
 860 \begin_layout Description
 861 Origin Lgb, 27 May 97
 862 \end_layout
 863
 864 \begin_layout Subsection*
 865 LFUN_APPENDIX
 866 \end_layout
 867
 868 \begin_layout Description
 869 Action Start (or remove) Appendix on the given cursor position.
 870 \end_layout
 871
 872 \begin_layout Description
 873 Syntax appendix
 874 \end_layout
 875
 876 \begin_layout Description
 877 Origin ettrich, 5 May 1998
 878 \end_layout
 879
 880 \begin_layout Subsection*
 881 LFUN_INDEX_INSERT
 882 \end_layout
 883
 884 \begin_layout Description
 885 Action Inserts Index entry.
 886 \end_layout
 887
 888 \begin_layout Description
 889 Notion It automatically takes the word on the cursor position.
 890 \end_layout
 891
 892 \begin_layout Description
 893 Syntax index-insert [<TYPE:Name>]
 894 \end_layout
 895
 896 \begin_layout Description
 897 Params <TYPE:Name>: name of the index, if multiple indices are defined.
 898  with an empty argument, the default index is selected.
 899 \end_layout
 900
 901 \begin_layout Description
 902 Origin leeming, 3 Aug 2000
 903 \end_layout
 904
 905 \begin_layout Subsection*
 906 LFUN_INDEX_PRINT
 907 \end_layout
 908
 909 \begin_layout Description
 910 Action Inserts list of Index entries on a new page.
 911 \end_layout
 912
 913 \begin_layout Description
 914 Syntax index-print [<TYPE:Name>]
 915 \end_layout
 916
 917 \begin_layout Description
 918 Params <TYPE:Name>: name of the index, if multiple indices are defined.
 919  with an empty argument, the default index is selected.
 920 \end_layout
 921
 922 \begin_layout Description
 923 Origin Lgb, 27 Feb 1997
 924 \end_layout
 925
 926 \begin_layout Subsection*
 927 LFUN_NOMENCL_INSERT
 928 \end_layout
 929
 930 \begin_layout Description
 931 Action Inserts Nomenclature entry.
 932 \end_layout
 933
 934 \begin_layout Description
 935 Notion It automatically takes the word on the cursor position if no symbol
 936  is given.
 937 \end_layout
 938
 939 \begin_layout Description
 940 Syntax nomencl-insert [<SYMBOL>]
 941 \end_layout
 942
 943 \begin_layout Description
 944 Origin Ugras, 4 Nov 2006
 945 \end_layout
 946
 947 \begin_layout Subsection*
 948 LFUN_NOMENCLATURE_PRINT
 949 \end_layout
 950
 951 \begin_layout Description
 952 Action Inserts list of Nomenclature entries.
 953 \end_layout
 954
 955 \begin_layout Description
 956 Syntax nomenclature-print
 957 \end_layout
 958
 959 \begin_layout Description
 960 Origin Ugras, 4 Nov 2006
 961 \end_layout
 962
 963 \begin_layout Subsection*
 964 LFUN_NOTE_INSERT
 965 \end_layout
 966
 967 \begin_layout Description
 968 Action Inserts Note on the current cursor postion, move selection inside
 969  the inset.
 970 \end_layout
 971
 972 \begin_layout Description
 973 Syntax note-insert [<TYPE>]
 974 \end_layout
 975
 976 \begin_layout Description
 977 Params <TYPE>: <Note|Greyedout|Comment> default: Note
 978 \end_layout
 979
 980 \begin_layout Subsection*
 981 LFUN_NOTE_NEXT
 982 \end_layout
 983
 984 \begin_layout Description
 985 Action Moves the cursor to the begining of next Note inset.
 986 \end_layout
 987
 988 \begin_layout Description
 989 Syntax note-next
 990 \end_layout
 991
 992 \begin_layout Subsection*
 993 LFUN_NOTES_MUTATE
 994 \end_layout
 995
 996 \begin_layout Description
 997 Action Changes all Note insets of a particular type (source) to a different
 998  type (target) fot the current document.
 999 \end_layout
1000
1001 \begin_layout Description
1002 Syntax notes-mutate <SOURCE> <TARGET>
1003 \end_layout
1004
1005 \begin_layout Description
1006 Params <SOURCE/TARGET>: Note|Comment|Greyedout
1007 \end_layout
1008
1009 \begin_layout Description
1010 Origin sanda, 18 Jun 2008
1011 \end_layout
1012
1013 \begin_layout Subsection*
1014 LFUN_PHANTOM_INSERT
1015 \end_layout
1016
1017 \begin_layout Description
1018 Action Inserts phantom on the current cursor postion, move selection inside
1019  the inset.
1020 \end_layout
1021
1022 \begin_layout Description
1023 Syntax phantom-insert [<TYPE>]
1024 \end_layout
1025
1026 \begin_layout Description
1027 Params <TYPE>: <Phantom|HPhantom|VPhantom> default: Phantom
1028 \end_layout
1029
1030 \begin_layout Description
1031 Origin uwestoehr, 30 Jan 2009
1032 \end_layout
1033
1034 \begin_layout Subsection*
1035 LFUN_NEWLINE_INSERT
1036 \end_layout
1037
1038 \begin_layout Description
1039 Action Inserts a line break or new line.
1040 \end_layout
1041
1042 \begin_layout Description
1043 Syntax newline-insert [<ARG>]
1044 \end_layout
1045
1046 \begin_layout Description
1047 Params <ARG>: <newline|linebreak> default: newline
1048 \end_layout
1049
1050 \begin_layout Description
1051 Origin JSpitzm, 25 Mar 2008
1052 \end_layout
1053
1054 \begin_layout Subsection*
1055 LFUN_ESCAPE
1056 \end_layout
1057
1058 \begin_layout Description
1059 Action Clears the selection.
1060  If no text is selected call LFUN_FINISHED_FORWARD.
1061 \end_layout
1062
1063 \begin_layout Description
1064 Syntax escape
1065 \end_layout
1066
1067 \begin_layout Description
1068 Origin Lgb, 17 May 2001
1069 \end_layout
1070
1071 \begin_layout Subsection*
1072 LFUN_DOWN
1073 \end_layout
1074
1075 \begin_layout Description
1076 Action Moves the cursor one line in downward direction.
1077 \end_layout
1078
1079 \begin_layout Description
1080 Syntax down
1081 \end_layout
1082
1083 \begin_layout Subsection*
1084 LFUN_UP
1085 \end_layout
1086
1087 \begin_layout Description
1088 Action Moves the cursor one line in upward direction.
1089 \end_layout
1090
1091 \begin_layout Description
1092 Syntax up
1093 \end_layout
1094
1095 \begin_layout Subsection*
1096 LFUN_DOWN_SELECT
1097 \end_layout
1098
1099 \begin_layout Description
1100 Action Moves the cursor one line in downward direction adding the current
1101  position to the selection.
1102 \end_layout
1103
1104 \begin_layout Description
1105 Syntax down-select
1106 \end_layout
1107
1108 \begin_layout Subsection*
1109 LFUN_UP_SELECT
1110 \end_layout
1111
1112 \begin_layout Description
1113 Action Moves the cursor one line in upward direction adding the current
1114  position to the selection.
1115 \end_layout
1116
1117 \begin_layout Description
1118 Syntax up-select
1119 \end_layout
1120
1121 \begin_layout Subsection*
1122 LFUN_SCREEN_DOWN
1123 \end_layout
1124
1125 \begin_layout Description
1126 Action Moves the cursor one page in downward direction.
1127 \end_layout
1128
1129 \begin_layout Description
1130 Syntax screen-down
1131 \end_layout
1132
1133 \begin_layout Subsection*
1134 LFUN_SCREEN_UP
1135 \end_layout
1136
1137 \begin_layout Description
1138 Action Moves the cursor one page in upward direction.
1139 \end_layout
1140
1141 \begin_layout Description
1142 Syntax screen-up
1143 \end_layout
1144
1145 \begin_layout Subsection*
1146 LFUN_SCREEN_DOWN_SELECT
1147 \end_layout
1148
1149 \begin_layout Description
1150 Action Moves the cursor one screen in downward direction adding the current
1151  position to the selection.
1152 \end_layout
1153
1154 \begin_layout Description
1155 Syntax screen-down-select
1156 \end_layout
1157
1158 \begin_layout Subsection*
1159 LFUN_SCREEN_UP_SELECT
1160 \end_layout
1161
1162 \begin_layout Description
1163 Action Moves the cursor one page in upward direction adding the current
1164  position to the selection.
1165 \end_layout
1166
1167 \begin_layout Description
1168 Syntax screen-up-select
1169 \end_layout
1170
1171 \begin_layout Subsection*
1172 LFUN_SCROLL
1173 \end_layout
1174
1175 \begin_layout Description
1176 Action Scroll the buffer view.
1177 \end_layout
1178
1179 \begin_layout Description
1180 Notion Only scrolls the screen up or down; does not move the cursor.
1181 \end_layout
1182
1183 \begin_layout Description
1184 Syntax scroll <TYPE> <QUANTITY>
1185 \end_layout
1186
1187 \begin_layout Description
1188 Params <TYPE>:  line|page
1189 \begin_inset Newline newline
1190 \end_inset
1191
1192 <QUANTITY>: up|down|<number>
1193 \end_layout
1194
1195 \begin_layout Description
1196 Origin Abdel, Dec 27 2007
1197 \end_layout
1198
1199 \begin_layout Subsection*
1200 LFUN_SCREEN_RECENTER
1201 \end_layout
1202
1203 \begin_layout Description
1204 Action Recenters the screen on the current cursor position.
1205 \end_layout
1206
1207 \begin_layout Description
1208 Syntax screen-recenter
1209 \end_layout
1210
1211 \begin_layout Subsection*
1212 LFUN_SCREEN_SHOW_CURSOR
1213 \end_layout
1214
1215 \begin_layout Description
1216 Action Repositions the screen such that the cursor is visible.
1217 \end_layout
1218
1219 \begin_layout Description
1220 Syntax screen-show-cursor
1221 \end_layout
1222
1223 \begin_layout Description
1224 Origin vfr, 25 Mar 2009
1225 \end_layout
1226
1227 \begin_layout Subsection*
1228 LFUN_CHAR_BACKWARD
1229 \end_layout
1230
1231 \begin_layout Description
1232 Action Moves the cursor one position logically backwards.
1233 \end_layout
1234
1235 \begin_layout Description
1236 Notion This is not the action which should be bound to the arrow keys, because
1237  backwards may be left or right, depending on the language.
1238  The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1239  which in turn may employ this one.
1240 \end_layout
1241
1242 \begin_layout Description
1243 Syntax char-backward
1244 \end_layout
1245
1246 \begin_layout Subsection*
1247 LFUN_CHAR_BACKWARD_SELECT
1248 \end_layout
1249
1250 \begin_layout Description
1251 Action Moves the cursor one position logically backwards, adding traversed
1252  position to the selection.
1253 \end_layout
1254
1255 \begin_layout Description
1256 Notion See also LFUN_CHAR_BACKWARD.
1257 \end_layout
1258
1259 \begin_layout Description
1260 Syntax char-backward-select
1261 \end_layout
1262
1263 \begin_layout Subsection*
1264 LFUN_CHAR_DELETE_BACKWARD
1265 \end_layout
1266
1267 \begin_layout Description
1268 Action Deletes one character in the backward direction (usually the "BackSpace"
1269  key).
1270 \end_layout
1271
1272 \begin_layout Description
1273 Syntax char-delete-backward
1274 \end_layout
1275
1276 \begin_layout Subsection*
1277 LFUN_CHAR_DELETE_FORWARD
1278 \end_layout
1279
1280 \begin_layout Description
1281 Action Deletes one character in the backward direction (usually the "Delete"
1282  key).
1283 \end_layout
1284
1285 \begin_layout Description
1286 Syntax char-delete-forward
1287 \end_layout
1288
1289 \begin_layout Subsection*
1290 LFUN_CHAR_FORWARD
1291 \end_layout
1292
1293 \begin_layout Description
1294 Action Moves the cursor one position logically forward.
1295 \end_layout
1296
1297 \begin_layout Description
1298 Notion This is not the action which should be bound to the arrow keys, because
1299  forward may be left or right, depending on the language.
1300  The arrow keys should be bound to LFUN_CHAR_LEFT or LFUN_CHAR_RIGHT actions,
1301  which in turn may employ this one.
1302 \end_layout
1303
1304 \begin_layout Description
1305 Syntax char-forward
1306 \end_layout
1307
1308 \begin_layout Subsection*
1309 LFUN_CHAR_FORWARD_SELECT
1310 \end_layout
1311
1312 \begin_layout Description
1313 Action Moves the cursor one position logically forward, adding traversed
1314  position to the selection.
1315 \end_layout
1316
1317 \begin_layout Description
1318 Notion See also LFUN_CHAR_FORWARD.
1319 \end_layout
1320
1321 \begin_layout Description
1322 Syntax char-forward-select
1323 \end_layout
1324
1325 \begin_layout Subsection*
1326 LFUN_CHAR_LEFT
1327 \end_layout
1328
1329 \begin_layout Description
1330 Action Moves the cursor one position "to the left".
1331 \end_layout
1332
1333 \begin_layout Description
1334 Notion This is the action which should be taken when the "left" key is pressed.
1335  Generally, it moves the cursor one position to the left.
1336  However, in Bidi text this become slightly more complicated, and there
1337  are different modes of cursor movement.
1338  In "visual mode", this moves left, plain and simple.
1339  In "logical mode", movement is logically forward in RTL paragraphs, and
1340  logically backwards in LTR paragraphs.
1341 \end_layout
1342
1343 \begin_layout Description
1344 Syntax char-left
1345 \end_layout
1346
1347 \begin_layout Subsection*
1348 LFUN_CHAR_LEFT_SELECT
1349 \end_layout
1350
1351 \begin_layout Description
1352 Action Moves the cursor one position "to the left", adding traversed position
1353  to the selection.
1354 \end_layout
1355
1356 \begin_layout Description
1357 Notion See also LFUN_CHAR_LEFT for exact details of the movement.
1358 \end_layout
1359
1360 \begin_layout Description
1361 Syntax char-left-select
1362 \end_layout
1363
1364 \begin_layout Subsection*
1365 LFUN_CHAR_RIGHT
1366 \end_layout
1367
1368 \begin_layout Description
1369 Action Moves the cursor one position "to the right".
1370 \end_layout
1371
1372 \begin_layout Description
1373 Notion This is the action which should be taken when the "right" key is
1374  pressed.
1375  Generally, it moves the cursor one position to the right.
1376  However, in Bidi text this become slightly more complicated, and there
1377  are different modes of cursor movement.
1378  In "visual mode", this moves right, plain and simple.
1379  In "logical mode", movement is logically forward in LTR paragraphs, and
1380  logically backwards in RTL paragraphs.
1381 \end_layout
1382
1383 \begin_layout Description
1384 Syntax char-right
1385 \end_layout
1386
1387 \begin_layout Subsection*
1388 LFUN_CHAR_RIGHT_SELECT
1389 \end_layout
1390
1391 \begin_layout Description
1392 Action Moves the cursor one position "to the right", adding traversed position
1393  to the selection.
1394 \end_layout
1395
1396 \begin_layout Description
1397 Notion See also LFUN_CHAR_RIGHT for exact details of the movement.
1398 \end_layout
1399
1400 \begin_layout Description
1401 Syntax char-right-select
1402 \end_layout
1403
1404 \begin_layout Subsection*
1405 LFUN_WORD_BACKWARD
1406 \end_layout
1407
1408 \begin_layout Description
1409 Action Moves the cursor to the logically previous beginning of a word.
1410 \end_layout
1411
1412 \begin_layout Description
1413 Notion This is not the action which should be bound to the arrow keys, because
1414  backwards may be left or right, depending on the language.
1415  The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1416  which in turn may employ this one.
1417 \end_layout
1418
1419 \begin_layout Description
1420 Syntax word-backward
1421 \end_layout
1422
1423 \begin_layout Subsection*
1424 LFUN_WORD_BACKWARD_SELECT
1425 \end_layout
1426
1427 \begin_layout Description
1428 Action Moves the cursor to the logically previous beginning of a word, adding
1429  the logically traversed text to the selection.
1430 \end_layout
1431
1432 \begin_layout Description
1433 Notion See also LFUN_WORD_BACKWARD.
1434 \end_layout
1435
1436 \begin_layout Description
1437 Syntax word-backward-select
1438 \end_layout
1439
1440 \begin_layout Subsection*
1441 LFUN_WORD_DELETE_BACKWARD
1442 \end_layout
1443
1444 \begin_layout Description
1445 Action Deletes characters to the begining of the word (usually the "C+BackSpace"
1446  key).
1447 \end_layout
1448
1449 \begin_layout Description
1450 Syntax word-delete-backward
1451 \end_layout
1452
1453 \begin_layout Subsection*
1454 LFUN_WORD_DELETE_FORWARD
1455 \end_layout
1456
1457 \begin_layout Description
1458 Action Deletes characters to the end of the word (usually the "C+Delete"
1459  key).
1460 \end_layout
1461
1462 \begin_layout Description
1463 Syntax word-delete-forward
1464 \end_layout
1465
1466 \begin_layout Subsection*
1467 LFUN_WORD_FIND_FORWARD
1468 \end_layout
1469
1470 \begin_layout Description
1471 Action Search for a given string in forward direction.
1472 \end_layout
1473
1474 \begin_layout Description
1475 Notion Case sensitive, match words.
1476  If no argument given, last search repeated.
1477 \end_layout
1478
1479 \begin_layout Description
1480 Syntax word-find-forward [<STRING>]
1481 \end_layout
1482
1483 \begin_layout Description
1484 Origin Etienne, 16 Feb 1998
1485 \end_layout
1486
1487 \begin_layout Subsection*
1488 LFUN_WORD_FIND_BACKWARD
1489 \end_layout
1490
1491 \begin_layout Description
1492 Action Search for a given string in backward direction.
1493 \end_layout
1494
1495 \begin_layout Description
1496 Notion Case sensitive, match words.
1497  If no argument given, last search repeated.
1498 \end_layout
1499
1500 \begin_layout Description
1501 Syntax word-find-backward [<STRING>]
1502 \end_layout
1503
1504 \begin_layout Description
1505 Origin Etienne, 20 Feb 1998
1506 \end_layout
1507
1508 \begin_layout Subsection*
1509 LFUN_WORD_FIND
1510 \end_layout
1511
1512 \begin_layout Description
1513 Action Search for next occurence of a string.
1514 \end_layout
1515
1516 \begin_layout Description
1517 Syntax word-find [<DATA>]
1518 \end_layout
1519
1520 \begin_layout Description
1521 Params <DATA>: data encoded from Find dialog (see lyx::find2string()).
1522  If no parameter is given, search with last find-dialog data is used for
1523  search (i.e.
1524  find-next).
1525 \end_layout
1526
1527 \begin_layout Description
1528 Origin Andre, Jan 7 2004
1529 \end_layout
1530
1531 \begin_layout Subsection*
1532 LFUN_WORD_REPLACE
1533 \end_layout
1534
1535 \begin_layout Description
1536 Action Replace a string in the document.
1537 \end_layout
1538
1539 \begin_layout Description
1540 Syntax word-replace [<DATA>]
1541 \end_layout
1542
1543 \begin_layout Description
1544 Params <DATA>: data is of the form "<replace>
1545 \begin_inset Newline newline
1546 \end_inset
1547
1548 <search>
1549 \begin_inset Newline newline
1550 \end_inset
1551
1552 <casesensitive> <matchword> <all> <forward>"
1553 \end_layout
1554
1555 \begin_layout Description
1556 Origin Andre, Jan 7 2004
1557 \end_layout
1558
1559 \begin_layout Subsection*
1560 LFUN_WORD_FINDADV
1561 \end_layout
1562
1563 \begin_layout Description
1564 Action Search for next occurence of a pattern.
1565 \end_layout
1566
1567 \begin_layout Description
1568 Syntax word-findadv [<DATA>]
1569 \end_layout
1570
1571 \begin_layout Description
1572 Params <DATA>: data encoded from FindAdv dialog (see lyx::findadv2string()).
1573  If no parameter is given, search with last find-dialog data is used for
1574  search (i.e.
1575  find-next).
1576 \end_layout
1577
1578 \begin_layout Description
1579 Origin Tommaso, Nov 15 2007
1580 \end_layout
1581
1582 \begin_layout Subsection*
1583 LFUN_WORD_FORWARD
1584 \end_layout
1585
1586 \begin_layout Description
1587 Action Moves the cursor to the logically next beginning of a word.
1588 \end_layout
1589
1590 \begin_layout Description
1591 Notion This is not the action which should be bound to the arrow keys, because
1592  forward may be left or right, depending on the language.
1593  The arrow keys should be bound to LFUN_WORD_LEFT or LFUN_WORD_RIGHT actions,
1594  which in turn may employ this one.
1595 \end_layout
1596
1597 \begin_layout Description
1598 Syntax word-forward
1599 \end_layout
1600
1601 \begin_layout Subsection*
1602 LFUN_WORD_FORWARD_SELECT
1603 \end_layout
1604
1605 \begin_layout Description
1606 Action Moves the cursor to the logically next beginning of a word, adding
1607  the logically traversed text to the selection.
1608 \end_layout
1609
1610 \begin_layout Description
1611 Notion See also LFUN_WORD_FORWARD.
1612 \end_layout
1613
1614 \begin_layout Description
1615 Syntax word-forward-select
1616 \end_layout
1617
1618 \begin_layout Subsection*
1619 LFUN_WORD_LEFT
1620 \end_layout
1621
1622 \begin_layout Description
1623 Action Moves the cursor to the next beginning of a word "on the left".
1624 \end_layout
1625
1626 \begin_layout Description
1627 Notion This is the action which should be taken when the (e.g., ctrl-) "left"
1628  key is pressed.
1629  Generally, it moves the cursor to the next beginning of a word on the left.
1630  However, in Bidi text this become slightly more complicated, and there
1631  are different modes of cursor movement.
1632  In "visual mode", this moves left, plain and simple.
1633  In "logical mode", movement is logically forward in RTL paragraphs, and
1634  logically backwards in LTR paragraphs.
1635 \end_layout
1636
1637 \begin_layout Description
1638 Syntax word-left
1639 \end_layout
1640
1641 \begin_layout Description
1642 Origin dov, 28 Oct 2007
1643 \end_layout
1644
1645 \begin_layout Subsection*
1646 LFUN_WORD_LEFT_SELECT
1647 \end_layout
1648
1649 \begin_layout Description
1650 Action Moves the cursor to the next beginning of a word "on the left", adding
1651  *logically* traversed text to the selection.
1652 \end_layout
1653
1654 \begin_layout Description
1655 Notion See also LFUN_WORD_LEFT for exact details of the movement.
1656 \end_layout
1657
1658 \begin_layout Description
1659 Syntax word-left-select
1660 \end_layout
1661
1662 \begin_layout Description
1663 Origin dov, 28 Oct 2007
1664 \end_layout
1665
1666 \begin_layout Subsection*
1667 LFUN_WORD_RIGHT
1668 \end_layout
1669
1670 \begin_layout Description
1671 Action Moves the cursor to the next beginning of a word "on the right".
1672 \end_layout
1673
1674 \begin_layout Description
1675 Notion This is the action which should be taken when the (e.g., ctrl-) "right"
1676  key is pressed.
1677  Generally, it moves the cursor to the next beginning of a word on the right.
1678  However, in Bidi text this become slightly more complicated, and there
1679  are different modes of cursor movement.
1680  In "visual mode", this moves right, plain and simple.
1681  In "logical mode", movement is logically forward in LTR paragraphs, and
1682  logically backwards in RTL paragraphs.
1683 \end_layout
1684
1685 \begin_layout Description
1686 Syntax word-right
1687 \end_layout
1688
1689 \begin_layout Description
1690 Origin dov, 28 Oct 2007
1691 \end_layout
1692
1693 \begin_layout Subsection*
1694 LFUN_WORD_RIGHT_SELECT
1695 \end_layout
1696
1697 \begin_layout Description
1698 Action Moves the cursor to the next beginning of a word "on the right",
1699  adding *logically* traversed text to the selection.
1700 \end_layout
1701
1702 \begin_layout Description
1703 Notion See also LFUN_WORD_RIGHT for exact details of the movement.
1704 \end_layout
1705
1706 \begin_layout Description
1707 Syntax word-right-select
1708 \end_layout
1709
1710 \begin_layout Description
1711 Origin dov, 28 Oct 2007
1712 \end_layout
1713
1714 \begin_layout Subsection*
1715 LFUN_WORD_SELECT
1716 \end_layout
1717
1718 \begin_layout Description
1719 Action Puts the word where the cursor stands into the selection.
1720 \end_layout
1721
1722 \begin_layout Description
1723 Syntax word-select
1724 \end_layout
1725
1726 \begin_layout Description
1727 Origin Andre, 11 Sep 2002
1728 \end_layout
1729
1730 \begin_layout Subsection*
1731 LFUN_WORD_CAPITALIZE
1732 \end_layout
1733
1734 \begin_layout Description
1735 Action Capitalizes the words in the selection (i.e.
1736  the first letters) or the letter on the cursor position.
1737 \end_layout
1738
1739 \begin_layout Description
1740 Syntax word-capitalize
1741 \end_layout
1742
1743 \begin_layout Subsection*
1744 LFUN_WORD_UPCASE
1745 \end_layout
1746
1747 \begin_layout Description
1748 Action Change the words in the selection or from the cursor position to
1749  the end of word to the upper case.
1750 \end_layout
1751
1752 \begin_layout Description
1753 Syntax word-upcase
1754 \end_layout
1755
1756 \begin_layout Subsection*
1757 LFUN_WORD_LOWCASE
1758 \end_layout
1759
1760 \begin_layout Description
1761 Action Change the words in the selection or from the cursor position to
1762  the end of word to the lower case.
1763 \end_layout
1764
1765 \begin_layout Description
1766 Syntax word-lowcase
1767 \end_layout
1768
1769 \begin_layout Subsection*
1770 LFUN_THESAURUS_ENTRY
1771 \end_layout
1772
1773 \begin_layout Description
1774 Action Look up thesaurus entries with respect to the word under the cursor.
1775 \end_layout
1776
1777 \begin_layout Description
1778 Syntax thesaurus-entry [<STRING>] [lang=<LANG>]
1779 \end_layout
1780
1781 \begin_layout Description
1782 Params <STRING>: word to look up <LANG>: language (see file languages)
1783 \end_layout
1784
1785 \begin_layout Description
1786 Origin Levon, 20 Jul 2001
1787 \end_layout
1788
1789 \begin_layout Subsection*
1790 LFUN_BUFFER_BEGIN
1791 \end_layout
1792
1793 \begin_layout Description
1794 Action Move the cursor to the beginning of the document.
1795 \end_layout
1796
1797 \begin_layout Description
1798 Syntax buffer-begin
1799 \end_layout
1800
1801 \begin_layout Subsection*
1802 LFUN_BUFFER_BEGIN_SELECT
1803 \end_layout
1804
1805 \begin_layout Description
1806 Action Move the cursor to the beginning of the document adding the traversed
1807  text to the selection.
1808 \end_layout
1809
1810 \begin_layout Description
1811 Syntax buffer-begin-select
1812 \end_layout
1813
1814 \begin_layout Subsection*
1815 LFUN_BUFFER_END
1816 \end_layout
1817
1818 \begin_layout Description
1819 Action Move the cursor to the end of the document.
1820 \end_layout
1821
1822 \begin_layout Description
1823 Syntax buffer-end
1824 \end_layout
1825
1826 \begin_layout Subsection*
1827 LFUN_BUFFER_END_SELECT
1828 \end_layout
1829
1830 \begin_layout Description
1831 Action Move the cursor to the end of the document adding the traversed text
1832  to the selection.
1833 \end_layout
1834
1835 \begin_layout Description
1836 Syntax buffer-end-select
1837 \end_layout
1838
1839 \begin_layout Subsection*
1840 LFUN_INSET_BEGIN
1841 \end_layout
1842
1843 \begin_layout Description
1844 Action Move the cursor to the beginning of the current inset if it is not
1845  already there, or at the beginning of the enclosing inset otherwise
1846 \end_layout
1847
1848 \begin_layout Description
1849 Syntax inset-begin
1850 \end_layout
1851
1852 \begin_layout Description
1853 Origin lasgouttes, 16 Mar 2009
1854 \end_layout
1855
1856 \begin_layout Subsection*
1857 LFUN_INSET_BEGIN_SELECT
1858 \end_layout
1859
1860 \begin_layout Description
1861 Action Move the cursor to the beginning of the current inset if it is not
1862  already there, or at the beginning of the enclosing inset otherwise (adding
1863  the traversed text to the selection).
1864 \end_layout
1865
1866 \begin_layout Description
1867 Syntax inset-begin-select
1868 \end_layout
1869
1870 \begin_layout Description
1871 Origin lasgouttes, 16 Mar 2009
1872 \end_layout
1873
1874 \begin_layout Subsection*
1875 LFUN_INSET_END
1876 \end_layout
1877
1878 \begin_layout Description
1879 Action Move the cursor to the end of the current inset if it is not already
1880  there, or at the end of the enclosing inset otherwise
1881 \end_layout
1882
1883 \begin_layout Description
1884 Syntax inset-end
1885 \end_layout
1886
1887 \begin_layout Description
1888 Origin lasgouttes, 16 Mar 2009
1889 \end_layout
1890
1891 \begin_layout Subsection*
1892 LFUN_INSET_END_SELECT
1893 \end_layout
1894
1895 \begin_layout Description
1896 Action Move the cursor to the end of the current inset if it is not already
1897  there, or at the end of the enclosing inset otherwise (adding the traversed
1898  text to the selection).
1899 \end_layout
1900
1901 \begin_layout Description
1902 Syntax inset-end-select
1903 \end_layout
1904
1905 \begin_layout Description
1906 Origin lasgouttes, 16 Mar 2009
1907 \end_layout
1908
1909 \begin_layout Subsection*
1910 LFUN_INSET_SELECT_ALL
1911 \end_layout
1912
1913 \begin_layout Description
1914 Action Selects all contents of an inset.
1915 \end_layout
1916
1917 \begin_layout Description
1918 Syntax inset-select-all
1919 \end_layout
1920
1921 \begin_layout Description
1922 Origin vfr, 22 Aug 2009
1923 \end_layout
1924
1925 \begin_layout Subsection*
1926 LFUN_LINE_BEGIN
1927 \end_layout
1928
1929 \begin_layout Description
1930 Action Move the cursor to the begining of the (screen) line.
1931 \end_layout
1932
1933 \begin_layout Description
1934 Syntax line-begin
1935 \end_layout
1936
1937 \begin_layout Subsection*
1938 LFUN_LINE_BEGIN_SELECT
1939 \end_layout
1940
1941 \begin_layout Description
1942 Action Move the cursor to the beginning of the (screen) line adding the
1943  traversed text to the selection.
1944 \end_layout
1945
1946 \begin_layout Description
1947 Syntax line-begin-select
1948 \end_layout
1949
1950 \begin_layout Subsection*
1951 LFUN_LINE_END
1952 \end_layout
1953
1954 \begin_layout Description
1955 Action Move the cursor to the end of the (screen) line.
1956 \end_layout
1957
1958 \begin_layout Description
1959 Syntax line-end
1960 \end_layout
1961
1962 \begin_layout Subsection*
1963 LFUN_LINE_END_SELECT
1964 \end_layout
1965
1966 \begin_layout Description
1967 Action Move the cursor to the end of the (screen) line adding the traversed
1968  text to the selection.
1969 \end_layout
1970
1971 \begin_layout Description
1972 Syntax line-end-select
1973 \end_layout
1974
1975 \begin_layout Subsection*
1976 LFUN_LINE_DELETE
1977 \end_layout
1978
1979 \begin_layout Description
1980 Action Deletes the letters to the end of the (screen) line or deletes the
1981  selection.
1982 \end_layout
1983
1984 \begin_layout Description
1985 Syntax line-delete-forward
1986 \end_layout
1987
1988 \begin_layout Subsection*
1989 LFUN_COPY
1990 \end_layout
1991
1992 \begin_layout Description
1993 Action Copies to the clipboard the last edit.
1994 \end_layout
1995
1996 \begin_layout Description
1997 Syntax copy
1998 \end_layout
1999
2000 \begin_layout Subsection*
2001 LFUN_CUT
2002 \end_layout
2003
2004 \begin_layout Description
2005 Action Cuts to the clipboard.
2006 \end_layout
2007
2008 \begin_layout Description
2009 Syntax cut
2010 \end_layout
2011
2012 \begin_layout Subsection*
2013 LFUN_PASTE
2014 \end_layout
2015
2016 \begin_layout Description
2017 Action Pastes material (text or picture) from the active clipboard.
2018 \end_layout
2019
2020 \begin_layout Description
2021 Syntax paste [<TYPE>|<NUM>]
2022 \end_layout
2023
2024 \begin_layout Description
2025 Params <TYPE>: emf|pdf|png|jpeg|linkback|wmf
2026 \begin_inset Newline newline
2027 \end_inset
2028
2029 <NUM>: number of the selection in the internal clipboard stack to be pasted.
2030 \end_layout
2031
2032 \begin_layout Subsection*
2033 LFUN_CLIPBOARD_PASTE
2034 \end_layout
2035
2036 \begin_layout Description
2037 Action Pastes text from the active clipboard.
2038 \end_layout
2039
2040 \begin_layout Description
2041 Syntax clipboard-paste [<ARG>]
2042 \end_layout
2043
2044 \begin_layout Description
2045 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2046  "Join lines".
2047 \end_layout
2048
2049 \begin_layout Description
2050 Origin baum, 10 Jul 2006
2051 \end_layout
2052
2053 \begin_layout Subsection*
2054 LFUN_PRIMARY_SELECTION_PASTE
2055 \end_layout
2056
2057 \begin_layout Description
2058 Action Pastes the currently text selected text.
2059 \end_layout
2060
2061 \begin_layout Description
2062 Notion Primary selection mechanism is linux-only thing.
2063 \end_layout
2064
2065 \begin_layout Description
2066 Syntax primary-selection-paste [<ARG>]
2067 \end_layout
2068
2069 \begin_layout Description
2070 Params <ARG>: "paragraph" will cause pasting as one paragraph, i.e.
2071  "Join lines".
2072 \end_layout
2073
2074 \begin_layout Subsection*
2075 LFUN_SELECTION_PASTE
2076 \end_layout
2077
2078 \begin_layout Description
2079 Action Pastes the text in permanent selection.
2080 \end_layout
2081
2082 \begin_layout Description
2083 Syntax selection-paste
2084 \end_layout
2085
2086 \begin_layout Subsection*
2087 LFUN_UNDO
2088 \end_layout
2089
2090 \begin_layout Description
2091 Action Undoes the last edit.
2092 \end_layout
2093
2094 \begin_layout Description
2095 Syntax undo
2096 \end_layout
2097
2098 \begin_layout Subsection*
2099 LFUN_REDO
2100 \end_layout
2101
2102 \begin_layout Description
2103 Action Redoes the last thing undone.
2104 \end_layout
2105
2106 \begin_layout Description
2107 Syntax redo
2108 \end_layout
2109
2110 \begin_layout Subsection*
2111 LFUN_REPEAT
2112 \end_layout
2113
2114 \begin_layout Description
2115 Action Repeat the given command.
2116 \end_layout
2117
2118 \begin_layout Description
2119 Syntax repeat <COUNT> <LFUN-COMMAND>
2120 \end_layout
2121
2122 \begin_layout Description
2123 Origin Andre, 27 Oct 2003
2124 \end_layout
2125
2126 \begin_layout Subsection*
2127 LFUN_CHARS_TRANSPOSE
2128 \end_layout
2129
2130 \begin_layout Description
2131 Action Transposes the character at the cursor with the one before it.
2132 \end_layout
2133
2134 \begin_layout Description
2135 Syntax chars-transpose
2136 \end_layout
2137
2138 \begin_layout Description
2139 Origin Lgb, 25 Apr 2001
2140 \end_layout
2141
2142 \begin_layout Subsection*
2143 LFUN_DEPTH_DECREMENT
2144 \end_layout
2145
2146 \begin_layout Description
2147 Action Decrease the nesting depth of the (selected) paragraph(s) inside
2148  lists.
2149 \end_layout
2150
2151 \begin_layout Description
2152 Syntax depth-decrement
2153 \end_layout
2154
2155 \begin_layout Subsection*
2156 LFUN_DEPTH_INCREMENT
2157 \end_layout
2158
2159 \begin_layout Description
2160 Action Increase the nesting depth of the (selected) paragraph(s) inside
2161  lists.
2162 \end_layout
2163
2164 \begin_layout Description
2165 Syntax depth-increment
2166 \end_layout
2167
2168 \begin_layout Subsection*
2169 LFUN_FONT_BOLD
2170 \end_layout
2171
2172 \begin_layout Description
2173 Action Toggles the bold font (selection-wise) using mathbf in math.
2174 \end_layout
2175
2176 \begin_layout Description
2177 Syntax font-bold
2178 \end_layout
2179
2180 \begin_layout Subsection*
2181 LFUN_FONT_BOLDSYMBOL
2182 \end_layout
2183
2184 \begin_layout Description
2185 Action Toggles the bold font (selection-wise) using boldsymbol in math.
2186 \end_layout
2187
2188 \begin_layout Description
2189 Syntax font-boldsymbol
2190 \end_layout
2191
2192 \begin_layout Subsection*
2193 LFUN_FONT_TYPEWRITER
2194 \end_layout
2195
2196 \begin_layout Description
2197 Action Toggles the typewriter family font (selection-wise).
2198 \end_layout
2199
2200 \begin_layout Description
2201 Syntax font-typewriter
2202 \end_layout
2203
2204 \begin_layout Subsection*
2205 LFUN_FONT_UNDERLINE
2206 \end_layout
2207
2208 \begin_layout Description
2209 Action Toggles underline in the font (selection-wise).
2210 \end_layout
2211
2212 \begin_layout Description
2213 Syntax font-underline
2214 \end_layout
2215
2216 \begin_layout Subsection*
2217 LFUN_FONT_UULINE
2218 \end_layout
2219
2220 \begin_layout Description
2221 Action Toggles double underline in the font (selection-wise).
2222 \end_layout
2223
2224 \begin_layout Description
2225 Syntax font-underunderline
2226 \end_layout
2227
2228 \begin_layout Description
2229 Origin sanda, 5 May 2009
2230 \end_layout
2231
2232 \begin_layout Subsection*
2233 LFUN_FONT_UWAVE
2234 \end_layout
2235
2236 \begin_layout Description
2237 Action Toggles wavy underline in the font (selection-wise).
2238 \end_layout
2239
2240 \begin_layout Description
2241 Syntax font-underwave
2242 \end_layout
2243
2244 \begin_layout Description
2245 Origin sanda, 5 May 2009
2246 \end_layout
2247
2248 \begin_layout Subsection*
2249 LFUN_FONT_STRIKEOUT
2250 \end_layout
2251
2252 \begin_layout Description
2253 Action Toggles strikeout (strike-through) in the font (selection-wise).
2254 \end_layout
2255
2256 \begin_layout Description
2257 Syntax font-strikeout
2258 \end_layout
2259
2260 \begin_layout Description
2261 Origin sanda, 3 May 2009
2262 \end_layout
2263
2264 \begin_layout Subsection*
2265 LFUN_FONT_EMPH
2266 \end_layout
2267
2268 \begin_layout Description
2269 Action Toggles the emphasis font style (selection-wise).
2270 \end_layout
2271
2272 \begin_layout Description
2273 Syntax font-emph
2274 \end_layout
2275
2276 \begin_layout Subsection*
2277 LFUN_FONT_NOUN
2278 \end_layout
2279
2280 \begin_layout Description
2281 Action Toggles Noun text style font (selection-wise).
2282 \end_layout
2283
2284 \begin_layout Description
2285 Syntax font-noun
2286 \end_layout
2287
2288 \begin_layout Subsection*
2289 LFUN_FONT_ROMAN
2290 \end_layout
2291
2292 \begin_layout Description
2293 Action Toggles Roman family font (selection-wise).
2294 \end_layout
2295
2296 \begin_layout Description
2297 Syntax font-roman
2298 \end_layout
2299
2300 \begin_layout Subsection*
2301 LFUN_FONT_SANS
2302 \end_layout
2303
2304 \begin_layout Description
2305 Action Toggles Sans Serif family font (selection-wise).
2306 \end_layout
2307
2308 \begin_layout Description
2309 Syntax font-sans
2310 \end_layout
2311
2312 \begin_layout Subsection*
2313 LFUN_FONT_FRAK
2314 \end_layout
2315
2316 \begin_layout Description
2317 Action Toggles Fraktur family font (math-mode, selection-wise).
2318 \end_layout
2319
2320 \begin_layout Description
2321 Syntax font-frak
2322 \end_layout
2323
2324 \begin_layout Description
2325 Origin vermeer, 10 Jan 2002
2326 \end_layout
2327
2328 \begin_layout Subsection*
2329 LFUN_FONT_ITAL
2330 \end_layout
2331
2332 \begin_layout Description
2333 Action Toggles Italics font shape (math-mode, selection-wise).
2334 \end_layout
2335
2336 \begin_layout Description
2337 Syntax font-ital
2338 \end_layout
2339
2340 \begin_layout Description
2341 Origin vermeer, 10 Jan 2002
2342 \end_layout
2343
2344 \begin_layout Subsection*
2345 LFUN_FONT_DEFAULT
2346 \end_layout
2347
2348 \begin_layout Description
2349 Action Reverts the settings of the font to the default values (selection-wise).
2350 \end_layout
2351
2352 \begin_layout Description
2353 Syntax font-default
2354 \end_layout
2355
2356 \begin_layout Subsection*
2357 LFUN_FONT_SIZE
2358 \end_layout
2359
2360 \begin_layout Description
2361 Action Sets font size according to lyx format string.
2362 \end_layout
2363
2364 \begin_layout Description
2365 Syntax font-size <SIZE>
2366 \end_layout
2367
2368 \begin_layout Description
2369 Params <SIZE>: tiny|scriptsize|footnotesize|small|normal|large|larger|
2370 \begin_inset Newline newline
2371 \end_inset
2372
2373 largest|huge|giant|increase|decrease|default
2374 \end_layout
2375
2376 \begin_layout Subsection*
2377 LFUN_TEXTSTYLE_APPLY
2378 \end_layout
2379
2380 \begin_layout Description
2381 Action Toggle user-defined (=last-time used) text style.
2382 \end_layout
2383
2384 \begin_layout Description
2385 Notion This style is set via LFUN_TEXTSTYLE_UPDATE, which is automatically
2386  trigerred when using Text Style dialog.
2387 \end_layout
2388
2389 \begin_layout Description
2390 Syntax textstyle-apply
2391 \end_layout
2392
2393 \begin_layout Description
2394 Origin leeming, 12 Mar 2003
2395 \end_layout
2396
2397 \begin_layout Subsection*
2398 LFUN_TEXTSTYLE_UPDATE
2399 \end_layout
2400
2401 \begin_layout Description
2402 Action Apply text style and update the settings to be used by LFUN_TEXTSTYLE_APP
2403 LY.
2404 \end_layout
2405
2406 \begin_layout Description
2407 Syntax textstyle-update <FONT_INFO>
2408 \end_layout
2409
2410 \begin_layout Description
2411 Params <FONT_INFO>: specifies font atributes, e.g.
2412  family, series, shape, size, emph, noun, underbar, number, color, language,
2413  toggleall.
2414 \begin_inset Newline newline
2415 \end_inset
2416
2417 Use lyx -dbg action for exact syntax of text-style dialog parameters.
2418 \end_layout
2419
2420 \begin_layout Description
2421 Origin leeming, 12 Mar 2003
2422 \end_layout
2423
2424 \begin_layout Subsection*
2425 LFUN_SCREEN_FONT_UPDATE
2426 \end_layout
2427
2428 \begin_layout Description
2429 Action Update fonts and its metrics.
2430 \end_layout
2431
2432 \begin_layout Description
2433 Notion Automatically called after zoom, dpi, font names, or norm change.
2434 \end_layout
2435
2436 \begin_layout Description
2437 Syntax screen-font-update
2438 \end_layout
2439
2440 \begin_layout Description
2441 Origin ARRae, 13 Aug 2000
2442 \end_layout
2443
2444 \begin_layout Subsection*
2445 LFUN_FONT_STATE
2446 \end_layout
2447
2448 \begin_layout Description
2449 Action Returns the info about the current font.
2450 \end_layout
2451
2452 \begin_layout Description
2453 Syntax font-state
2454 \end_layout
2455
2456 \begin_layout Subsection*
2457 LFUN_CITATION_INSERT
2458 \end_layout
2459
2460 \begin_layout Description
2461 Action Inserts citation from loaded citation database.
2462 \end_layout
2463
2464 \begin_layout Description
2465 Syntax citation-insert [<KEY>[|<TEXT_BEFORE>]]
2466 \end_layout
2467
2468 \begin_layout Description
2469 Params <KEY>: Citation (shortcut listed in available citations).
2470 \begin_inset Newline newline
2471 \end_inset
2472
2473 <TEXT_BEFORE>: text which should appear before citation.
2474 \end_layout
2475
2476 \begin_layout Description
2477 Origin AAS, 97-02-23
2478 \end_layout
2479
2480 \begin_layout Subsection*
2481 LFUN_BIBTEX_DATABASE_ADD
2482 \end_layout
2483
2484 \begin_layout Description
2485 Action Adds database, which will be used for bibtex citations.
2486 \end_layout
2487
2488 \begin_layout Description
2489 Notion Databases are added to the first BibTeX inset (Inset->List/TOC->BibTeX
2490  bibliography) found from the cursor postion.
2491 \end_layout
2492
2493 \begin_layout Description
2494 Syntax bibtex-database-add <DATABASE-NAME>
2495 \end_layout
2496
2497 \begin_layout Description
2498 Origin Ale, 30 May 1997
2499 \end_layout
2500
2501 \begin_layout Subsection*
2502 LFUN_BIBTEX_DATABASE_DEL
2503 \end_layout
2504
2505 \begin_layout Description
2506 Action Adds database, which will be used for bibtex citations.
2507 \end_layout
2508
2509 \begin_layout Description
2510 Notion Databases are deleted from the first BibTeX inset (Inset->List/TOC->BibTe
2511 X bibliography) found from the cursor postion.
2512 \end_layout
2513
2514 \begin_layout Description
2515 Syntax bibtex-database-del <DATABASE-NAME>
2516 \end_layout
2517
2518 \begin_layout Description
2519 Origin Ale, 30 May 1997
2520 \end_layout
2521
2522 \begin_layout Subsection*
2523 LFUN_LAYOUT
2524 \end_layout
2525
2526 \begin_layout Description
2527 Action Sets the layout (that is, environment) for the current paragraph.
2528 \end_layout
2529
2530 \begin_layout Description
2531 Syntax layout <LAYOUT>
2532 \end_layout
2533
2534 \begin_layout Description
2535 Params <LAYOUT>: the layout to use
2536 \end_layout
2537
2538 \begin_layout Subsection*
2539 LFUN_LAYOUT_PARAGRAPH
2540 \end_layout
2541
2542 \begin_layout Description
2543 Action Launches the paragraph settings dialog.
2544 \end_layout
2545
2546 \begin_layout Description
2547 Syntax layout-paragraph
2548 \end_layout
2549
2550 \begin_layout Subsection*
2551 LFUN_LAYOUT_TABULAR
2552 \end_layout
2553
2554 \begin_layout Description
2555 Action Launches the tabular settings dialog.
2556 \end_layout
2557
2558 \begin_layout Description
2559 Syntax layout-tabular
2560 \end_layout
2561
2562 \begin_layout Description
2563 Origin Jug, 31 Jul 2000
2564 \end_layout
2565
2566 \begin_layout Subsection*
2567 LFUN_DROP_LAYOUTS_CHOICE
2568 \end_layout
2569
2570 \begin_layout Description
2571 Action Displays list of layout choices.
2572 \end_layout
2573
2574 \begin_layout Description
2575 Notion In the current (as of 2007) Qt4 frontend, this LFUN opens the dropbox
2576  allowing for choice of layout.
2577 \end_layout
2578
2579 \begin_layout Description
2580 Syntax drop-layouts-choice
2581 \end_layout
2582
2583 \begin_layout Subsection*
2584 LFUN_LAYOUT_MODULES_CLEAR
2585 \end_layout
2586
2587 \begin_layout Description
2588 Action Clears the module list.
2589 \end_layout
2590
2591 \begin_layout Description
2592 Notion Clears the list of included modules for the current buffer.
2593 \end_layout
2594
2595 \begin_layout Description
2596 Syntax layout-modules-clear
2597 \end_layout
2598
2599 \begin_layout Description
2600 Origin rgh, 25 August 2007
2601 \end_layout
2602
2603 \begin_layout Subsection*
2604 LFUN_LAYOUT_MODULE_ADD
2605 \end_layout
2606
2607 \begin_layout Description
2608 Action Adds a module.
2609 \end_layout
2610
2611 \begin_layout Description
2612 Notion Adds a module to the list of included modules for the current buffer.
2613 \end_layout
2614
2615 \begin_layout Description
2616 Syntax layout-module-add <MODULE>
2617 \end_layout
2618
2619 \begin_layout Description
2620 Params <MODULE>: the module to be added
2621 \end_layout
2622
2623 \begin_layout Description
2624 Origin rgh, 25 August 2007
2625 \end_layout
2626
2627 \begin_layout Subsection*
2628 LFUN_LAYOUT_RELOAD
2629 \end_layout
2630
2631 \begin_layout Description
2632 Action Reloads layout information.
2633 \end_layout
2634
2635 \begin_layout Description
2636 Notion Reloads all layout information for the current buffer from disk,
2637  thus recognizing any changes that have been made to layout files on the
2638  fly.
2639  This is intended to be used only by layout developers and should not be
2640  used when one is trying to do actual work.
2641 \end_layout
2642
2643 \begin_layout Description
2644 Syntax layout-reload
2645 \end_layout
2646
2647 \begin_layout Description
2648 Origin rgh, 3 September 2007
2649 \end_layout
2650
2651 \begin_layout Subsection*
2652 LFUN_TEXTCLASS_APPLY
2653 \end_layout
2654
2655 \begin_layout Description
2656 Action Sets the text class for the current buffer.
2657 \end_layout
2658
2659 \begin_layout Description
2660 Syntax textclass-apply <TEXTCLASS>
2661 \end_layout
2662
2663 \begin_layout Description
2664 Params <TEXTCLASS>: the textclass to set.
2665  Note that this must be the filename, minus the ".layout" extension.
2666 \end_layout
2667
2668 \begin_layout Subsection*
2669 LFUN_TEXTCLASS_LOAD
2670 \end_layout
2671
2672 \begin_layout Description
2673 Action Loads information for a textclass from disk.
2674 \end_layout
2675
2676 \begin_layout Description
2677 Syntax textclass-load <TEXTCLASS>
2678 \end_layout
2679
2680 \begin_layout Description
2681 Params <TEXTCLASS>: the textclass to load.
2682  Note that this must be the filename, minus the ".layout" extension.
2683 \end_layout
2684
2685 \begin_layout Subsection*
2686 LFUN_MARK_OFF
2687 \end_layout
2688
2689 \begin_layout Description
2690 Action Disable selecting of text-region.
2691 \end_layout
2692
2693 \begin_layout Description
2694 Syntax mark-off
2695 \end_layout
2696
2697 \begin_layout Subsection*
2698 LFUN_MARK_ON
2699 \end_layout
2700
2701 \begin_layout Description
2702 Action Enable selecting of text-region.
2703 \end_layout
2704
2705 \begin_layout Description
2706 Notion After enabling you can simply move arrow keys to get selected region.
2707 \end_layout
2708
2709 \begin_layout Description
2710 Syntax mark-on
2711 \end_layout
2712
2713 \begin_layout Subsection*
2714 LFUN_MARK_TOGGLE
2715 \end_layout
2716
2717 \begin_layout Description
2718 Action Toggle between LFUN_MARK_ON and LFUN_MARK_OFF .
2719 \end_layout
2720
2721 \begin_layout Description
2722 Syntax mark-toggle
2723 \end_layout
2724
2725 \begin_layout Description
2726 Origin Andre, May 5 2006
2727 \end_layout
2728
2729 \begin_layout Subsection*
2730 LFUN_MATH_DELIM
2731 \end_layout
2732
2733 \begin_layout Description
2734 Action Inserts math delimiters (e.g.
2735  parentheses, brackets) enclosing expression.
2736 \end_layout
2737
2738 \begin_layout Description
2739 Syntax math-delim [<LEFT>] [<RIGHT>]
2740 \end_layout
2741
2742 \begin_layout Description
2743 Params <LEFT/RIGHT>: Delimiters to be used.
2744  Each delimiter can be specified by either a LaTeX name or a valid character.
2745  ( is the default letter.
2746 \end_layout
2747
2748 \begin_layout Description
2749 Sample math-delim { rangle
2750 \end_layout
2751
2752 \begin_layout Description
2753 Origin Alejandro, 18 Jun 1996
2754 \end_layout
2755
2756 \begin_layout Subsection*
2757 LFUN_MATH_BIGDELIM
2758 \end_layout
2759
2760 \begin_layout Description
2761 Action Inserts math fixed size delimiters (e.g.
2762  parentheses, brackets) enclosing expression.
2763 \end_layout
2764
2765 \begin_layout Description
2766 Syntax math-bigdelim <LSIZE> <LDELIM> <RSIZE> <RDELIM>
2767 \end_layout
2768
2769 \begin_layout Description
2770 Params <L/RSIZE>: bigl/r|Bigl/r|biggl/r|Biggl/r
2771 \begin_inset Newline newline
2772 \end_inset
2773
2774 <L/RDELIM>: TeX code for delimiter.
2775  See Delimiter dialog for delimiters to be used.
2776 \end_layout
2777
2778 \begin_layout Description
2779 Sample math-bigdelim "Bigl" "
2780 \backslash
2781 Downarrow" "Bigr" "
2782 \backslash
2783 }"
2784 \end_layout
2785
2786 \begin_layout Description
2787 Origin Enrico & Georg, 7 May 2006
2788 \end_layout
2789
2790 \begin_layout Subsection*
2791 LFUN_MATH_DISPLAY
2792 \end_layout
2793
2794 \begin_layout Description
2795 Action Creates a new displayed equation in text mode.
2796  Toggles inlined/display formula in math mode.
2797 \end_layout
2798
2799 \begin_layout Description
2800 Syntax math-display [<ARG>]
2801 \end_layout
2802
2803 \begin_layout Description
2804 Params <ARG>: this argument will be passed to LFUN_MATH_INSERT when creating
2805  new equation from the text mode.
2806 \end_layout
2807
2808 \begin_layout Description
2809 Origin Alejandro, 18 Jun 1996
2810 \end_layout
2811
2812 \begin_layout Subsection*
2813 LFUN_MATH_INSERT
2814 \end_layout
2815
2816 \begin_layout Description
2817 Action Inserts math objects and symbols.
2818 \end_layout
2819
2820 \begin_layout Description
2821 Notion When <ARG> is a _single_ math inset with more than one cell (such
2822  as "x_y^z" or "
2823 \backslash
2824 frac{x}{y}"), the content of cell(0) is replaced by the current selection
2825  (only works if the selection is in mathed).
2826  As an example, if "abc" is selected in mathed, "math-insert
2827 \backslash
2828 frac{x}{y}" replaces "abc" with "
2829 \backslash
2830 frac{abc}{y}", and "math-insert x_y^z" replaces "abc" with "abc_y^z".
2831  If nothing is selected (or the selection is not in mathed), math-insert
2832  works as expected.
2833 \end_layout
2834
2835 \begin_layout Description
2836 Syntax math-insert <ARG>
2837 \end_layout
2838
2839 \begin_layout Description
2840 Params <ARG>: Symbol or LaTeX code to be inserted.
2841 \end_layout
2842
2843 \begin_layout Subsection*
2844 LFUN_MATH_SUBSCRIPT
2845 \end_layout
2846
2847 \begin_layout Description
2848 Action Enters subscript expression in math expression.
2849 \end_layout
2850
2851 \begin_layout Description
2852 Syntax math-subscript
2853 \end_layout
2854
2855 \begin_layout Description
2856 Origin vermeer, 12 Dec 2001
2857 \end_layout
2858
2859 \begin_layout Subsection*
2860 LFUN_MATH_SUPERSCRIPT
2861 \end_layout
2862
2863 \begin_layout Description
2864 Action Enters subscript expression in math expression.
2865 \end_layout
2866
2867 \begin_layout Description
2868 Syntax math-superscript
2869 \end_layout
2870
2871 \begin_layout Description
2872 Origin vermeer, 12 Dec 2001
2873 \end_layout
2874
2875 \begin_layout Subsection*
2876 LFUN_MATH_LIMITS
2877 \end_layout
2878
2879 \begin_layout Description
2880 Action Toggles the position of the limits from above/below to the right
2881  side an vice versa in integral symbol, a limit, a summation, etc.
2882 \end_layout
2883
2884 \begin_layout Description
2885 Notion Put the cursor before the symbol with the limits and then invoke
2886  math-limits.
2887 \end_layout
2888
2889 \begin_layout Description
2890 Syntax math-limits [<STATE>]
2891 \end_layout
2892
2893 \begin_layout Description
2894 Params <STATE>: limits|nolimits
2895 \end_layout
2896
2897 \begin_layout Subsection*
2898 LFUN_MATH_MACRO
2899 \end_layout
2900
2901 \begin_layout Description
2902 Action Inserts a math macro definition at the cursor position in the text.
2903 \end_layout
2904
2905 \begin_layout Description
2906 Syntax math-macro <NAME> [<NARGS>] [def]
2907 \end_layout
2908
2909 \begin_layout Description
2910 Params <NAME>: The name of the macro, e.g.
2911  "mymacro".
2912 \begin_inset Newline newline
2913 \end_inset
2914
2915 <NARGS>: The number of parameters of the macro.
2916  Default is 0.
2917  "def": Has no effect anymore, just for compatibility with former LyX versions.
2918 \end_layout
2919
2920 \begin_layout Description
2921 Origin ale, 10 May 1997;  sts, 21 Dec 2007
2922 \end_layout
2923
2924 \begin_layout Subsection*
2925 LFUN_MATH_MUTATE
2926 \end_layout
2927
2928 \begin_layout Description
2929 Action Mutates the type of math inset to the newly selected one.
2930 \end_layout
2931
2932 \begin_layout Description
2933 Syntax math-mutate <TYPE>
2934 \end_layout
2935
2936 \begin_layout Description
2937 Params <TYPE>: none|simple|equation|eqnarray|align|alignat|xalignat|xxalignat|
2938  multline|gather|flalign
2939 \end_layout
2940
2941 \begin_layout Description
2942 Origin Andre, 23 May 2001
2943 \end_layout
2944
2945 \begin_layout Subsection*
2946 LFUN_MATH_SPACE
2947 \end_layout
2948
2949 \begin_layout Description
2950 Action Inserts space into math expression.
2951 \end_layout
2952
2953 \begin_layout Description
2954 Notion Use spacebar after entering this space to change type of space.
2955 \end_layout
2956
2957 \begin_layout Description
2958 Syntax math-space [<TYPE>] [<LEN>]
2959 \end_layout
2960
2961 \begin_layout Description
2962 Params <TYPE>: negative spaces: !|negthinspace|negmedspace|negthickspace
2963 \begin_inset Newline newline
2964 \end_inset
2965
2966 positive spaces: ,|thinspace|:|medspace|;|thickspace|enskip|quad|qquad
2967 \begin_inset Newline newline
2968 \end_inset
2969
2970 custom space: hspace
2971 \begin_inset Newline newline
2972 \end_inset
2973
2974 "," used by default.
2975 \begin_inset Newline newline
2976 \end_inset
2977
2978 Note that ! is equivalent to negthinspace, , = thinspace, : = medspace,
2979  and ; = thickspace.
2980 \begin_inset Newline newline
2981 \end_inset
2982
2983 <LEN>: length for custom spaces (hspace)
2984 \end_layout
2985
2986 \begin_layout Description
2987 Origin Andre, 25 Jul 2001; sanda, 16 Jun 2008
2988 \end_layout
2989
2990 \begin_layout Subsection*
2991 LFUN_MATH_MATRIX
2992 \end_layout
2993
2994 \begin_layout Description
2995 Action Inserts a matrix.
2996 \end_layout
2997
2998 \begin_layout Description
2999 Syntax math-matrix <COLS> <ROWS> [<ALIGN>]
3000 \end_layout
3001
3002 \begin_layout Description
3003 Params <ALIGN>: Alignment is a word composed of the vertical alignment (b,
3004  c or t) (i.e.
3005  1 char) and the horizontal alignments (l, c or r) (i.e.
3006  <COL> chars).
3007 \end_layout
3008
3009 \begin_layout Description
3010 Sample math-matrix 3 3 bccc
3011 \end_layout
3012
3013 \begin_layout Subsection*
3014 LFUN_MATH_AMS_MATRIX
3015 \end_layout
3016
3017 \begin_layout Description
3018 Action Inserts a matrix.
3019 \end_layout
3020
3021 \begin_layout Description
3022 Syntax math-matrix <COLS> <ROWS> [<DECORATION>]
3023 \end_layout
3024
3025 \begin_layout Description
3026 Params <DECORATION>: Decoration determines the LaTeX name of the matrix
3027  that should be created.
3028 \end_layout
3029
3030 \begin_layout Description
3031 Sample math-ams-matrix 3 3 bmatrix
3032 \end_layout
3033
3034 \begin_layout Subsection*
3035 LFUN_MATH_MODE
3036 \end_layout
3037
3038 \begin_layout Description
3039 Action In text mode enters math mode (i.e.
3040  puts math insets on the current cursor position), in math mode enters text
3041  mode inside math expression.
3042 \end_layout
3043
3044 \begin_layout Description
3045 Notion If there is some selected text, it puts the text inside created math
3046  box.
3047 \end_layout
3048
3049 \begin_layout Description
3050 Syntax math-mode [on|<ARG>]
3051 \end_layout
3052
3053 \begin_layout Description
3054 Params <ARG>: eventual argument (LaTeX code) is passed to LFUN_MATH_INSERT
3055  .
3056 \begin_inset Newline newline
3057 \end_inset
3058
3059 "on": allow only entering of math mode from text mode.
3060 \end_layout
3061
3062 \begin_layout Description
3063 Origin Alejandro, 4 Jun 1996
3064 \end_layout
3065
3066 \begin_layout Subsection*
3067 LFUN_REGEXP_MODE
3068 \end_layout
3069
3070 \begin_layout Description
3071 Action Enters regexp mode (i.e., puts regexp insets on the current cursor
3072  position).
3073  Used by the advanced search dialog.
3074 \end_layout
3075
3076 \begin_layout Description
3077 Notion If there is any selected text, then it is moved inside the created
3078  regexp inset.
3079 \end_layout
3080
3081 \begin_layout Description
3082 Syntax regexp-mode [<ARG>]
3083 \end_layout
3084
3085 \begin_layout Description
3086 Params <ARG>: eventual argument (regular expression).
3087 \end_layout
3088
3089 \begin_layout Description
3090 Origin Tommaso, 4 Oct 2008
3091 \end_layout
3092
3093 \begin_layout Subsection*
3094 LFUN_MATH_NUMBER_LINE_TOGGLE
3095 \end_layout
3096
3097 \begin_layout Description
3098 Action Toggles numbering of the current formula line.
3099 \end_layout
3100
3101 \begin_layout Description
3102 Notion Must be in display formula mode.
3103 \end_layout
3104
3105 \begin_layout Description
3106 Syntax math-number-line-toggle
3107 \end_layout
3108
3109 \begin_layout Description
3110 Origin Alejandro, 18 Jun 1996
3111 \end_layout
3112
3113 \begin_layout Subsection*
3114 LFUN_MATH_NUMBER_TOGGLE
3115 \end_layout
3116
3117 \begin_layout Description
3118 Action Toggles numbering/labeling of the current formula.
3119 \end_layout
3120
3121 \begin_layout Description
3122 Notion Must be in display formula mode.
3123 \end_layout
3124
3125 \begin_layout Description
3126 Syntax math-number-toggle
3127 \end_layout
3128
3129 \begin_layout Description
3130 Origin Alejandro, 4 Jun 1996
3131 \end_layout
3132
3133 \begin_layout Subsection*
3134 LFUN_MATH_EXTERN
3135 \end_layout
3136
3137 \begin_layout Description
3138 Action Calls external program and passes the current expression/equation
3139  as an argument for the calculation in the format appropriate to the given
3140  language.
3141 \end_layout
3142
3143 \begin_layout Description
3144 Notion Selection can be used to determine the input for the external program.
3145 \end_layout
3146
3147 \begin_layout Description
3148 Syntax math-extern <LANG> [<COMMAND>]
3149 \end_layout
3150
3151 \begin_layout Description
3152 Params <LANG>: octave|maxima|maple|mathematica|script
3153 \begin_inset Newline newline
3154 \end_inset
3155
3156 where "script" stands fot the external script (normalized expression will
3157  be passed)
3158 \end_layout
3159
3160 \begin_layout Description
3161 Sample math-extern maple simplify
3162 \end_layout
3163
3164 \begin_layout Description
3165 Origin Andre, 24 Apr 2001
3166 \end_layout
3167
3168 \begin_layout Subsection*
3169 LFUN_MATH_SIZE
3170 \end_layout
3171
3172 \begin_layout Description
3173 Action Changes arbitrarily the size used by math fonts inside a context.
3174 \end_layout
3175
3176 \begin_layout Description
3177 Notion Provides an interface to the LaTeX math mode font size commands.
3178 \end_layout
3179
3180 \begin_layout Description
3181 Syntax math-size <STYLE>
3182 \end_layout
3183
3184 \begin_layout Description
3185 Params <STYLE>:
3186 \backslash
3187 displaystyle|
3188 \backslash
3189 textstyle|
3190 \backslash
3191 scriptstyle|
3192 \backslash
3193 scriptscriptstyle
3194 \end_layout
3195
3196 \begin_layout Description
3197 Origin Alejandro, 15 Aug 1996; sanda, 14 Jun 2008
3198 \end_layout
3199
3200 \begin_layout Subsection*
3201 LFUN_MATH_FONT_STYLE
3202 \end_layout
3203
3204 \begin_layout Description
3205 Action Changes the text style used in math.
3206 \end_layout
3207
3208 \begin_layout Description
3209 Syntax math-font-style <STYLE>
3210 \end_layout
3211
3212 \begin_layout Description
3213 Params <STYLE>: mathnormal|mathcal|mathfrak|mathrm|mathsf|mathbf |textnormal|tex
3214 trm|textsf|texttt|textbf|textmd|textit |textsc|textsl|textup
3215 \end_layout
3216
3217 \begin_layout Description
3218 Origin vfr, 9 jan 2009
3219 \end_layout
3220
3221 \begin_layout Subsection*
3222 LFUN_MATH_MACRO_UNFOLD
3223 \end_layout
3224
3225 \begin_layout Description
3226 Action Unfold a Math Macro.
3227 \end_layout
3228
3229 \begin_layout Description
3230 Notion Unfold the Math Macro the cursor is in, i.e.
3231  display it as
3232 \backslash
3233 foo.
3234 \end_layout
3235
3236 \begin_layout Description
3237 Syntax math-macro-unfold
3238 \end_layout
3239
3240 \begin_layout Description
3241 Origin sts, 06 January 2008
3242 \end_layout
3243
3244 \begin_layout Subsection*
3245 LFUN_MATH_MACRO_FOLD
3246 \end_layout
3247
3248 \begin_layout Description
3249 Action Fold a Math Macro.
3250 \end_layout
3251
3252 \begin_layout Description
3253 Notion Fold the Math Macro the cursor is in if it was unfolded, i.e.
3254  displayed as
3255 \backslash
3256 foo before.
3257 \end_layout
3258
3259 \begin_layout Description
3260 Syntax math-macro-fold
3261 \end_layout
3262
3263 \begin_layout Description
3264 Origin sts, 06 January 2008
3265 \end_layout
3266
3267 \begin_layout Subsection*
3268 LFUN_MATH_MACRO_ADD_PARAM
3269 \end_layout
3270
3271 \begin_layout Description
3272 Action Add a parameter.
3273 \end_layout
3274
3275 \begin_layout Description
3276 Notion Add a parameter to a Math Macro.
3277 \end_layout
3278
3279 \begin_layout Description
3280 Syntax math-macro-add-param <NUM>
3281 \end_layout
3282
3283 \begin_layout Description
3284 Params <NUM>: The number of the parameter behind which the new one will
3285  be added (1 for the first, i.e.
3286  use 0 for add a parameter at the left), defaults to the last one.
3287 \end_layout
3288
3289 \begin_layout Description
3290 Origin sts, 06 January 2008
3291 \end_layout
3292
3293 \begin_layout Subsection*
3294 LFUN_MATH_MACRO_REMOVE_PARAM
3295 \end_layout
3296
3297 \begin_layout Description
3298 Action Remove the last parameter.
3299 \end_layout
3300
3301 \begin_layout Description
3302 Notion Remove the last parameter of a Math Macro and remove its value in
3303  all instances of the macro in the buffer.
3304 \end_layout
3305
3306 \begin_layout Description
3307 Syntax math-macro-remove-param <NUM>
3308 \end_layout
3309
3310 \begin_layout Description
3311 Params <NUM>: The number of the parameter to be deleted (1 for the first),
3312  defaults to the last one.
3313 \end_layout
3314
3315 \begin_layout Description
3316 Origin sts, 06 January 2008
3317 \end_layout
3318
3319 \begin_layout Subsection*
3320 LFUN_MATH_MACRO_APPEND_GREEDY_PARAM
3321 \end_layout
3322
3323 \begin_layout Description
3324 Action Append a greedy parameter.
3325 \end_layout
3326
3327 \begin_layout Description
3328 Notion Append a greedy parameter to a Math Macro which eats the following
3329  mathed cell in every instance of the macro in the buffer.
3330 \end_layout
3331
3332 \begin_layout Description
3333 Syntax math-macro-append-greedy-param
3334 \end_layout
3335
3336 \begin_layout Description
3337 Origin sts, 06 January 2008
3338 \end_layout
3339
3340 \begin_layout Subsection*
3341 LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM
3342 \end_layout
3343
3344 \begin_layout Description
3345 Action Remove a greedy parameter.
3346 \end_layout
3347
3348 \begin_layout Description
3349 Notion Remove a greedy parameter of a Math Macro and spit out the values
3350  of it in every instance of the macro in the buffer.
3351  If it is an optional parameter the [valud] format is used.
3352 \end_layout
3353
3354 \begin_layout Description
3355 Syntax math-macro-remove-greedy-param
3356 \end_layout
3357
3358 \begin_layout Description
3359 Origin sts, 06 January 2008
3360 \end_layout
3361
3362 \begin_layout Subsection*
3363 LFUN_MATH_MACRO_MAKE_OPTIONAL
3364 \end_layout
3365
3366 \begin_layout Description
3367 Action Make a parameter optional.
3368 \end_layout
3369
3370 \begin_layout Description
3371 Notion Turn the first non-optional parameter of a Math Macro into an optional
3372  parameter with a default value.
3373 \end_layout
3374
3375 \begin_layout Description
3376 Syntax math-macro-make-optional
3377 \end_layout
3378
3379 \begin_layout Description
3380 Origin sts, 06 January 2008
3381 \end_layout
3382
3383 \begin_layout Subsection*
3384 LFUN_MATH_MACRO_MAKE_NONOPTIONAL
3385 \end_layout
3386
3387 \begin_layout Description
3388 Action Make a parameter non-optional.
3389 \end_layout
3390
3391 \begin_layout Description
3392 Notion Turn the last optional parameter of a Math Macro into a non-optional
3393  parameter.
3394  The default value is remembered to be reused later if the user changes
3395  his mind.
3396 \end_layout
3397
3398 \begin_layout Description
3399 Syntax math-macro-make-nonoptional
3400 \end_layout
3401
3402 \begin_layout Description
3403 Origin sts, 06 January 2008
3404 \end_layout
3405
3406 \begin_layout Subsection*
3407 LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM
3408 \end_layout
3409
3410 \begin_layout Description
3411 Action Add an optional parameter.
3412 \end_layout
3413
3414 \begin_layout Description
3415 Notion Insert an optional parameter just behind the already existing optional
3416  parameters.
3417 \end_layout
3418
3419 \begin_layout Description
3420 Syntax math-macro-add-optional-param
3421 \end_layout
3422
3423 \begin_layout Description
3424 Origin sts, 06 January 2008
3425 \end_layout
3426
3427 \begin_layout Subsection*
3428 LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM
3429 \end_layout
3430
3431 \begin_layout Description
3432 Action Remove the last optional parameter.
3433 \end_layout
3434
3435 \begin_layout Description
3436 Notion Remove the last optional parameter of a Math Macro and remove it
3437  in all the instances of the macro in the buffer.
3438 \end_layout
3439
3440 \begin_layout Description
3441 Syntax math-macro-remove-optional-param
3442 \end_layout
3443
3444 \begin_layout Description
3445 Origin sts, 06 January 2008
3446 \end_layout
3447
3448 \begin_layout Subsection*
3449 LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM
3450 \end_layout
3451
3452 \begin_layout Description
3453 Action Add a greedy optional parameter.
3454 \end_layout
3455
3456 \begin_layout Description
3457 Notion Add a greedy optional parameter which eats the value from the following
3458  cells in mathed which are in the [value] format.
3459 \end_layout
3460
3461 \begin_layout Description
3462 Syntax math-macro-add-greedy-optional-param
3463 \end_layout
3464
3465 \begin_layout Description
3466 Origin sts, 06 January 2008
3467 \end_layout
3468
3469 \begin_layout Subsection*
3470 LFUN_IN_MATHMACROTEMPLATE
3471 \end_layout
3472
3473 \begin_layout Description
3474 Action Only active in Math Macro definition.
3475 \end_layout
3476
3477 \begin_layout Description
3478 Notion Dummy function which is only active in a Math Macro definition.
3479  It's used to toggle the Math Macro toolbar if the cursor moves into a Math
3480  Macro definition.
3481 \end_layout
3482
3483 \begin_layout Description
3484 Syntax in-mathmacrotemplate
3485 \end_layout
3486
3487 \begin_layout Description
3488 Origin sts, 06 January 2008
3489 \end_layout
3490
3491 \begin_layout Subsection*
3492 LFUN_PARAGRAPH_MOVE_DOWN
3493 \end_layout
3494
3495 \begin_layout Description
3496 Action Moves the current paragraph downwards in the document.
3497 \end_layout
3498
3499 \begin_layout Description
3500 Syntax paragraph-move-down
3501 \end_layout
3502
3503 \begin_layout Description
3504 Origin Edwin, 8 Apr 2006
3505 \end_layout
3506
3507 \begin_layout Subsection*
3508 LFUN_PARAGRAPH_MOVE_UP
3509 \end_layout
3510
3511 \begin_layout Description
3512 Action Moves the current paragraph upwards in the document.
3513 \end_layout
3514
3515 \begin_layout Description
3516 Syntax paragraph-move-up
3517 \end_layout
3518
3519 \begin_layout Description
3520 Origin Edwin, 8 Apr 2006
3521 \end_layout
3522
3523 \begin_layout Subsection*
3524 LFUN_PARAGRAPH_UP
3525 \end_layout
3526
3527 \begin_layout Description
3528 Action Move the cursor to the next paragraph (or begining of the current
3529  one) in upward direction.
3530 \end_layout
3531
3532 \begin_layout Description
3533 Syntax paragraph-up
3534 \end_layout
3535
3536 \begin_layout Description
3537 Origin Asger, 1 Oct 1996
3538 \end_layout
3539
3540 \begin_layout Subsection*
3541 LFUN_PARAGRAPH_UP_SELECT
3542 \end_layout
3543
3544 \begin_layout Description
3545 Action Move the cursor and select the text to the next paragraph (or begining
3546  of the current one) in upward direction.
3547 \end_layout
3548
3549 \begin_layout Description
3550 Syntax paragraph-up-select
3551 \end_layout
3552
3553 \begin_layout Description
3554 Origin Asger, 1 Oct 1996
3555 \end_layout
3556
3557 \begin_layout Subsection*
3558 LFUN_PARAGRAPH_DOWN
3559 \end_layout
3560
3561 \begin_layout Description
3562 Action Move the cursor to the next paragraph (or begining of the current
3563  one) in downward direction.
3564 \end_layout
3565
3566 \begin_layout Description
3567 Syntax paragraph-down
3568 \end_layout
3569
3570 \begin_layout Description
3571 Origin Asger, 1 Oct 1996
3572 \end_layout
3573
3574 \begin_layout Subsection*
3575 LFUN_PARAGRAPH_DOWN_SELECT
3576 \end_layout
3577
3578 \begin_layout Description
3579 Action Move the cursor and select the text to the next paragraph (or begining
3580  of the current one) in downward direction.
3581 \end_layout
3582
3583 \begin_layout Description
3584 Syntax paragraph-down-select
3585 \end_layout
3586
3587 \begin_layout Description
3588 Origin Asger, 1 Oct 1996
3589 \end_layout
3590
3591 \begin_layout Subsection*
3592 LFUN_PARAGRAPH_GOTO
3593 \end_layout
3594
3595 \begin_layout Description
3596 Action Jump to a paragraph given by its id number and optionally the desired
3597  position within the paragraph.
3598 \end_layout
3599
3600 \begin_layout Description
3601 Notion Note that id number of paragraph is not the sequential number of
3602  paragraph seen on the screen.
3603  Moreover the id is unique for all opened buffers (documents).
3604 \end_layout
3605
3606 \begin_layout Description
3607 Syntax paragraph-goto <PAR_ID_NUMBER> <POSITION_IN_PAR>
3608 \end_layout
3609
3610 \begin_layout Description
3611 Params <PAR_ID_NUMBER>:  paragraph id
3612 \begin_inset Newline newline
3613 \end_inset
3614
3615 <POSITION_IN_PAR>: desired position within the paragraph
3616 \end_layout
3617
3618 \begin_layout Description
3619 Origin Dekel, 26 Aug 2000
3620 \end_layout
3621
3622 \begin_layout Subsection*
3623 LFUN_BREAK_PARAGRAPH
3624 \end_layout
3625
3626 \begin_layout Description
3627 Action Breaks the current paragraph at the current location.
3628 \end_layout
3629
3630 \begin_layout Description
3631 Notion Removes the selection.
3632 \end_layout
3633
3634 \begin_layout Description
3635 Syntax break-paragraph [<LAYOUT>]
3636 \end_layout
3637
3638 \begin_layout Description
3639 Params <LAYOUT>: "inverse" - decreases depth by one (or change layout to
3640  default layout) when the cursor is at the end of the line.
3641 \end_layout
3642
3643 \begin_layout Subsection*
3644 LFUN_PARAGRAPH_PARAMS
3645 \end_layout
3646
3647 \begin_layout Description
3648 Action Change paragraph settings.
3649 \end_layout
3650
3651 \begin_layout Description
3652 Notion Modifies the current paragraph, or currently selected paragraphs.
3653  This function only modifies, and does not override, existing settings.
3654  Note that the "leftindent" indent setting is deprecated.
3655 \end_layout
3656
3657 \begin_layout Description
3658 Syntax paragraph-params [<INDENT>] [<SPACING>] [<ALIGN>] [<OTHERS>]
3659 \end_layout
3660
3661 \begin_layout Description
3662 Params <INDENT>:
3663 \backslash
3664 noindent|
3665 \backslash
3666 indent|
3667 \backslash
3668 indent-toggle|
3669 \backslash
3670 leftindent LENGTH
3671 \begin_inset Newline newline
3672 \end_inset
3673
3674 <SPACING>:
3675 \backslash
3676 paragraph_spacing default|single|onehalf|double|other SIZE
3677 \begin_inset Newline newline
3678 \end_inset
3679
3680 <ALIGN>:
3681 \backslash
3682 align block|left|right|center|default
3683 \begin_inset Newline newline
3684 \end_inset
3685
3686 <OTHERS>:
3687 \backslash
3688 labelwidthstring WIDTH|
3689 \backslash
3690 start_of_appendix
3691 \end_layout
3692
3693 \begin_layout Description
3694 Origin rgh, Aug 15 2007
3695 \end_layout
3696
3697 \begin_layout Subsection*
3698 LFUN_PARAGRAPH_PARAMS_APPLY
3699 \end_layout
3700
3701 \begin_layout Description
3702 Action Change paragraph settings.
3703 \end_layout
3704
3705 \begin_layout Description
3706 Notion Overwrite all nonspecified settings to the default ones.
3707  Use paragraph-params lfun if you don't want to overwrite others settings.
3708 \end_layout
3709
3710 \begin_layout Description
3711 Syntax paragraph-params-apply <INDENT> <SPACING> <ALIGN> <OTHERS>
3712 \end_layout
3713
3714 \begin_layout Description
3715 Params For parameters see LFUN_PARAGRAPH_PARAMS
3716 \end_layout
3717
3718 \begin_layout Description
3719 Origin leeming, 30 Mar 2004
3720 \end_layout
3721
3722 \begin_layout Subsection*
3723 LFUN_PARAGRAPH_UPDATE
3724 \end_layout
3725
3726 \begin_layout Description
3727 Action Updates the values inside the paragraph dialog from the paragraph.
3728 \end_layout
3729
3730 \begin_layout Description
3731 Notion This is internal LFUN, not to be used by users.
3732  Called internally by LFUN_DIALOG_UPDATE.
3733 \end_layout
3734
3735 \begin_layout Description
3736 Origin leeming, 13 Mar 2003
3737 \end_layout
3738
3739 \begin_layout Subsection*
3740 LFUN_OUTLINE_UP
3741 \end_layout
3742
3743 \begin_layout Description
3744 Action Move the current group in the upward direction in the structure of
3745  the document.
3746 \end_layout
3747
3748 \begin_layout Description
3749 Notion The "group" can be Part/Chapter/Section/etc.
3750  It moves the whole substructure of the group.
3751 \end_layout
3752
3753 \begin_layout Description
3754 Syntax outline-up
3755 \end_layout
3756
3757 \begin_layout Description
3758 Origin Vermeer, 23 Mar 2006
3759 \end_layout
3760
3761 \begin_layout Subsection*
3762 LFUN_OUTLINE_DOWN
3763 \end_layout
3764
3765 \begin_layout Description
3766 Action Move the current group in the downward direction in the structure
3767  of the document.
3768 \end_layout
3769
3770 \begin_layout Description
3771 Notion The "group" can be Part/Chapter/Section/etc.
3772  It moves the whole substructure of the group.
3773 \end_layout
3774
3775 \begin_layout Description
3776 Syntax outline-down
3777 \end_layout
3778
3779 \begin_layout Description
3780 Origin Vermeer, 23 Mar 2006
3781 \end_layout
3782
3783 \begin_layout Subsection*
3784 LFUN_OUTLINE_IN
3785 \end_layout
3786
3787 \begin_layout Description
3788 Action Moves the current group in the downward direction in the hierarchy
3789  of the document structure.
3790 \end_layout
3791
3792 \begin_layout Description
3793 Notion Part -> Chapter -> Section -> etc.
3794 \end_layout
3795
3796 \begin_layout Description
3797 Syntax outline-in
3798 \end_layout
3799
3800 \begin_layout Description
3801 Origin Vermeer, 23 Mar 2006
3802 \end_layout
3803
3804 \begin_layout Subsection*
3805 LFUN_OUTLINE_OUT
3806 \end_layout
3807
3808 \begin_layout Description
3809 Action Moves the current group in the upward direction in the hierarchy
3810  of the document structure.
3811 \end_layout
3812
3813 \begin_layout Description
3814 Notion Part <- Chapter <- Section <- etc.
3815 \end_layout
3816
3817 \begin_layout Description
3818 Syntax outline-out
3819 \end_layout
3820
3821 \begin_layout Description
3822 Origin Vermeer, 23 Mar 2006
3823 \end_layout
3824
3825 \begin_layout Subsection*
3826 LFUN_OUTLINE_DRAGMOVE
3827 \end_layout
3828
3829 \begin_layout Description
3830 Action Moves the document section associated with the specified heading
3831  to a specified location.
3832  Both the heading and the target paragraph are specified by the paragraph
3833  ID numbers.
3834 \end_layout
3835
3836 \begin_layout Description
3837 Notion The heading is a paragraph with style Part/Chapter/Section/ etc.
3838  Id number of the paragraph is not the sequential number seen on the screen,
3839  but an internal number that is unique for all opened buffers (documents).
3840 \end_layout
3841
3842 \begin_layout Description
3843 Syntax outline-dragmove <PAR_ID_SECTION> <PAR_ID_DROP_POSITION>
3844 \end_layout
3845
3846 \begin_layout Description
3847 Params <PAR_ID_SECTION>: paragraph id of the section heading which is to
3848  be moved.
3849 \begin_inset Newline newline
3850 \end_inset
3851
3852 <PAR_ID_DROP_POSITION>: the paragraph id where the section will be moved
3853  to.
3854 \end_layout
3855
3856 \begin_layout Description
3857 Origin Rob Oakes, 22 June 2009
3858 \end_layout
3859
3860 \begin_layout Subsection*
3861 LFUN_INSET_EDIT
3862 \end_layout
3863
3864 \begin_layout Description
3865 Action Edit the inset at cursor with an external application, if one is
3866  attributed.
3867 \end_layout
3868
3869 \begin_layout Description
3870 Syntax inset-edit [<INSET_PARAMS>]
3871 \end_layout
3872
3873 \begin_layout Description
3874 Params <INSET_PARAMS>: Parameters for the inset.
3875 \begin_inset Newline newline
3876 \end_inset
3877
3878 Currently only the filename will be considered.
3879 \end_layout
3880
3881 \begin_layout Description
3882 Origin JSpitzm, 27 Apr 2006
3883 \end_layout
3884
3885 \begin_layout Subsection*
3886 LFUN_TABULAR_INSERT
3887 \end_layout
3888
3889 \begin_layout Description
3890 Action Inserts table into the document.
3891 \end_layout
3892
3893 \begin_layout Description
3894 Syntax tabular-insert [<ROWS> <COLUMNS>]
3895 \end_layout
3896
3897 \begin_layout Description
3898 Params In case no arguments are given show insert dialog.
3899 \end_layout
3900
3901 \begin_layout Description
3902 Origin Jug, 12 Apr 2000
3903 \end_layout
3904
3905 \begin_layout Subsection*
3906 LFUN_TABULAR_FEATURE
3907 \end_layout
3908
3909 \begin_layout Description
3910 Action Sets various features to the table/cell on the current cursor position.
3911 \end_layout
3912
3913 \begin_layout Description
3914 Notion Various math-environment features are handled here as well, e.g.
3915  add-vline-left/right for the Grid/Array environment
3916 \end_layout
3917
3918 \begin_layout Description
3919 Syntax tabular-feature <FEATURE> [<ARG>]
3920 \end_layout
3921
3922 \begin_layout Description
3923 Params <FEATURE>: append-row|append-column|delete-row|delete-column|copy-row|cop
3924 y-column| toggle-line-top|toggle-line-bottom|toggle-line-left|toggle-line-right|
3925  align-left|align-right|align-center|align-block|valign-top|valign-bottom|
3926  valign-middle|longtabular-align-left|longtabular-align-center| longtabular-alig
3927 n-right|m-align-left|m-align-right|m-align-center| m-valign-top|m-valign-bottom|
3928 m-valign-middle|multicolumn|set-all-lines| unset-all-lines|set-longtabular|unset
3929 -longtabular|set-pwidth|set-mpwidth| set-rotate-tabular|unset-rotate-tabular|tog
3930 gle-rotate-tabular| set-rotate-cell|unset-rotate-cell|toggle-rotate-cell|set-use
3931 box|set-lthead| unset-lthead|set-ltfirsthead|unset-ltfirsthead|set-ltfoot|unset-
3932 ltfoot| set-ltlastfoot|unset-ltlastfoot|set-ltnewpage|toggle-ltcaption|
3933  set-special-column|set-special-multi|set-booktabs|unset-booktabs| set-top-space
3934 |set-bottom-space|set-interline-space|set-border-lines| tabular-valign-top|tabul
3935 ar-valign-middle|tabular-valign-bottom
3936 \begin_inset Newline newline
3937 \end_inset
3938
3939 <ARG>: additional argument for some commands, use debug mode to explore
3940  its values.
3941 \end_layout
3942
3943 \begin_layout Description
3944 Origin Jug, 28 Jul 2000
3945 \end_layout
3946
3947 \begin_layout Subsection*
3948 LFUN_CELL_BACKWARD
3949 \end_layout
3950
3951 \begin_layout Description
3952 Action Moves the cursor to the previous cell inside the table.
3953 \end_layout
3954
3955 \begin_layout Description
3956 Syntax cell-backward
3957 \end_layout
3958
3959 \begin_layout Description
3960 Origin Jug, 22 May 2000
3961 \end_layout
3962
3963 \begin_layout Subsection*
3964 LFUN_CELL_FORWARD
3965 \end_layout
3966
3967 \begin_layout Description
3968 Action Moves the cursor to the next cell inside the table.
3969 \end_layout
3970
3971 \begin_layout Description
3972 Syntax cell-forward
3973 \end_layout
3974
3975 \begin_layout Subsection*
3976 LFUN_CELL_SPLIT
3977 \end_layout
3978
3979 \begin_layout Description
3980 Action Splits cell and shifts right part to the next cell (inside the math
3981  grid).
3982 \end_layout
3983
3984 \begin_layout Description
3985 Syntax cell-split
3986 \end_layout
3987
3988 \begin_layout Description
3989 Origin Ale, 15 May 1997
3990 \end_layout
3991
3992 \begin_layout Subsection*
3993 LFUN_VC_REGISTER
3994 \end_layout
3995
3996 \begin_layout Description
3997 Action Register the document as an file inside version control system (RCS,
3998  CVS).
3999 \end_layout
4000
4001 \begin_layout Description
4002 Notion File is registered inside cvs, svn or rcs repository acording to
4003  the existence of cvs/svn/rcs entries in the document's directory.
4004 \begin_inset Newline newline
4005 \end_inset
4006
4007 See LyX Additional Features Manual (Version Control Chapter) for additional
4008  information.
4009 \end_layout
4010
4011 \begin_layout Description
4012 Syntax vc-register
4013 \end_layout
4014
4015 \begin_layout Description
4016 Origin Lgb, 1 Jul 1997
4017 \end_layout
4018
4019 \begin_layout Subsection*
4020 LFUN_VC_CHECK_IN
4021 \end_layout
4022
4023 \begin_layout Description
4024 Action Checks-in/commits the changes of the registered file to the repository.
4025 \end_layout
4026
4027 \begin_layout Description
4028 Notion In RCS case this also unlocks the file.
4029 \end_layout
4030
4031 \begin_layout Description
4032 Syntax vc-check-in
4033 \end_layout
4034
4035 \begin_layout Description
4036 Origin Lgb, 1 Jul 1997
4037 \end_layout
4038
4039 \begin_layout Subsection*
4040 LFUN_VC_CHECK_OUT
4041 \end_layout
4042
4043 \begin_layout Description
4044 Action Checks-out the document for edit (and locks it for RCS).
4045 \end_layout
4046
4047 \begin_layout Description
4048 Notion This is implemented only for RCS and SVN, not CVS.
4049 \end_layout
4050
4051 \begin_layout Description
4052 Syntax vc-check-out
4053 \end_layout
4054
4055 \begin_layout Description
4056 Origin Lgb, 1 Jul 1997
4057 \end_layout
4058
4059 \begin_layout Subsection*
4060 LFUN_VC_REVERT
4061 \end_layout
4062
4063 \begin_layout Description
4064 Action Reverts the document to the last check-in/commit in VCS.
4065 \end_layout
4066
4067 \begin_layout Description
4068 Syntax vc-revert
4069 \end_layout
4070
4071 \begin_layout Description
4072 Origin Lgb, 1 Jul 1997
4073 \end_layout
4074
4075 \begin_layout Subsection*
4076 LFUN_VC_UNDO_LAST
4077 \end_layout
4078
4079 \begin_layout Description
4080 Action Undo last check-in.
4081 \end_layout
4082
4083 \begin_layout Description
4084 Notion This is currently implemented only for RCS.
4085 \end_layout
4086
4087 \begin_layout Description
4088 Syntax vc-check-out
4089 \end_layout
4090
4091 \begin_layout Description
4092 Origin Lgb, 1 Jul 1997
4093 \end_layout
4094
4095 \begin_layout Subsection*
4096 LFUN_VC_COMMAND
4097 \end_layout
4098
4099 \begin_layout Description
4100 Action Executes external command.
4101  This command is intended to support additional VCS commands.
4102 \end_layout
4103
4104 \begin_layout Description
4105 Syntax vc-command <FLAG> <PATH> <COMMAND>
4106 \end_layout
4107
4108 \begin_layout Description
4109 Params  <FLAG>: Flags for the command can be combined together.
4110 \begin_inset Newline newline
4111 \end_inset
4112
4113 U - dUmmy - no flags
4114 \begin_inset Newline newline
4115 \end_inset
4116
4117 D - Doc - need document loaded to proceed
4118 \begin_inset Newline newline
4119 \end_inset
4120
4121 I - dIrty - mark document dirty
4122 \begin_inset Newline newline
4123 \end_inset
4124
4125 R - Reload - ensure that the document is saved and reload it after command
4126  execution
4127 \begin_inset Newline newline
4128 \end_inset
4129
4130 M - Message - ask for input string (commit message)
4131 \begin_inset Newline newline
4132 \end_inset
4133
4134 <PATH>: path where to start.
4135  $$p will be replaced by the current document path.
4136 \begin_inset Newline newline
4137 \end_inset
4138
4139 <COMMAND>: command to execute.
4140  $$i/$$p/$$m will be replaced by the current document/path/message.
4141 \end_layout
4142
4143 \begin_layout Description
4144 Sample vc-command DR $$p "svn up"
4145 \end_layout
4146
4147 \begin_layout Description
4148 Origin sanda, 13 Jan 2009
4149 \end_layout
4150
4151 \begin_layout Subsection*
4152 LFUN_VC_LOCKING_TOGGLE
4153 \end_layout
4154
4155 \begin_layout Description
4156 Action Toggles the locking property of the edited file.
4157 \end_layout
4158
4159 \begin_layout Description
4160 Notion This is currently implemented only for SVN.
4161 \end_layout
4162
4163 \begin_layout Description
4164 Syntax vc-locking-toggle
4165 \end_layout
4166
4167 \begin_layout Description
4168 Origin sanda, 25 Jun 2009
4169 \end_layout
4170
4171 \begin_layout Subsection*
4172 LFUN_VC_REPO_SYNCHRO
4173 \end_layout
4174
4175 \begin_layout Description
4176 Action Synchronize the local archive directory in which resides the current
4177  document with the repository.
4178 \end_layout
4179
4180 \begin_layout Description
4181 Notion This is currently implemented only for SVN as revert + update operation.
4182 \end_layout
4183
4184 \begin_layout Description
4185 Syntax vc-repo-synchro
4186 \end_layout
4187
4188 \begin_layout Description
4189 Origin sanda, 16 Oct 2009
4190 \end_layout
4191
4192 \begin_layout Subsection*
4193 LFUN_CHANGES_TRACK
4194 \end_layout
4195
4196 \begin_layout Description
4197 Action Toggles change tracking to on/off.
4198 \end_layout
4199
4200 \begin_layout Description
4201 Syntax changes-track
4202 \end_layout
4203
4204 \begin_layout Description
4205 Origin levon, 1 Oct 2002
4206 \end_layout
4207
4208 \begin_layout Subsection*
4209 LFUN_CHANGES_OUTPUT
4210 \end_layout
4211
4212 \begin_layout Description
4213 Action Toggles showing of change tracking in typesetted output.
4214 \end_layout
4215
4216 \begin_layout Description
4217 Syntax changes-output
4218 \end_layout
4219
4220 \begin_layout Description
4221 Origin jspitzm, 21 Jan 2005
4222 \end_layout
4223
4224 \begin_layout Subsection*
4225 LFUN_CHANGE_NEXT
4226 \end_layout
4227
4228 \begin_layout Description
4229 Action Moves the cursor to the position of the next change of the change
4230  tracking records.
4231 \end_layout
4232
4233 \begin_layout Description
4234 Syntax change-next
4235 \end_layout
4236
4237 \begin_layout Description
4238 Origin schmitt, 4 Oct 2006
4239 \end_layout
4240
4241 \begin_layout Subsection*
4242 LFUN_CHANGE_PREVIOUS
4243 \end_layout
4244
4245 \begin_layout Description
4246 Action Moves the cursor to the position of the previous change of the change
4247  tracking records.
4248 \end_layout
4249
4250 \begin_layout Description
4251 Syntax change-previous
4252 \end_layout
4253
4254 \begin_layout Description
4255 Origin vfr, 4 Apr 2009
4256 \end_layout
4257
4258 \begin_layout Subsection*
4259 LFUN_CHANGES_MERGE
4260 \end_layout
4261
4262 \begin_layout Description
4263 Action Open change tracking dialog for merging and moves the cursor to the
4264  position of the next change.
4265 \end_layout
4266
4267 \begin_layout Description
4268 Syntax changes-merge
4269 \end_layout
4270
4271 \begin_layout Description
4272 Origin Levon, 16 Oct 2002
4273 \end_layout
4274
4275 \begin_layout Subsection*
4276 LFUN_CHANGE_ACCEPT
4277 \end_layout
4278
4279 \begin_layout Description
4280 Action Accepts tracked change inside the selection.
4281 \end_layout
4282
4283 \begin_layout Description
4284 Syntax change-accept
4285 \end_layout
4286
4287 \begin_layout Description
4288 Origin Levon, 16 Oct 2002
4289 \end_layout
4290
4291 \begin_layout Subsection*
4292 LFUN_CHANGE_REJECT
4293 \end_layout
4294
4295 \begin_layout Description
4296 Action Rejects tracked change inside the selection.
4297 \end_layout
4298
4299 \begin_layout Description
4300 Syntax change-accept
4301 \end_layout
4302
4303 \begin_layout Description
4304 Origin Levon, 16 Oct 2002
4305 \end_layout
4306
4307 \begin_layout Subsection*
4308 LFUN_ALL_CHANGES_ACCEPT
4309 \end_layout
4310
4311 \begin_layout Description
4312 Action Accepts all tracked changes in the document.
4313 \end_layout
4314
4315 \begin_layout Description
4316 Syntax all-changes-accept
4317 \end_layout
4318
4319 \begin_layout Description
4320 Origin Levon, 16 Oct 2002
4321 \end_layout
4322
4323 \begin_layout Subsection*
4324 LFUN_ALL_CHANGES_REJECT
4325 \end_layout
4326
4327 \begin_layout Description
4328 Action Rejects all tracked changes in the document.
4329 \end_layout
4330
4331 \begin_layout Description
4332 Notion Reject does not work recursively; the user may have to repeat the
4333  operation.
4334 \end_layout
4335
4336 \begin_layout Description
4337 Syntax all-changes-reject
4338 \end_layout
4339
4340 \begin_layout Description
4341 Origin Levon, 16 Oct 2002
4342 \end_layout
4343
4344 \begin_layout Subsection*
4345 LFUN_INSET_APPLY
4346 \end_layout
4347
4348 \begin_layout Description
4349 Action Apply data for an inset.
4350 \end_layout
4351
4352 \begin_layout Description
4353 Notion LFUN_INSET_APPLY is sent from the dialogs when the data should be
4354  applied.
4355  This is either changed to LFUN_INSET_MODIFY or LFUN_INSET_INSERT depending
4356  on the context where it is called.
4357 \end_layout
4358
4359 \begin_layout Description
4360 Syntax inset-apply <ARGS>
4361 \end_layout
4362
4363 \begin_layout Description
4364 Params See LFUN_INSET_INSERT .
4365 \end_layout
4366
4367 \begin_layout Subsection*
4368 LFUN_INSET_DISSOLVE
4369 \end_layout
4370
4371 \begin_layout Description
4372 Action Dissolve the current inset into text.
4373 \end_layout
4374
4375 \begin_layout Description
4376 Syntax inset-dissolve [<INSET>]
4377 \end_layout
4378
4379 \begin_layout Description
4380 Params <INSET>: this can be used to make sure the right kind of inset is
4381  dissolved.
4382  For example "dissolve" entry in the charstyles sub-menu should only dissolve
4383  the charstyle inset, even if the cursor is inside several nested insets
4384  of different type.
4385 \begin_inset Newline newline
4386 \end_inset
4387
4388 For values see lyx::InsetLayout::lyxtype_ .
4389 \end_layout
4390
4391 \begin_layout Description
4392 Origin JSpitz, 7 Aug 2006
4393 \end_layout
4394
4395 \begin_layout Subsection*
4396 LFUN_INSET_INSERT
4397 \end_layout
4398
4399 \begin_layout Description
4400 Action Insert new inset (type given by the parameters).
4401 \end_layout
4402
4403 \begin_layout Description
4404 Syntax inset-insert <INSET> <ARGS>
4405 \end_layout
4406
4407 \begin_layout Description
4408 Params <INSET>: <bibitem|bibtex|cite|ert|listings|external|graphics| hyperlink|i
4409 nclude|index|label|nomencl|vspace|ref|toc>
4410 \begin_inset Newline newline
4411 \end_inset
4412
4413 <ARGS>: depends on the given inset.
4414  Use "lyx -dbg action" to explore.
4415 \end_layout
4416
4417 \begin_layout Description
4418 Sample inset-insert ref LatexCommand <Format> reference "<label name>"
4419 \backslash
4420 end_inset
4421 \begin_inset Newline newline
4422 \end_inset
4423
4424 where <label name> is the name of the referenced label and <Format> is one
4425  of the following:
4426 \begin_inset Newline newline
4427 \end_inset
4428
4429 ref -- <reference>
4430 \begin_inset Newline newline
4431 \end_inset
4432
4433 eqref -- (<reference>)
4434 \begin_inset Newline newline
4435 \end_inset
4436
4437 pageref -- <page>
4438 \begin_inset Newline newline
4439 \end_inset
4440
4441 vpageref -- on <page>
4442 \begin_inset Newline newline
4443 \end_inset
4444
4445 vref -- <reference> on <page>
4446 \begin_inset Newline newline
4447 \end_inset
4448
4449 prettyref -- Formatted reference
4450 \end_layout
4451
4452 \begin_layout Subsection*
4453 LFUN_INSET_MODIFY
4454 \end_layout
4455
4456 \begin_layout Description
4457 Action Modify existing inset.
4458 \end_layout
4459
4460 \begin_layout Description
4461 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4462  graphics, include, label, listings, note, phantom, ref, space, tabular,
4463  vspace, wrap insets.
4464 \end_layout
4465
4466 \begin_layout Description
4467 Syntax inset-modify <INSET> <ARGS>
4468 \end_layout
4469
4470 \begin_layout Description
4471 Params See LFUN_INSET_INSERT for further details.
4472 \end_layout
4473
4474 \begin_layout Subsection*
4475 LFUN_NEXT_INSET_MODIFY
4476 \end_layout
4477
4478 \begin_layout Description
4479 Action Modify the inset at cursor position, if there is one.
4480 \end_layout
4481
4482 \begin_layout Description
4483 Notion Used for bibitem, bibtex, box, branch, command, ert, external, floats,
4484  graphics, include, label, listings, note, phantom, ref, space, tabular,
4485  vspace, wrap insets.
4486 \end_layout
4487
4488 \begin_layout Description
4489 Syntax next-inset-modify <INSET> <ARGS>next-inset-modify changetype <TYPE>
4490 \end_layout
4491
4492 \begin_layout Description
4493 Params See LFUN_INSET_INSERT for further details.
4494 \end_layout
4495
4496 \begin_layout Description
4497 Origin JSpitzm, 23 Mar 2008
4498 \end_layout
4499
4500 \begin_layout Subsection*
4501 LFUN_INSET_DIALOG_UPDATE
4502 \end_layout
4503
4504 \begin_layout Description
4505 Action Updates the values inside the dialog from the inset.
4506 \end_layout
4507
4508 \begin_layout Description
4509 Notion This is internal LFUN, not to be used by users.
4510  Called internally by LFUN_DIALOG_UPDATE
4511 \end_layout
4512
4513 \begin_layout Description
4514 Params <DIALOG-NAME>
4515 \end_layout
4516
4517 \begin_layout Description
4518 Origin leeming, 25 Feb 2003
4519 \end_layout
4520
4521 \begin_layout Subsection*
4522 LFUN_INSET_SETTINGS
4523 \end_layout
4524
4525 \begin_layout Description
4526 Action Open the inset's properties dialog.
4527 \end_layout
4528
4529 \begin_layout Description
4530 Notion Used for bibitem, bibtex, box, branch, citation, ert, external, float,
4531  graphics, href, include, index, index_print, label, listings, note, phantom,
4532  ref, space, tabular, vspace, wrap insets.
4533 \end_layout
4534
4535 \begin_layout Description
4536 Syntax inset-settings <INSET>
4537 \end_layout
4538
4539 \begin_layout Description
4540 Params <INSET>: <bibitem|bibtex|box|branch|citation|ert|external|float|
4541  graphics|href|include|index|index_print|label|listings| note|phantom|ref|space|
4542 tabular|vspace|wrap>.
4543 \end_layout
4544
4545 \begin_layout Subsection*
4546 LFUN_INSET_TOGGLE
4547 \end_layout
4548
4549 \begin_layout Description
4550 Action Toggles the collapsable inset at cursor position, or the inset we
4551  are currently in.
4552 \end_layout
4553
4554 \begin_layout Description
4555 Syntax inset-toggle [<ARG>]
4556 \end_layout
4557
4558 \begin_layout Description
4559 Params <ARG>: <open|close|toggle|assign>.
4560 \begin_inset Newline newline
4561 \end_inset
4562
4563 open/close/toggle are for collapsable insets.
4564  toggle is used when no argument is given.
4565 \begin_inset Newline newline
4566 \end_inset
4567
4568 assign synchronize the branch-inset with activation status of the branch.
4569  Used for global toggling when changed activation.
4570 \end_layout
4571
4572 \begin_layout Description
4573 Origin lasgouttes, 19 Jul 2001
4574 \end_layout
4575
4576 \begin_layout Subsection*
4577 LFUN_ALL_INSETS_TOGGLE
4578 \end_layout
4579
4580 \begin_layout Description
4581 Action Toggles (open/closes) all collapsable insets (of a given type) in
4582  the document.
4583 \end_layout
4584
4585 \begin_layout Description
4586 Notion Used for box, branch, ert, float, listings, note, tabular, wrap insets.
4587 \end_layout
4588
4589 \begin_layout Description
4590 Syntax all-insets-toggle [<STATE>] [<INSET>]
4591 \end_layout
4592
4593 \begin_layout Description
4594 Params <STATE>: <toggle|open|close|assign> default: toggle
4595 \begin_inset Newline newline
4596 \end_inset
4597
4598 <INSET>: <box|branch|ert|float|listings|note|tabular|wrap> default: all
4599  insets
4600 \end_layout
4601
4602 \begin_layout Description
4603 Origin leeming, 30 Mar 2004
4604 \end_layout
4605
4606 \begin_layout Subsection*
4607 LFUN_SET_GRAPHICS_GROUP
4608 \end_layout
4609
4610 \begin_layout Description
4611 Action Set the group for the graphics inset on the cursor position.
4612 \end_layout
4613
4614 \begin_layout Description
4615 Syntax set-graphics-group [<GROUP>]
4616 \end_layout
4617
4618 \begin_layout Description
4619 Params <GROUP>: Id for an existing group.
4620  In case the Id is an empty string, the graphics inset is removed from the
4621  current group.
4622 \end_layout
4623
4624 \begin_layout Description
4625 Origin sanda, 6 May 2008
4626 \end_layout
4627
4628 \begin_layout Subsection*
4629 LFUN_FINISHED_FORWARD
4630 \end_layout
4631
4632 \begin_layout Description
4633 Action Moves the cursor out of the current slice, going forward.
4634 \end_layout
4635
4636 \begin_layout Description
4637 Notion Cursor movement within an inset may be different than cursor movement
4638  in the surrounding text.
4639  This action should be called automatically by the cursor movement within
4640  the inset, when movement within the inset has ceased (reached the end of
4641  the last paragraph, for example), in order to move correctly back into
4642  the surrounding text.
4643 \end_layout
4644
4645 \begin_layout Subsection*
4646 LFUN_FINISHED_BACKWARD
4647 \end_layout
4648
4649 \begin_layout Description
4650 Action Moves the cursor out of the current slice, going backwards.
4651 \end_layout
4652
4653 \begin_layout Description
4654 Notion See also LFUN_FINISHED_FORWARD.
4655 \end_layout
4656
4657 \begin_layout Subsection*
4658 LFUN_FINISHED_RIGHT
4659 \end_layout
4660
4661 \begin_layout Description
4662 Action Moves the cursor out of the current slice, going right.
4663 \end_layout
4664
4665 \begin_layout Description
4666 Notion See also LFUN_FINISHED_FORWARD
4667 \end_layout
4668
4669 \begin_layout Subsection*
4670 LFUN_FINISHED_LEFT
4671 \end_layout
4672
4673 \begin_layout Description
4674 Action Moves the cursor out of the current slice, going left.
4675 \end_layout
4676
4677 \begin_layout Description
4678 Notion See also LFUN_FINISHED_FORWARD.
4679 \end_layout
4680
4681 \begin_layout Subsection*
4682 LFUN_LANGUAGE
4683 \end_layout
4684
4685 \begin_layout Description
4686 Action Set language from the current cursor position.
4687 \end_layout
4688
4689 \begin_layout Description
4690 Syntax language <LANG>
4691 \end_layout
4692
4693 \begin_layout Description
4694 Params <LANG>: Requested language.
4695  Look in lib/languages for the list.
4696 \end_layout
4697
4698 \begin_layout Description
4699 Origin Dekel, 2 Mar 2000
4700 \end_layout
4701
4702 \begin_layout Subsection*
4703 LFUN_LABEL_GOTO
4704 \end_layout
4705
4706 \begin_layout Description
4707 Action Goto a label.
4708 \end_layout
4709
4710 \begin_layout Description
4711 Syntax label-goto [<LABEL>]
4712 \end_layout
4713
4714 \begin_layout Description
4715 Params <LABEL>: Requested label.
4716  If no label is given and reference is on cursor position, Bookmark 0 is
4717  saved and cursor moves to the position of referenced label.
4718 \end_layout
4719
4720 \begin_layout Description
4721 Origin Ale, 6 Aug 1997
4722 \end_layout
4723
4724 \begin_layout Subsection*
4725 LFUN_LABEL_INSERT
4726 \end_layout
4727
4728 \begin_layout Description
4729 Action Inserts label to text or displayed formula.
4730 \end_layout
4731
4732 \begin_layout Description
4733 Syntax label-insert [<LABEL>]
4734 \end_layout
4735
4736 \begin_layout Description
4737 Params <LABEL>: Requested label.
4738  If no label is given dialog requesting name will be opened.
4739 \end_layout
4740
4741 \begin_layout Subsection*
4742 LFUN_REFERENCE_NEXT
4743 \end_layout
4744
4745 \begin_layout Description
4746 Action Go to the next label or cross-reference.
4747 \end_layout
4748
4749 \begin_layout Description
4750 Syntax reference-next
4751 \end_layout
4752
4753 \begin_layout Description
4754 Origin Dekel, 14 Jan 2001
4755 \end_layout
4756
4757 \begin_layout Subsection*
4758 LFUN_BOOKMARK_GOTO
4759 \end_layout
4760
4761 \begin_layout Description
4762 Action Moves the cursor to the numbered bookmark, opening the file if necessary.
4763  Note that bookmarsk are saved per-session, not per file.
4764 \end_layout
4765
4766 \begin_layout Description
4767 Notion Bookmark 0 has a special purpose.
4768  It is automatically set
4769 \begin_inset Newline newline
4770 \end_inset
4771
4772 1.
4773  to the paragraph you are currently editing
4774 \begin_inset Newline newline
4775 \end_inset
4776
4777 2.
4778  to the paragraph from where you are jumping to the last-edited position
4779  (jump-back feature)
4780 \begin_inset Newline newline
4781 \end_inset
4782
4783 3.
4784  when jumping from crossreference to the requested label by LFUN_LABEL_GOTO.
4785 \end_layout
4786
4787 \begin_layout Description
4788 Syntax bookmark-goto <NUMBER>
4789 \end_layout
4790
4791 \begin_layout Description
4792 Params <NUMBER>: the number of the bookmark to restore.
4793 \end_layout
4794
4795 \begin_layout Description
4796 Origin Dekel, 27 January 2001
4797 \end_layout
4798
4799 \begin_layout Subsection*
4800 LFUN_BOOKMARK_SAVE
4801 \end_layout
4802
4803 \begin_layout Description
4804 Action Save a bookmark.
4805 \end_layout
4806
4807 \begin_layout Description
4808 Notion Saves a numbered bookmark to the sessions file.
4809  The number must be between 1 and 9, inclusive.
4810  Note that bookmarks are saved per-session, not per file.
4811 \end_layout
4812
4813 \begin_layout Description
4814 Syntax bookmark-save <NUMBER>
4815 \end_layout
4816
4817 \begin_layout Description
4818 Params <NUMBER>: the number of the bookmark to save.
4819 \end_layout
4820
4821 \begin_layout Description
4822 Origin Dekel, 27 January 2001
4823 \end_layout
4824
4825 \begin_layout Subsection*
4826 LFUN_BOOKMARK_CLEAR
4827 \end_layout
4828
4829 \begin_layout Description
4830 Action Clears the list of saved bookmarks.
4831 \end_layout
4832
4833 \begin_layout Description
4834 Syntax bookmark-clear
4835 \end_layout
4836
4837 \begin_layout Description
4838 Origin bpeng, 31 October 2006
4839 \end_layout
4840
4841 \begin_layout Subsection*
4842 LFUN_HELP_OPEN
4843 \end_layout
4844
4845 \begin_layout Description
4846 Action Open the given help file according to the language setting.
4847 \end_layout
4848
4849 \begin_layout Description
4850 Syntax help-open <FILE>[.lyx]
4851 \end_layout
4852
4853 \begin_layout Description
4854 Params <FILE>: any document from (/usr/share/)doc directory.
4855 \end_layout
4856
4857 \begin_layout Description
4858 Origin Jug, 27 Jun 1999
4859 \end_layout
4860
4861 \begin_layout Subsection*
4862 LFUN_LYX_QUIT
4863 \end_layout
4864
4865 \begin_layout Description
4866 Action Terminates the current LyX instance.
4867 \end_layout
4868
4869 \begin_layout Description
4870 Notion Terminates the current LyX instance, asking whether to save modified
4871  documents, etc.
4872 \end_layout
4873
4874 \begin_layout Description
4875 Syntax lyx-quit
4876 \end_layout
4877
4878 \begin_layout Subsection*
4879 LFUN_TOOLBAR_TOGGLE
4880 \end_layout
4881
4882 \begin_layout Description
4883 Action Toggles visibility of a given toolbar between on/off/auto.
4884 \end_layout
4885
4886 \begin_layout Description
4887 Notion Skiping "auto" when allowauto is false.
4888 \end_layout
4889
4890 \begin_layout Description
4891 Syntax toolbar-toggle <NAME> [allowauto]
4892 \end_layout
4893
4894 \begin_layout Description
4895 Params <NAME>: standard|extra|table|math|mathmacrotemplate| minibuffer|review|vi
4896 ew/update|math_panels|vcs
4897 \end_layout
4898
4899 \begin_layout Description
4900 Origin Edwin, 21 May 2007
4901 \end_layout
4902
4903 \begin_layout Subsection*
4904 LFUN_MENU_OPEN
4905 \end_layout
4906
4907 \begin_layout Description
4908 Action Opens the menu given by its name.
4909 \end_layout
4910
4911 \begin_layout Description
4912 Syntax menu-open <NAME>
4913 \end_layout
4914
4915 \begin_layout Description
4916 Params <NAME>: menu name.
4917  See various .inc files in lib/ui for candidates.
4918 \end_layout
4919
4920 \begin_layout Subsection*
4921 LFUN_UI_TOGGLE
4922 \end_layout
4923
4924 \begin_layout Description
4925 Action Various UI visibility-toggling actions.
4926 \end_layout
4927
4928 \begin_layout Description
4929 Syntax ui-toggle <statusbar|menubar|scrollbar|frame|fullscreen>
4930 \end_layout
4931
4932 \begin_layout Description
4933 Params statusbar  : Toggle visibility of the statusbar.
4934 \begin_inset Newline newline
4935 \end_inset
4936
4937 menubar    : Toggle visibility of the menubar.
4938 \begin_inset Newline newline
4939 \end_inset
4940
4941 scrollbar  : Toggle visibility of the scrollbar.
4942 \begin_inset Newline newline
4943 \end_inset
4944
4945 frame      : Toggle visibility of the frames around editing window.
4946 \begin_inset Newline newline
4947 \end_inset
4948
4949 fullscreen : Toggle fullscreen mode.
4950  This also covers calling the previous functions.
4951  However LFUN_TOOLBAR_TOGGLE for the custom tweaks of the toolbars should
4952  be used.
4953 \end_layout
4954
4955 \begin_layout Description
4956 Origin sanda, 9 Feb 2007
4957 \end_layout
4958
4959 \begin_layout Subsection*
4960 LFUN_WINDOW_NEW
4961 \end_layout
4962
4963 \begin_layout Description
4964 Action Creates new empty LyX window.
4965 \end_layout
4966
4967 \begin_layout Description
4968 Notion Already opened documents from the previous window can be found under
4969  View menu.
4970 \end_layout
4971
4972 \begin_layout Description
4973 Syntax window-new [<GEOMETRY>]
4974 \end_layout
4975
4976 \begin_layout Description
4977 Params <GEOMETRY>: pass the geometry of the window.
4978  This parameter is currently accepted only on Windows platform.
4979 \end_layout
4980
4981 \begin_layout Description
4982 Origin Abdel, 21 Oct 2006
4983 \end_layout
4984
4985 \begin_layout Subsection*
4986 LFUN_WINDOW_CLOSE
4987 \end_layout
4988
4989 \begin_layout Description
4990 Action Closes the current LyX window.
4991 \end_layout
4992
4993 \begin_layout Description
4994 Syntax window-close
4995 \end_layout
4996
4997 \begin_layout Description
4998 Origin Abdel, 23 Oct 2006
4999 \end_layout
5000
5001 \begin_layout Subsection*
5002 LFUN_SPLIT_VIEW
5003 \end_layout
5004
5005 \begin_layout Description
5006 Action Creates another split view of current buffer.
5007 \end_layout
5008
5009 \begin_layout Description
5010 Notion All split views act in the same way indpendently.
5011 \end_layout
5012
5013 \begin_layout Description
5014 Syntax split-view <vertical|horizontal>
5015 \end_layout
5016
5017 \begin_layout Description
5018 Params horizontal : The work areas are laid out side by side.
5019 \begin_inset Newline newline
5020 \end_inset
5021
5022 vertical   : The work areas laid out vertically.
5023 \end_layout
5024
5025 \begin_layout Description
5026 Origin Abdel, 20 Feb 2008
5027 \end_layout
5028
5029 \begin_layout Subsection*
5030 LFUN_CLOSE_TAB_GROUP
5031 \end_layout
5032
5033 \begin_layout Description
5034 Action Close the current tab group.
5035 \end_layout
5036
5037 \begin_layout Description
5038 Notion This only closes the work areas, not the buffer themselves.
5039  The still opened buffers can be visualized in another tab group.
5040 \end_layout
5041
5042 \begin_layout Description
5043 Syntax close-tab-group
5044 \end_layout
5045
5046 \begin_layout Description
5047 Origin Abdel, 21 Feb 2008
5048 \end_layout
5049
5050 \begin_layout Subsection*
5051 LFUN_DIALOG_SHOW
5052 \end_layout
5053
5054 \begin_layout Description
5055 Action Shows hidden dialog or create new one for a given function/inset
5056  settings etc.
5057 \end_layout
5058
5059 \begin_layout Description
5060 Syntax dialog-show <NAME> [<DATA>]
5061 \end_layout
5062
5063 \begin_layout Description
5064 Params <NAME>: aboutlyx|bibitem|bibtex|box|branch|changes|character|citation|
5065 \begin_inset Newline newline
5066 \end_inset
5067
5068 document|errorlist|ert|external|file|findreplace|findreplaceadv|float|graphics|
5069 \begin_inset Newline newline
5070 \end_inset
5071
5072 href|include|index|index_print|info|label|listings|log|mathdelimiter|
5073 \begin_inset Newline newline
5074 \end_inset
5075
5076 mathmatrix|mathspace|nomenclature|nomencl_print|note|paragraph|phantom|prefs|
5077 \begin_inset Newline newline
5078 \end_inset
5079
5080 print|ref|sendto|space|spellchecker|symbols|tabular|tabularcreate|
5081 \begin_inset Newline newline
5082 \end_inset
5083
5084 thesaurus|texinfo|toc|view-source|vspace|wrap|<SPECIAL>
5085 \begin_inset Newline newline
5086 \end_inset
5087
5088 <SPECIAL>: latexlog|vclog
5089 \begin_inset Newline newline
5090 \end_inset
5091
5092 <DATA>: data, usually settings for the given dialog.
5093  Use debug mode for the details.
5094 \end_layout
5095
5096 \begin_layout Description
5097 Origin leeming, 17 Jun 2003
5098 \end_layout
5099
5100 \begin_layout Subsection*
5101 LFUN_DIALOG_SHOW_NEW_INSET
5102 \end_layout
5103
5104 \begin_layout Description
5105 Action Shows hidden dialog or create new one for a given inset settings
5106  etc.
5107 \end_layout
5108
5109 \begin_layout Description
5110 Notion Internally uses LFUN_DIALOG_SHOW with processed data for a given
5111  inset.
5112 \end_layout
5113
5114 \begin_layout Description
5115 Syntax dialog-show-new-inset <NAME> [<DATA>]
5116 \end_layout
5117
5118 \begin_layout Description
5119 Params See LFUN_DIALOG_SHOW .
5120 \end_layout
5121
5122 \begin_layout Description
5123 Origin leeming, 25 Feb 2003
5124 \end_layout
5125
5126 \begin_layout Subsection*
5127 LFUN_DIALOG_UPDATE
5128 \end_layout
5129
5130 \begin_layout Description
5131 Action Updates the dialog values from the inset/paragraph/document.
5132 \end_layout
5133
5134 \begin_layout Description
5135 Syntax dialog-update <NAME>
5136 \end_layout
5137
5138 \begin_layout Description
5139 Params <NAME>: paragraph|prefs|<INSET>
5140 \begin_inset Newline newline
5141 \end_inset
5142
5143 <INSET>: inset name
5144 \end_layout
5145
5146 \begin_layout Description
5147 Origin leeming, 25 Feb 2003
5148 \end_layout
5149
5150 \begin_layout Subsection*
5151 LFUN_DIALOG_HIDE
5152 \end_layout
5153
5154 \begin_layout Description
5155 Action Hides showed dialog.
5156  Counterpart to LFUN_DIALOG_SHOW .
5157 \end_layout
5158
5159 \begin_layout Description
5160 Syntax dialog-hide <NAME>
5161 \end_layout
5162
5163 \begin_layout Description
5164 Params See LFUN_DIALOG_SHOW .
5165 \end_layout
5166
5167 \begin_layout Description
5168 Origin leeming, 25 Feb 2003
5169 \end_layout
5170
5171 \begin_layout Subsection*
5172 LFUN_DIALOG_TOGGLE
5173 \end_layout
5174
5175 \begin_layout Description
5176 Action Toggles dialog between showed/hidden state.
5177 \end_layout
5178
5179 \begin_layout Description
5180 Notion Internally uses LFUN_DIALOG_SHOW , LFUN_DIALOG_HIDE .
5181 \end_layout
5182
5183 \begin_layout Description
5184 Syntax dialog-toggle <NAME> [<DATA>]
5185 \end_layout
5186
5187 \begin_layout Description
5188 Params See LFUN_DIALOG_SHOW .
5189 \end_layout
5190
5191 \begin_layout Description
5192 Origin JSpitzm, 30 Apr 2007
5193 \end_layout
5194
5195 \begin_layout Subsection*
5196 LFUN_DIALOG_DISCONNECT_INSET
5197 \end_layout
5198
5199 \begin_layout Description
5200 Action Closes opened connection to opened inset.
5201 \end_layout
5202
5203 \begin_layout Description
5204 Notion Connection is used for apply functions.
5205 \end_layout
5206
5207 \begin_layout Description
5208 Syntax dialog-disconnect-inset <INSET-NAME>
5209 \end_layout
5210
5211 \begin_layout Description
5212 Origin leeming, 25 Feb 2003
5213 \end_layout
5214
5215 \begin_layout Subsection*
5216 LFUN_MOUSE_PRESS
5217 \end_layout
5218
5219 \begin_layout Description
5220 Action This function is called when mouse button is pressed (inside workarea).
5221  Action depends on the context.
5222 \end_layout
5223
5224 \begin_layout Description
5225 Notion This is internal LFUN, not to be used by users.
5226 \end_layout
5227
5228 \begin_layout Description
5229 Origin Andre, 9 Aug 2002
5230 \end_layout
5231
5232 \begin_layout Subsection*
5233 LFUN_MOUSE_DOUBLE
5234 \end_layout
5235
5236 \begin_layout Description
5237 Action This function is called when double click on mouse button is pressed
5238  (inside workarea).
5239  Action depends on the context.
5240 \end_layout
5241
5242 \begin_layout Description
5243 Notion This is internal LFUN, not to be used by users.
5244 \end_layout
5245
5246 \begin_layout Description
5247 Origin Andre, 9 Aug 2002
5248 \end_layout
5249
5250 \begin_layout Subsection*
5251 LFUN_MOUSE_TRIPLE
5252 \end_layout
5253
5254 \begin_layout Description
5255 Action This function is called when triple click on mouse button is pressed
5256  (inside workarea).
5257  Action depends on the context.
5258 \end_layout
5259
5260 \begin_layout Description
5261 Notion This is internal LFUN, not to be used by users.
5262 \end_layout
5263
5264 \begin_layout Description
5265 Origin Andre, 9 Aug 2002
5266 \end_layout
5267
5268 \begin_layout Subsection*
5269 LFUN_MOUSE_MOTION
5270 \end_layout
5271
5272 \begin_layout Description
5273 Action This function is called when mouse cursor is moving over the text.
5274  Action depends on the context.
5275 \end_layout
5276
5277 \begin_layout Description
5278 Notion This is internal LFUN, not to be used by users.
5279 \end_layout
5280
5281 \begin_layout Description
5282 Origin Andre, 9 Aug 2002
5283 \end_layout
5284
5285 \begin_layout Subsection*
5286 LFUN_MOUSE_RELEASE
5287 \end_layout
5288
5289 \begin_layout Description
5290 Action This function is called when mouse button is released (inside workarea).
5291  Action depends on the context.
5292 \end_layout
5293
5294 \begin_layout Description
5295 Notion This is internal LFUN, not to be used by users.
5296 \end_layout
5297
5298 \begin_layout Description
5299 Origin Andre, 9 Aug 2002
5300 \end_layout
5301
5302 \begin_layout Subsection*
5303 LFUN_KEYMAP_OFF
5304 \end_layout
5305
5306 \begin_layout Description
5307 Action Turn off the loaded keyboard map.
5308 \end_layout
5309
5310 \begin_layout Description
5311 Syntax keymap-off
5312 \end_layout
5313
5314 \begin_layout Subsection*
5315 LFUN_KEYMAP_PRIMARY
5316 \end_layout
5317
5318 \begin_layout Description
5319 Action Turn on the primary keyboard map.
5320 \end_layout
5321
5322 \begin_layout Description
5323 Notion Maps were widely used in past, when X-windows didn't have nowadays
5324  keyboard support.
5325  They can be still used to maintain uniform keyboard layout across the various
5326  plaforms.
5327 \begin_inset Newline newline
5328 \end_inset
5329
5330 The language is to be set in the Preferences dialog.
5331 \end_layout
5332
5333 \begin_layout Description
5334 Syntax keymap-primary
5335 \end_layout
5336
5337 \begin_layout Subsection*
5338 LFUN_KEYMAP_SECONDARY
5339 \end_layout
5340
5341 \begin_layout Description
5342 Action Turn on the secondary keyboard map.
5343 \end_layout
5344
5345 \begin_layout Description
5346 Syntax keymap-secondary
5347 \end_layout
5348
5349 \begin_layout Subsection*
5350 LFUN_KEYMAP_TOGGLE
5351 \end_layout
5352
5353 \begin_layout Description
5354 Action Toggles keyboard maps (first/second/off).
5355 \end_layout
5356
5357 \begin_layout Description
5358 Syntax keymap-toggle
5359 \end_layout
5360
5361 \begin_layout Description
5362 Origin leeming, 30 Mar 2004
5363 \end_layout
5364
5365 \begin_layout Subsection*
5366 LFUN_SERVER_GET_LAYOUT
5367 \end_layout
5368
5369 \begin_layout Description
5370 Action Returns the current layout (that is environment) name on the cursor
5371  position.
5372 \end_layout
5373
5374 \begin_layout Description
5375 Syntax server-get-layout
5376 \end_layout
5377
5378 \begin_layout Subsection*
5379 LFUN_SERVER_GET_FILENAME
5380 \end_layout
5381
5382 \begin_layout Description
5383 Action Returns path and file name of the currently edited document.
5384 \end_layout
5385
5386 \begin_layout Description
5387 Syntax server-get-filename
5388 \end_layout
5389
5390 \begin_layout Subsection*
5391 LFUN_SERVER_GOTO_FILE_ROW
5392 \end_layout
5393
5394 \begin_layout Description
5395 Action Sets the cursor position based on the row number of generated TeX
5396  file.
5397 \end_layout
5398
5399 \begin_layout Description
5400 Notion This can be useful for DVI inverse-search or detection of the problematic
5401  line from LaTeX compilation.
5402  Note that before this function can be used export to LaTeX output must
5403  occur (in order to map the row numbers).
5404 \end_layout
5405
5406 \begin_layout Description
5407 Syntax server-goto-file-row <FILE[.ext]> <ROW_NUMBER>
5408 \end_layout
5409
5410 \begin_layout Description
5411 Params <FILE>: the filename.
5412  Environment variables are expanded in the path.
5413  In case this LFUN does not work make sure you are giving correct path to
5414  the file.
5415 \begin_inset Newline newline
5416 \end_inset
5417
5418 If the file is located inside LyX temporary directory it will be mapped
5419  back into the appropriate opened buffer (e.g.
5420  for the case of generated .tex file).
5421  .ext: extensions will be automatically replaced by .lyx.
5422  <ROW_NUMBER> The row number of the LaTeX file to which to go.
5423 \end_layout
5424
5425 \begin_layout Description
5426 Origin Edmar, 23 Dec 1998
5427 \end_layout
5428
5429 \begin_layout Subsection*
5430 LFUN_SERVER_NOTIFY
5431 \end_layout
5432
5433 \begin_layout Description
5434 Action Sends notify message about the last key-sequence to client.
5435 \end_layout
5436
5437 \begin_layout Description
5438 Notion This can be used to grab last key-sequence used inside the LyX window.
5439  See also Debug extensions section in Additional features manual.
5440 \end_layout
5441
5442 \begin_layout Description
5443 Syntax server-notify
5444 \end_layout
5445
5446 \begin_layout Subsection*
5447 LFUN_SERVER_SET_XY
5448 \end_layout
5449
5450 \begin_layout Description
5451 Action Sets the cursor position based on the editing area coordinates (similar
5452  as clicking on that point with left mouse button).
5453 \end_layout
5454
5455 \begin_layout Description
5456 Syntax server-set-xy <X> <Y>
5457 \end_layout
5458
5459 \begin_layout Subsection*
5460 LFUN_SERVER_GET_XY
5461 \end_layout
5462
5463 \begin_layout Description
5464 Action Returns the coordinates of cursor position in the editing area.
5465 \end_layout
5466
5467 \begin_layout Description
5468 Syntax server-get-xy
5469 \end_layout
5470
5471 \begin_layout Subsection*
5472 LFUN_BUILD_PROGRAM
5473 \end_layout
5474
5475 \begin_layout Description
5476 Action Generates the code (literate programming).
5477 \end_layout
5478
5479 \begin_layout Description
5480 Notion Latex file with extension
5481 \backslash
5482 literate_extension is generated.
5483  Then LyX invokes
5484 \backslash
5485 build_command (with a default of``make'') to generate the code and
5486 \backslash
5487 build_error_filter to process the compilation error messages.
5488 \begin_inset Newline newline
5489 \end_inset
5490
5491 In case you want to process your literate file with a script, or some other
5492  program, just insert in your lyxrc file an entry with:
5493 \begin_inset Newline newline
5494 \end_inset
5495
5496
5497 \backslash
5498 build_command "my_script my_arguments"
5499 \begin_inset Newline newline
5500 \end_inset
5501
5502 The
5503 \backslash
5504 build_error_filter differs from the
5505 \backslash
5506 literate_error_filter only in that the former will identify error messages
5507  from your compiler.
5508 \end_layout
5509
5510 \begin_layout Description
5511 Syntax build-program
5512 \end_layout
5513
5514 \begin_layout Subsection*
5515 LFUN_BUFFER_AUTO_SAVE
5516 \end_layout
5517
5518 \begin_layout Description
5519 Action Saves the current buffer to a temporary file.
5520 \end_layout
5521
5522 \begin_layout Description
5523 Notion Saves the current buffer to a file named "#filename#".
5524  This LFUN is called automatically by LyX, to "autosave" the current buffer.
5525 \end_layout
5526
5527 \begin_layout Description
5528 Syntax buffer-auto-save
5529 \end_layout
5530
5531 \begin_layout Subsection*
5532 LFUN_BUFFER_CHILD_OPEN
5533 \end_layout
5534
5535 \begin_layout Description
5536 Action Loads the given child document.
5537 \end_layout
5538
5539 \begin_layout Description
5540 Notion The current document is treated as a parent.
5541 \end_layout
5542
5543 \begin_layout Description
5544 Syntax buffer-child-open <FILE>
5545 \end_layout
5546
5547 \begin_layout Description
5548 Params <FILE>: Filename of the child.
5549  The directory of the parent is assumed by default.
5550 \end_layout
5551
5552 \begin_layout Description
5553 Origin Ale, 28 May 1997
5554 \end_layout
5555
5556 \begin_layout Subsection*
5557 LFUN_BUFFER_CHKTEX
5558 \end_layout
5559
5560 \begin_layout Description
5561 Action Runs chktex for the current document.
5562 \end_layout
5563
5564 \begin_layout Description
5565 Syntax buffer-chktex
5566 \end_layout
5567
5568 \begin_layout Description
5569 Origin Asger, 30 Oct 1997
5570 \end_layout
5571
5572 \begin_layout Subsection*
5573 LFUN_BUFFER_TOGGLE_COMPRESSION
5574 \end_layout
5575
5576 \begin_layout Description
5577 Action Toggles compression of the current document on/off.
5578 \end_layout
5579
5580 \begin_layout Description
5581 Syntax buffer-toggle-compression
5582 \end_layout
5583
5584 \begin_layout Description
5585 Origin bpeng, 27 Apr 2006
5586 \end_layout
5587
5588 \begin_layout Subsection*
5589 LFUN_BUFFER_CLOSE
5590 \end_layout
5591
5592 \begin_layout Description
5593 Action Closes the current buffer.
5594 \end_layout
5595
5596 \begin_layout Description
5597 Notion Closes the current buffer, asking whether to save it, etc, if the
5598  buffer has been modified.
5599 \end_layout
5600
5601 \begin_layout Description
5602 Syntax buffer-close
5603 \end_layout
5604
5605 \begin_layout Subsection*
5606 LFUN_BUFFER_CLOSE_ALL
5607 \end_layout
5608
5609 \begin_layout Description
5610 Action Closes all buffers.
5611 \end_layout
5612
5613 \begin_layout Description
5614 Notion Closes all buffers, asking whether to save it, etc, if a buffer has
5615  been modified.
5616 \end_layout
5617
5618 \begin_layout Description
5619 Syntax buffer-close-all
5620 \end_layout
5621
5622 \begin_layout Subsection*
5623 LFUN_BUFFER_EXPORT
5624 \end_layout
5625
5626 \begin_layout Description
5627 Action Exports the current buffer (document) to the given format.
5628 \end_layout
5629
5630 \begin_layout Description
5631 Syntax buffer-export <FORMAT>
5632 \end_layout
5633
5634 \begin_layout Description
5635 Params <FORMAT> is either "custom" or one of the formats which you can find
5636  in Tools->Preferences->File formats->Format.
5637  Usual format you will enter is "pdf2" (pdflatex), "pdflatex" (plain tex
5638  for pdflatex) or "ps" for postscript.
5639 \begin_inset Newline newline
5640 \end_inset
5641
5642 In case of "custom" you will be asked for a format you want to start from
5643  and for the command that you want to apply to this format.
5644  Internally the control is then passed to LFUN_BUFFER_EXPORT_CUSTOM.
5645 \end_layout
5646
5647 \begin_layout Description
5648 Origin Lgb, 29 Jul 1997
5649 \end_layout
5650
5651 \begin_layout Subsection*
5652 LFUN_BUFFER_EXPORT_CUSTOM
5653 \end_layout
5654
5655 \begin_layout Description
5656 Action Exports the current buffer (document) from the given format using
5657  the given command on it.
5658 \end_layout
5659
5660 \begin_layout Description
5661 Syntax buffer-export-custom <FORMAT> <COMMAND>
5662 \end_layout
5663
5664 \begin_layout Description
5665 Params <FORMAT> format to start from (LyX will care to produce such intermediate
5666  file).
5667 \begin_inset Newline newline
5668 \end_inset
5669
5670 <COMMAND> this command will be launched on the file.
5671  Note that you can use "$$FName" string to qualify the intermediate file.
5672 \end_layout
5673
5674 \begin_layout Description
5675 Sample buffer-export-custom dvi dvips -f $$FName -o myfile.ps
5676 \end_layout
5677
5678 \begin_layout Description
5679 Origin leeming, 27 Mar 2004
5680 \end_layout
5681
5682 \begin_layout Subsection*
5683 LFUN_BUFFER_PRINT
5684 \end_layout
5685
5686 \begin_layout Description
5687 Action Prints the current document.
5688 \end_layout
5689
5690 \begin_layout Description
5691 Notion Many settings can be given via the preferences dialog.
5692 \end_layout
5693
5694 \begin_layout Description
5695 Syntax buffer-print <TARGET> <TARGET-NAME> <COMMAND>
5696 \end_layout
5697
5698 \begin_layout Description
5699 Params <TARGET> is either "printer" or "file".
5700 \begin_inset Newline newline
5701 \end_inset
5702
5703 <TARGER-NAME> is either "default" or file name or printer name.
5704 \begin_inset Newline newline
5705 \end_inset
5706
5707 <COMMAND> command ensuring the printing job.
5708 \end_layout
5709
5710 \begin_layout Description
5711 Sample buffer-print file "/trash/newfile1.ps" "dvips"
5712 \end_layout
5713
5714 \begin_layout Description
5715 Origin leeming, 28 Mar 2004
5716 \end_layout
5717
5718 \begin_layout Subsection*
5719 LFUN_BUFFER_IMPORT
5720 \end_layout
5721
5722 \begin_layout Description
5723 Action Import a given file as a lyx document.
5724 \end_layout
5725
5726 \begin_layout Description
5727 Notion File can be imported iff lyx file format is (transitively) reachable
5728  via defined convertors in preferences.
5729  Look into File->Import menu to get an idea of the currently active import
5730  formats.
5731 \end_layout
5732
5733 \begin_layout Description
5734 Syntax buffer-import <FORMAT> [<FILE>]
5735 \end_layout
5736
5737 \begin_layout Description
5738 Origin Asger, 24 Jul 1998
5739 \end_layout
5740
5741 \begin_layout Subsection*
5742 LFUN_BUFFER_NEW
5743 \end_layout
5744
5745 \begin_layout Description
5746 Action Creates a new buffer (that is, document).
5747 \end_layout
5748
5749 \begin_layout Description
5750 Notion Implicit path can be set in Preferences dialog.
5751 \end_layout
5752
5753 \begin_layout Description
5754 Syntax buffer-new [<FILE>]
5755 \end_layout
5756
5757 \begin_layout Description
5758 Params <FILE>: filename of created file with absolute path.
5759 \end_layout
5760
5761 \begin_layout Subsection*
5762 LFUN_BUFFER_NEW_TEMPLATE
5763 \end_layout
5764
5765 \begin_layout Description
5766 Action Creates a new buffer (that is, document) from a template.
5767 \end_layout
5768
5769 \begin_layout Description
5770 Notion Path for new files and templates can be set in Preferences dialog.
5771  Template will be asked for via Open-dialog.
5772 \end_layout
5773
5774 \begin_layout Description
5775 Syntax buffer-new-template [<FILE>]
5776 \end_layout
5777
5778 \begin_layout Description
5779 Params <FILE>: filename of created file with absolute path.
5780 \end_layout
5781
5782 \begin_layout Subsection*
5783 LFUN_BUFFER_RELOAD
5784 \end_layout
5785
5786 \begin_layout Description
5787 Action Reverts opened document.
5788 \end_layout
5789
5790 \begin_layout Description
5791 Syntax buffer-reload
5792 \end_layout
5793
5794 \begin_layout Description
5795 Origin Asger, 2 Feb 1997
5796 \end_layout
5797
5798 \begin_layout Subsection*
5799 LFUN_BUFFER_SWITCH
5800 \end_layout
5801
5802 \begin_layout Description
5803 Action Switch to the given buffer.
5804 \end_layout
5805
5806 \begin_layout Description
5807 Notion This is useful also in case you need simultaneously more views of
5808  the edited document in different LyX windows.
5809 \end_layout
5810
5811 \begin_layout Description
5812 Syntax buffer-new-template <BUFFER>
5813 \end_layout
5814
5815 \begin_layout Description
5816 Params <BUFFER>: already opened document which is to be shown.
5817 \end_layout
5818
5819 \begin_layout Subsection*
5820 LFUN_BUFFER_TOGGLE_READ_ONLY
5821 \end_layout
5822
5823 \begin_layout Description
5824 Action Toggle editing mode of the current document between read/write and
5825  read-only.
5826 \end_layout
5827
5828 \begin_layout Description
5829 Notion In the ->Readonly mode checks-in/commits the data if the file is
5830  under version control.
5831  In the Readonly-> mode checkouts the data from repository.
5832 \begin_inset Newline newline
5833 \end_inset
5834
5835 If these operations fail, buffer won't be toggled.
5836 \end_layout
5837
5838 \begin_layout Description
5839 Syntax buffer-toggle-read-only
5840 \end_layout
5841
5842 \begin_layout Description
5843 Origin Lgb, 27 May 1997
5844 \end_layout
5845
5846 \begin_layout Subsection*
5847 LFUN_BUFFER_VIEW
5848 \end_layout
5849
5850 \begin_layout Description
5851 Action Displays current buffer in chosen format.
5852 \end_layout
5853
5854 \begin_layout Description
5855 Notion Displays the contents of the current buffer in the chosen format,
5856  for example, PDF or DVI.
5857  This runs the necessary converter, calls the defined viewer, and so forth.
5858 \end_layout
5859
5860 \begin_layout Description
5861 Syntax buffer-view [<FORMAT>]
5862 \end_layout
5863
5864 \begin_layout Description
5865 Params <FORMAT>: The format to display, where this is one of the formats
5866  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5867  If no format is given, the default format as specified in the same dialog
5868  is used.
5869 \end_layout
5870
5871 \begin_layout Subsection*
5872 LFUN_BUFFER_UPDATE
5873 \end_layout
5874
5875 \begin_layout Description
5876 Action Exports the current document and put the result into the temporary
5877  directory.
5878 \end_layout
5879
5880 \begin_layout Description
5881 Notion In case you are already viewing the exported document (see LFUN_BUFFER_VI
5882 EW) the output will be rewriten - updated.
5883  This is useful in case your viewer is able to detect such changes (e.g.
5884  ghostview for postscript).
5885 \end_layout
5886
5887 \begin_layout Description
5888 Syntax buffer-update [<FORMAT>]
5889 \end_layout
5890
5891 \begin_layout Description
5892 Params <FORMAT>: The format to display, where this is one of the formats
5893  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5894  If no format is given, the default format as specified in the same dialog
5895  is used.
5896 \end_layout
5897
5898 \begin_layout Description
5899 Origin Dekel, 5 Aug 2000
5900 \end_layout
5901
5902 \begin_layout Subsection*
5903 LFUN_BUFFER_WRITE
5904 \end_layout
5905
5906 \begin_layout Description
5907 Action Saves the current buffer.
5908 \end_layout
5909
5910 \begin_layout Description
5911 Notion Saves the current buffer to disk, using the filename that is already
5912  associated with the buffer, asking for one if none is yet assigned.
5913 \end_layout
5914
5915 \begin_layout Description
5916 Syntax buffer-write
5917 \end_layout
5918
5919 \begin_layout Subsection*
5920 LFUN_BUFFER_WRITE_AS
5921 \end_layout
5922
5923 \begin_layout Description
5924 Action Rename and save current buffer.
5925 \end_layout
5926
5927 \begin_layout Description
5928 Syntax buffer-write-as <FILENAME>
5929 \end_layout
5930
5931 \begin_layout Description
5932 Params <FILENAME>: New name of the buffer/file.
5933  A relative path is with respect to the original location of the buffer/file.
5934 \end_layout
5935
5936 \begin_layout Subsection*
5937 LFUN_BUFFER_WRITE_ALL
5938 \end_layout
5939
5940 \begin_layout Description
5941 Action Save all changed documents.
5942 \end_layout
5943
5944 \begin_layout Description
5945 Syntax buffer-write-all
5946 \end_layout
5947
5948 \begin_layout Description
5949 Origin rgh, gpothier 6 Aug 2007
5950 \end_layout
5951
5952 \begin_layout Subsection*
5953 LFUN_BUFFER_NEXT
5954 \end_layout
5955
5956 \begin_layout Description
5957 Action Switch to the next opened document.
5958 \end_layout
5959
5960 \begin_layout Description
5961 Notion Note that this does not necessarily mean next in tabbar (for full
5962  list see View menu).
5963 \end_layout
5964
5965 \begin_layout Description
5966 Syntax buffer-next
5967 \end_layout
5968
5969 \begin_layout Subsection*
5970 LFUN_BUFFER_PREVIOUS
5971 \end_layout
5972
5973 \begin_layout Description
5974 Action Switch to the previous opened document.
5975 \end_layout
5976
5977 \begin_layout Description
5978 Syntax buffer-previous
5979 \end_layout
5980
5981 \begin_layout Subsection*
5982 LFUN_MASTER_BUFFER_UPDATE
5983 \end_layout
5984
5985 \begin_layout Description
5986 Action When run from a child document, this updates (exports) document built
5987  from the master buffer, if available.
5988 \end_layout
5989
5990 \begin_layout Description
5991 Syntax master-buffer-update [<FORMAT>]
5992 \end_layout
5993
5994 \begin_layout Description
5995 Params <FORMAT>: The format to display, where this is one of the formats
5996  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
5997  If no format is given, the default format as specified in the same dialog
5998  is used.
5999 \end_layout
6000
6001 \begin_layout Description
6002 Origin Tommaso, 20 Sep 2007
6003 \end_layout
6004
6005 \begin_layout Subsection*
6006 LFUN_MASTER_BUFFER_VIEW
6007 \end_layout
6008
6009 \begin_layout Description
6010 Action When run from a child document, this command shows a preview built
6011  from the master buffer, if available.
6012 \end_layout
6013
6014 \begin_layout Description
6015 Syntax master-buffer-view [<FORMAT>]
6016 \end_layout
6017
6018 \begin_layout Description
6019 Params <FORMAT>: The format to display, where this is one of the formats
6020  defined (in the current GUI) in the Tools>Preferences>File Formats dialog.
6021  If no format is given, the default format as specified in the same dialog
6022  is used.
6023 \end_layout
6024
6025 \begin_layout Description
6026 Origin Tommaso, 20 Sep 2007
6027 \end_layout
6028
6029 \begin_layout Subsection*
6030 LFUN_BUFFER_LANGUAGE
6031 \end_layout
6032
6033 \begin_layout Description
6034 Action Set language of the current document.
6035 \end_layout
6036
6037 \begin_layout Description
6038 Syntax buffer-language <LANG>
6039 \end_layout
6040
6041 \begin_layout Description
6042 Params <LANG>: language name.
6043  See lib/languages for list.
6044 \end_layout
6045
6046 \begin_layout Description
6047 Origin leeming, 30 Mar 2004
6048 \end_layout
6049
6050 \begin_layout Subsection*
6051 LFUN_BUFFER_SAVE_AS_DEFAULT
6052 \end_layout
6053
6054 \begin_layout Description
6055 Action Save the current document settings as default.
6056 \end_layout
6057
6058 \begin_layout Description
6059 Notion The file will will be saved into ~/.lyx/templates/defaults.lyx .
6060 \end_layout
6061
6062 \begin_layout Description
6063 Syntax buffer-save-as-default [<ARGS>]
6064 \end_layout
6065
6066 \begin_layout Description
6067 Params <ARGS>: contains the particular settings to be saved.
6068  They obey the syntax you can find in document header of usual .lyx file.
6069 \end_layout
6070
6071 \begin_layout Description
6072 Origin leeming, 30 Mar 2004
6073 \end_layout
6074
6075 \begin_layout Subsection*
6076 LFUN_BUFFER_PARAMS_APPLY
6077 \end_layout
6078
6079 \begin_layout Description
6080 Action Apply the given settings to the current document.
6081 \end_layout
6082
6083 \begin_layout Description
6084 Syntax buffer-params-apply [<ARGS>]
6085 \end_layout
6086
6087 \begin_layout Description
6088 Params <ARGS>: contains the particular settings to be saved.
6089  They obey the syntax you can find in document header of usual .lyx file.
6090 \end_layout
6091
6092 \begin_layout Description
6093 Origin leeming, 30 Mar 2004
6094 \end_layout
6095
6096 \begin_layout Subsection*
6097 LFUN_FILE_INSERT
6098 \end_layout
6099
6100 \begin_layout Description
6101 Action Inserts another LyX file.
6102 \end_layout
6103
6104 \begin_layout Description
6105 Syntax file-insert [<FILE>]
6106 \end_layout
6107
6108 \begin_layout Description
6109 Params <FILE>: Filename to be inserted.
6110 \end_layout
6111
6112 \begin_layout Subsection*
6113 LFUN_FILE_INSERT_PLAINTEXT
6114 \end_layout
6115
6116 \begin_layout Description
6117 Action Inserts plain text file.
6118 \end_layout
6119
6120 \begin_layout Description
6121 Syntax file-insert-plaintext [<FILE>]
6122 \end_layout
6123
6124 \begin_layout Description
6125 Params <FILE>: Filename to be inserted.
6126 \end_layout
6127
6128 \begin_layout Description
6129 Origin CFO-G, 19 Nov 1997
6130 \end_layout
6131
6132 \begin_layout Subsection*
6133 LFUN_FILE_INSERT_PLAINTEXT_PARA
6134 \end_layout
6135
6136 \begin_layout Description
6137 Action Inserts plain text file as paragraph (i.e.
6138  join lines).
6139 \end_layout
6140
6141 \begin_layout Description
6142 Syntax file-insert-plaintext-para [<FILE>]
6143 \end_layout
6144
6145 \begin_layout Description
6146 Params <FILE>: Filename to be inserted.
6147 \end_layout
6148
6149 \begin_layout Description
6150 Origin Levon, 14 Feb 2001
6151 \end_layout
6152
6153 \begin_layout Subsection*
6154 LFUN_FILE_OPEN
6155 \end_layout
6156
6157 \begin_layout Description
6158 Action Open LyX document.
6159 \end_layout
6160
6161 \begin_layout Description
6162 Syntax file-open [<FILE>]
6163 \end_layout
6164
6165 \begin_layout Description
6166 Params <FILE>: Filename to be opened.
6167 \end_layout
6168
6169 \begin_layout Subsection*
6170 LFUN_CALL
6171 \end_layout
6172
6173 \begin_layout Description
6174 Action Executes a command defined in a .def file.
6175 \end_layout
6176
6177 \begin_layout Description
6178 Notion The definitions are by default read from lib/commands/default.def.
6179 \begin_inset Newline newline
6180 \end_inset
6181
6182 A .def file allows to define a command with
6183 \backslash
6184 define "<NAME>" "<LFUN>" where <NAME> is the name of the new command and
6185  <LFUN> is the lfun code to be executed (see e.g.
6186  LFUN_COMMAND_SEQUENCE).
6187
6188 \backslash
6189 def_file "FileName" allows to include another .def file.
6190 \begin_inset Newline newline
6191 \end_inset
6192
6193 This is particularly useful in connection with toolbar buttons: Since the
6194  name of the button image for this lfun is lib/images/commands/<NAME>.png
6195  this is the way to assign an image to a complex command-sequence.
6196 \end_layout
6197
6198 \begin_layout Description
6199 Syntax call <NAME>
6200 \end_layout
6201
6202 \begin_layout Description
6203 Params <NAME>: Name of the command that must be called.
6204 \end_layout
6205
6206 \begin_layout Description
6207 Origin broider, 2 Oct 2007
6208 \end_layout
6209
6210 \begin_layout Subsection*
6211 LFUN_META_PREFIX
6212 \end_layout
6213
6214 \begin_layout Description
6215 Action Simulate halting Meta key (Alt key on PCs).
6216 \end_layout
6217
6218 \begin_layout Description
6219 Notion Used for buffer editation not for GUI control.
6220 \end_layout
6221
6222 \begin_layout Description
6223 Syntax meta-prefix
6224 \end_layout
6225
6226 \begin_layout Subsection*
6227 LFUN_CANCEL
6228 \end_layout
6229
6230 \begin_layout Description
6231 Action Cancels sequence prepared by LFUN_META_PREFIX .
6232 \end_layout
6233
6234 \begin_layout Description
6235 Syntax cancel
6236 \end_layout
6237
6238 \begin_layout Subsection*
6239 LFUN_COMMAND_EXECUTE
6240 \end_layout
6241
6242 \begin_layout Description
6243 Action Opens the minibuffer toolbar so that the user can type in there.
6244 \end_layout
6245
6246 \begin_layout Description
6247 Notion Usually bound to M-x shortcut.
6248 \end_layout
6249
6250 \begin_layout Description
6251 Syntax command-execute
6252 \end_layout
6253
6254 \begin_layout Subsection*
6255 LFUN_COMMAND_PREFIX
6256 \end_layout
6257
6258 \begin_layout Description
6259 Action Return the current key sequence and available options as a string.
6260 \end_layout
6261
6262 \begin_layout Description
6263 Notion No options are added if no current map exists.
6264 \begin_inset Newline newline
6265 \end_inset
6266
6267 This is probably usable only with connection to lyxserver.
6268 \end_layout
6269
6270 \begin_layout Description
6271 Syntax command-prefix
6272 \end_layout
6273
6274 \begin_layout Subsection*
6275 LFUN_COMMAND_SEQUENCE
6276 \end_layout
6277
6278 \begin_layout Description
6279 Action Run more commands (LFUN and its parameters) in a sequence.
6280 \end_layout
6281
6282 \begin_layout Description
6283 Syntax command-sequence <CMDS>
6284 \end_layout
6285
6286 \begin_layout Description
6287 Params <CMDS>: Sequence of commands separated by semicolons.
6288 \end_layout
6289
6290 \begin_layout Description
6291 Sample command-sequence cut; ert-insert; self-insert
6292 \backslash
6293 ; paste; self-insert {}; inset-toggle;
6294 \end_layout
6295
6296 \begin_layout Description
6297 Origin Andre, 11 Nov 1999
6298 \end_layout
6299
6300 \begin_layout Subsection*
6301 LFUN_COMMAND_ALTERNATIVES
6302 \end_layout
6303
6304 \begin_layout Description
6305 Action Runs the first listed command that is enabled.
6306 \end_layout
6307
6308 \begin_layout Description
6309 Notion This can be used to bind multiple functions to a single key, and
6310  then which one is used will depend upon the context.
6311 \end_layout
6312
6313 \begin_layout Description
6314 Syntax command-alternatives <CMDS>
6315 \end_layout
6316
6317 \begin_layout Description
6318 Params <CMDS>: Sequence of commands separated by semicolons.
6319 \end_layout
6320
6321 \begin_layout Description
6322 Sample command-alternatives completion-accept;cell-forward
6323 \end_layout
6324
6325 \begin_layout Description
6326 Origin rgh, 24 September 2008
6327 \end_layout
6328
6329 \begin_layout Subsection*
6330 LFUN_MESSAGE
6331 \end_layout
6332
6333 \begin_layout Description
6334 Action Shows message in statusbar (for script purposes).
6335 \end_layout
6336
6337 \begin_layout Description
6338 Syntax message <STRING>
6339 \end_layout
6340
6341 \begin_layout Description
6342 Origin Lgb, 8 Apr 2001
6343 \end_layout
6344
6345 \begin_layout Subsection*
6346 LFUN_PREFERENCES_SAVE
6347 \end_layout
6348
6349 \begin_layout Description
6350 Action Save user preferences.
6351 \end_layout
6352
6353 \begin_layout Description
6354 Syntax preferences-save
6355 \end_layout
6356
6357 \begin_layout Description
6358 Origin Lgb, 27 Nov 1999
6359 \end_layout
6360
6361 \begin_layout Subsection*
6362 LFUN_RECONFIGURE
6363 \end_layout
6364
6365 \begin_layout Description
6366 Action Reconfigure the automatic settings.
6367 \end_layout
6368
6369 \begin_layout Description
6370 Syntax reconfigure
6371 \end_layout
6372
6373 \begin_layout Description
6374 Origin Asger, 14 Feb 1997
6375 \end_layout
6376
6377 \begin_layout Subsection*
6378 LFUN_LYXRC_APPLY
6379 \end_layout
6380
6381 \begin_layout Description
6382 Action Apply the given settings to user preferences.
6383 \end_layout
6384
6385 \begin_layout Description
6386 Syntax lyxrc-apply <SETTINGS>
6387 \end_layout
6388
6389 \begin_layout Description
6390 Params <SETTINGS>: settings which are to be set.
6391  Take a look into ~/.lyx/preferences to get an idea which commands to use
6392  and their syntax.
6393  lyx::LyXRC::LyXRCTags has the list of possible commands.
6394 \end_layout
6395
6396 \begin_layout Subsection*
6397 LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE
6398 \end_layout
6399
6400 \begin_layout Description
6401 Action Determine whether keep cursor inside the editing window regardless
6402  the scrollbar movement.
6403 \end_layout
6404
6405 \begin_layout Description
6406 Syntax toggle-cursor-follows-scrollbar
6407 \end_layout
6408
6409 \begin_layout Description
6410 Origin ARRae, 2 Dec 1997
6411 \end_layout
6412
6413 \begin_layout Subsection*
6414 LFUN_SET_COLOR
6415 \end_layout
6416
6417 \begin_layout Description
6418 Action Set the given LyX color to the color defined by the X11 name given.
6419 \end_layout
6420
6421 \begin_layout Description
6422 Notion A new color entry is created if the color is unknown.
6423  Color names can be stored as a part of user settings.
6424 \end_layout
6425
6426 \begin_layout Description
6427 Syntax set-color <LYX_NAME> <X11_NAME>
6428 \end_layout
6429
6430 \begin_layout Description
6431 Origin SLior, 11 Jun 2000
6432 \end_layout
6433
6434 \begin_layout Subsection*
6435 LFUN_STATISTICS
6436 \end_layout
6437
6438 \begin_layout Description
6439 Action Count the statistics (number of words and characters) in the document
6440  or in the given selection.
6441 \end_layout
6442
6443 \begin_layout Description
6444 Notion Note that this function gives the number of words/chars written,
6445  not the number of characters which will be typeset.
6446 \end_layout
6447
6448 \begin_layout Description
6449 Syntax statistics
6450 \end_layout
6451
6452 \begin_layout Description
6453 Origin lasgouttes, Jan 27 2004; sanda, Jan 8 2008
6454 \end_layout
6455
6456 \begin_layout Subsection*
6457 LFUN_COMPLETION_INLINE
6458 \end_layout
6459
6460 \begin_layout Description
6461 Action Show the inline completion at the cursor position.
6462 \end_layout
6463
6464 \begin_layout Description
6465 Syntax completion-inline
6466 \end_layout
6467
6468 \begin_layout Description
6469 Origin sts, Feb 19 2008
6470 \end_layout
6471
6472 \begin_layout Subsection*
6473 LFUN_COMPLETION_POPUP
6474 \end_layout
6475
6476 \begin_layout Description
6477 Action Show the completion popup at the cursor position.
6478 \end_layout
6479
6480 \begin_layout Description
6481 Syntax completion-popup
6482 \end_layout
6483
6484 \begin_layout Description
6485 Origin sts, Feb 19 2008
6486 \end_layout
6487
6488 \begin_layout Subsection*
6489 LFUN_COMPLETION_COMPLETE
6490 \end_layout
6491
6492 \begin_layout Description
6493 Action Try to complete the word or command at the cursor position.
6494 \end_layout
6495
6496 \begin_layout Description
6497 Syntax complete
6498 \end_layout
6499
6500 \begin_layout Description
6501 Origin sts, Feb 19 2008
6502 \end_layout
6503
6504 \begin_layout Subsection*
6505 LFUN_COMPLETION_CANCEL
6506 \end_layout
6507
6508 \begin_layout Description
6509 Action Try to cancel completion, either the popup or the inline completion.
6510 \end_layout
6511
6512 \begin_layout Description
6513 Syntax completion-cancel
6514 \end_layout
6515
6516 \begin_layout Description
6517 Origin sts, Sep 07 2008
6518 \end_layout
6519
6520 \begin_layout Subsection*
6521 LFUN_COMPLETION_ACCEPT
6522 \end_layout
6523
6524 \begin_layout Description
6525 Action Accept suggested completion.
6526 \end_layout
6527
6528 \begin_layout Description
6529 Syntax completion-accept
6530 \end_layout
6531
6532 \begin_layout Description
6533 Origin sanda, Sep 08 2008
6534 \end_layout
6535
6536 \begin_layout Subsection*
6537 LFUN_BRANCH_ADD
6538 \end_layout
6539
6540 \begin_layout Description
6541 Action Add a branch to the buffer's BranchList.
6542 \end_layout
6543
6544 \begin_layout Description
6545 Syntax branch-add <BRANCH>
6546 \end_layout
6547
6548 \begin_layout Description
6549 Params <BRANCH>: Name of the branch to add
6550 \end_layout
6551
6552 \begin_layout Description
6553 Origin spitz, 7 Jul 2009
6554 \end_layout
6555
6556 \begin_layout Subsection*
6557 LFUN_BRANCH_ACTIVATE
6558 \end_layout
6559
6560 \begin_layout Description
6561 Action Activate the branch.
6562 \end_layout
6563
6564 \begin_layout Description
6565 Syntax branch-activate <BRANCH>
6566 \end_layout
6567
6568 \begin_layout Description
6569 Params <BRANCH>: The branch to activate
6570 \end_layout
6571
6572 \begin_layout Description
6573 Sample lyx -x "branch-activate answers" -e pdf2 finalexam.lyx
6574 \begin_inset Newline newline
6575 \end_inset
6576
6577 could be used to export a pdf with the answers branch included without one's
6578  having to open LyX and activate the branch manually.
6579 \end_layout
6580
6581 \begin_layout Description
6582 Origin rgh, 27 May 2008
6583 \end_layout
6584
6585 \begin_layout Subsection*
6586 LFUN_BRANCH_DEACTIVATE
6587 \end_layout
6588
6589 \begin_layout Description
6590 Action De-activate the branch.
6591 \end_layout
6592
6593 \begin_layout Description
6594 Syntax branch-deactivate <BRANCH>
6595 \end_layout
6596
6597 \begin_layout Description
6598 Params <BRANCH>: The branch to deactivate
6599 \end_layout
6600
6601 \begin_layout Description
6602 Origin rgh, 27 May 2008
6603 \end_layout
6604
6605 \begin_layout Subsection*
6606 LFUN_BRANCHES_RENAME
6607 \end_layout
6608
6609 \begin_layout Description
6610 Action Rename all branches of a given name in a document.
6611 \end_layout
6612
6613 \begin_layout Description
6614 Syntax branches-rename <OLDNAME> <NEWNAME>
6615 \end_layout
6616
6617 \begin_layout Description
6618 Params <OLDNAME>: Current name of the branch to be renamed <NEWNAME>: New
6619  name of the branch
6620 \end_layout
6621
6622 \begin_layout Description
6623 Origin spitz, 9 Jul 2009
6624 \end_layout
6625
6626 \begin_layout Subsection*
6627 LFUN_BRANCH_ADD_INSERT
6628 \end_layout
6629
6630 \begin_layout Description
6631 Action Create new branch and directly put the branch inset into the document.
6632 \end_layout
6633
6634 \begin_layout Description
6635 Syntax branch-add-insert [<NAME>]
6636 \end_layout
6637
6638 \begin_layout Description
6639 Params <NAME>: Branch name.
6640  If it is not specified, you will be asked.
6641 \end_layout
6642
6643 \begin_layout Description
6644 Origin sanda, 10 Jul 2009
6645 \end_layout
6646
6647 \begin_layout Subsection*
6648 LFUN_LABEL_COPY_AS_REF
6649 \end_layout
6650
6651 \begin_layout Description
6652 Action Copies the label at the cursor as a cross-reference to be pasted
6653  elsewhere.
6654 \end_layout
6655
6656 \begin_layout Description
6657 Syntax copy-label-as-reference <LABEL>
6658 \end_layout
6659
6660 \begin_layout Description
6661 Params <LABEL>: The label to copy (for multi-line math)
6662 \end_layout
6663
6664 \begin_layout Description
6665 Origin sts, 16 Nov 2008
6666 \end_layout
6667
6668 \begin_layout Subsection*
6669 LFUN_LABEL_INSERT_AS_REF
6670 \end_layout
6671
6672 \begin_layout Description
6673 Action Inserts the label as a cross-reference at the position of the cursor.
6674 \end_layout
6675
6676 \begin_layout Description
6677 Syntax label-insert-as-reference
6678 \end_layout
6679
6680 \begin_layout Description
6681 Origin vfr, 7 Apr 2009
6682 \end_layout
6683
6684 \begin_layout Subsection*
6685 LFUN_BUFFER_ZOOM_IN
6686 \end_layout
6687
6688 \begin_layout Description
6689 Action Increases the zoom of the screen fonts.
6690 \end_layout
6691
6692 \begin_layout Description
6693 Syntax buffer-zoom-in [<ZOOM>]
6694 \end_layout
6695
6696 \begin_layout Description
6697 Params <ZOOM>: The zoom in %, the default is 20.
6698 \end_layout
6699
6700 \begin_layout Description
6701 Origin vfr, 30 Mar 2009
6702 \end_layout
6703
6704 \begin_layout Subsection*
6705 LFUN_BUFFER_ZOOM_OUT
6706 \end_layout
6707
6708 \begin_layout Description
6709 Action Decreases the zoom of the screen fonts.
6710 \end_layout
6711
6712 \begin_layout Description
6713 Syntax buffer-zoom-out [<ZOOM>]
6714 \end_layout
6715
6716 \begin_layout Description
6717 Params <ZOOM>: The zoom in %, the default is 20.
6718 \end_layout
6719
6720 \begin_layout Description
6721 Origin vfr, 30 Mar 2009
6722 \end_layout
6723
6724 \begin_layout Subsection*
6725 LFUN_SECTION_SELECT
6726 \end_layout
6727
6728 \begin_layout Description
6729 Action Selects the whole section.
6730 \end_layout
6731
6732 \begin_layout Description
6733 Notion The cursor should be in a section heading before calling this lfun.
6734 \end_layout
6735
6736 \begin_layout Description
6737 Syntax section-select
6738 \end_layout
6739
6740 \begin_layout Description
6741 Origin vfr, 05 May 2009
6742 \end_layout
6743
6744 \begin_layout Subsection*
6745 LFUN_GRAPHICS_RELOAD
6746 \end_layout
6747
6748 \begin_layout Description
6749 Action Reloads the image if necessary.
6750 \end_layout
6751
6752 \begin_layout Description
6753 Syntax graphics-reload
6754 \end_layout
6755
6756 \begin_layout Description
6757 Origin vfr, 10 Aug 2009
6758 \end_layout
6759
6760 \end_body
6761 \end_document