wxPython/contrib/stc/_stc_gendocs.i

   1 DocStr(wxStyledTextCtrl::AddText,
   2 "Add text to the document at current position.", "");
   3
   4 DocStr(wxStyledTextCtrl::AddStyledText,
   5 "Add array of cells to document.", "");
   6
   7 DocStr(wxStyledTextCtrl::InsertText,
   8 "Insert string at a position.", "");
   9
  10 DocStr(wxStyledTextCtrl::ClearAll,
  11 "Delete all text in the document.", "");
  12
  13 DocStr(wxStyledTextCtrl::ClearDocumentStyle,
  14 "Set all style bytes to 0, remove all folding information.", "");
  15
  16 DocStr(wxStyledTextCtrl::GetLength,
  17 "Returns the number of characters in the document.", "");
  18
  19 DocStr(wxStyledTextCtrl::GetCharAt,
  20 "Returns the character byte at the position.", "");
  21
  22 DocStr(wxStyledTextCtrl::GetCurrentPos,
  23 "Returns the position of the caret.", "");
  24
  25 DocStr(wxStyledTextCtrl::GetAnchor,
  26 "Returns the position of the opposite end of the selection to the caret.", "");
  27
  28 DocStr(wxStyledTextCtrl::GetStyleAt,
  29 "Returns the style byte at the position.", "");
  30
  31 DocStr(wxStyledTextCtrl::Redo,
  32 "Redoes the next action on the undo history.", "");
  33
  34 DocStr(wxStyledTextCtrl::SetUndoCollection,
  35 "Choose between collecting actions into the undo
  36 history and discarding them.", "");
  37
  38 DocStr(wxStyledTextCtrl::SelectAll,
  39 "Select all the text in the document.", "");
  40
  41 DocStr(wxStyledTextCtrl::SetSavePoint,
  42 "Remember the current position in the undo history as the position
  43 at which the document was saved.", "");
  44
  45 DocStr(wxStyledTextCtrl::GetStyledText,
  46 "Retrieve a buffer of cells.", "");
  47
  48 DocStr(wxStyledTextCtrl::CanRedo,
  49 "Are there any redoable actions in the undo history?", "");
  50
  51 DocStr(wxStyledTextCtrl::MarkerLineFromHandle,
  52 "Retrieve the line number at which a particular marker is located.", "");
  53
  54 DocStr(wxStyledTextCtrl::MarkerDeleteHandle,
  55 "Delete a marker.", "");
  56
  57 DocStr(wxStyledTextCtrl::GetUndoCollection,
  58 "Is undo history being collected?", "");
  59
  60 DocStr(wxStyledTextCtrl::GetViewWhiteSpace,
  61 "Are white space characters currently visible?
  62 Returns one of SCWS_* constants.", "");
  63
  64 DocStr(wxStyledTextCtrl::SetViewWhiteSpace,
  65 "Make white space characters invisible, always visible or visible outside indentation.", "");
  66
  67 DocStr(wxStyledTextCtrl::PositionFromPoint,
  68 "Find the position from a point within the window.", "");
  69
  70 DocStr(wxStyledTextCtrl::PositionFromPointClose,
  71 "Find the position from a point within the window but return
  72 INVALID_POSITION if not close to text.", "");
  73
  74 DocStr(wxStyledTextCtrl::GotoLine,
  75 "Set caret to start of a line and ensure it is visible.", "");
  76
  77 DocStr(wxStyledTextCtrl::GotoPos,
  78 "Set caret to a position and ensure it is visible.", "");
  79
  80 DocStr(wxStyledTextCtrl::SetAnchor,
  81 "Set the selection anchor to a position. The anchor is the opposite
  82 end of the selection from the caret.", "");
  83
  84 DocStr(wxStyledTextCtrl::GetCurLine,
  85 "Retrieve the text of the line containing the caret.
  86 Returns the index of the caret on the line.", "");
  87
  88 DocStr(wxStyledTextCtrl::GetEndStyled,
  89 "Retrieve the position of the last correctly styled character.", "");
  90
  91 DocStr(wxStyledTextCtrl::ConvertEOLs,
  92 "Convert all line endings in the document to one mode.", "");
  93
  94 DocStr(wxStyledTextCtrl::GetEOLMode,
  95 "Retrieve the current end of line mode - one of CRLF, CR, or LF.", "");
  96
  97 DocStr(wxStyledTextCtrl::SetEOLMode,
  98 "Set the current end of line mode.", "");
  99
 100 DocStr(wxStyledTextCtrl::StartStyling,
 101 "Set the current styling position to pos and the styling mask to mask.
 102 The styling mask can be used to protect some bits in each styling byte from modification.", "");
 103
 104 DocStr(wxStyledTextCtrl::SetStyling,
 105 "Change style from current styling position for length characters to a style
 106 and move the current styling position to after this newly styled segment.", "");
 107
 108 DocStr(wxStyledTextCtrl::GetBufferedDraw,
 109 "Is drawing done first into a buffer or direct to the screen?", "");
 110
 111 DocStr(wxStyledTextCtrl::SetBufferedDraw,
 112 "If drawing is buffered then each line of text is drawn into a bitmap buffer
 113 before drawing it to the screen to avoid flicker.", "");
 114
 115 DocStr(wxStyledTextCtrl::SetTabWidth,
 116 "Change the visible size of a tab to be a multiple of the width of a space character.", "");
 117
 118 DocStr(wxStyledTextCtrl::GetTabWidth,
 119 "Retrieve the visible size of a tab.", "");
 120
 121 DocStr(wxStyledTextCtrl::SetCodePage,
 122 "Set the code page used to interpret the bytes of the document as characters.", "");
 123
 124 DocStr(wxStyledTextCtrl::MarkerDefine,
 125 "Set the symbol used for a particular marker number,
 126 and optionally the fore and background colours.", "");
 127
 128 DocStr(wxStyledTextCtrl::MarkerSetForeground,
 129 "Set the foreground colour used for a particular marker number.", "");
 130
 131 DocStr(wxStyledTextCtrl::MarkerSetBackground,
 132 "Set the background colour used for a particular marker number.", "");
 133
 134 DocStr(wxStyledTextCtrl::MarkerAdd,
 135 "Add a marker to a line, returning an ID which can be used to find or delete the marker.", "");
 136
 137 DocStr(wxStyledTextCtrl::MarkerDelete,
 138 "Delete a marker from a line.", "");
 139
 140 DocStr(wxStyledTextCtrl::MarkerDeleteAll,
 141 "Delete all markers with a particular number from all lines.", "");
 142
 143 DocStr(wxStyledTextCtrl::MarkerGet,
 144 "Get a bit mask of all the markers set on a line.", "");
 145
 146 DocStr(wxStyledTextCtrl::MarkerNext,
 147 "Find the next line after lineStart that includes a marker in mask.", "");
 148
 149 DocStr(wxStyledTextCtrl::MarkerPrevious,
 150 "Find the previous line before lineStart that includes a marker in mask.", "");
 151
 152 DocStr(wxStyledTextCtrl::MarkerDefineBitmap,
 153 "Define a marker from a bitmap", "");
 154
 155 DocStr(wxStyledTextCtrl::MarkerAddSet,
 156 "Add a set of markers to a line.", "");
 157
 158 DocStr(wxStyledTextCtrl::MarkerSetAlpha,
 159 "Set the alpha used for a marker that is drawn in the text area, not the margin.", "");
 160
 161 DocStr(wxStyledTextCtrl::SetMarginType,
 162 "Set a margin to be either numeric or symbolic.", "");
 163
 164 DocStr(wxStyledTextCtrl::GetMarginType,
 165 "Retrieve the type of a margin.", "");
 166
 167 DocStr(wxStyledTextCtrl::SetMarginWidth,
 168 "Set the width of a margin to a width expressed in pixels.", "");
 169
 170 DocStr(wxStyledTextCtrl::GetMarginWidth,
 171 "Retrieve the width of a margin in pixels.", "");
 172
 173 DocStr(wxStyledTextCtrl::SetMarginMask,
 174 "Set a mask that determines which markers are displayed in a margin.", "");
 175
 176 DocStr(wxStyledTextCtrl::GetMarginMask,
 177 "Retrieve the marker mask of a margin.", "");
 178
 179 DocStr(wxStyledTextCtrl::SetMarginSensitive,
 180 "Make a margin sensitive or insensitive to mouse clicks.", "");
 181
 182 DocStr(wxStyledTextCtrl::GetMarginSensitive,
 183 "Retrieve the mouse click sensitivity of a margin.", "");
 184
 185 DocStr(wxStyledTextCtrl::StyleClearAll,
 186 "Clear all the styles and make equivalent to the global default style.", "");
 187
 188 DocStr(wxStyledTextCtrl::StyleSetForeground,
 189 "Set the foreground colour of a style.", "");
 190
 191 DocStr(wxStyledTextCtrl::StyleSetBackground,
 192 "Set the background colour of a style.", "");
 193
 194 DocStr(wxStyledTextCtrl::StyleSetBold,
 195 "Set a style to be bold or not.", "");
 196
 197 DocStr(wxStyledTextCtrl::StyleSetItalic,
 198 "Set a style to be italic or not.", "");
 199
 200 DocStr(wxStyledTextCtrl::StyleSetSize,
 201 "Set the size of characters of a style.", "");
 202
 203 DocStr(wxStyledTextCtrl::StyleSetFaceName,
 204 "Set the font of a style.", "");
 205
 206 DocStr(wxStyledTextCtrl::StyleSetEOLFilled,
 207 "Set a style to have its end of line filled or not.", "");
 208
 209 DocStr(wxStyledTextCtrl::StyleResetDefault,
 210 "Reset the default style to its state at startup", "");
 211
 212 DocStr(wxStyledTextCtrl::StyleSetUnderline,
 213 "Set a style to be underlined or not.", "");
 214
 215 DocStr(wxStyledTextCtrl::StyleSetCase,
 216 "Set a style to be mixed case, or to force upper or lower case.", "");
 217
 218 DocStr(wxStyledTextCtrl::StyleSetHotSpot,
 219 "Set a style to be a hotspot or not.", "");
 220
 221 DocStr(wxStyledTextCtrl::SetSelForeground,
 222 "Set the foreground colour of the selection and whether to use this setting.", "");
 223
 224 DocStr(wxStyledTextCtrl::SetSelBackground,
 225 "Set the background colour of the selection and whether to use this setting.", "");
 226
 227 DocStr(wxStyledTextCtrl::GetSelAlpha,
 228 "Get the alpha of the selection.", "");
 229
 230 DocStr(wxStyledTextCtrl::SetSelAlpha,
 231 "Set the alpha of the selection.", "");
 232
 233 DocStr(wxStyledTextCtrl::SetCaretForeground,
 234 "Set the foreground colour of the caret.", "");
 235
 236 DocStr(wxStyledTextCtrl::CmdKeyAssign,
 237 "When key+modifier combination km is pressed perform msg.", "");
 238
 239 DocStr(wxStyledTextCtrl::CmdKeyClear,
 240 "When key+modifier combination km is pressed do nothing.", "");
 241
 242 DocStr(wxStyledTextCtrl::CmdKeyClearAll,
 243 "Drop all key mappings.", "");
 244
 245 DocStr(wxStyledTextCtrl::SetStyleBytes,
 246 "Set the styles for a segment of the document.", "");
 247
 248 DocStr(wxStyledTextCtrl::StyleSetVisible,
 249 "Set a style to be visible or not.", "");
 250
 251 DocStr(wxStyledTextCtrl::GetCaretPeriod,
 252 "Get the time in milliseconds that the caret is on and off.", "");
 253
 254 DocStr(wxStyledTextCtrl::SetCaretPeriod,
 255 "Get the time in milliseconds that the caret is on and off. 0 = steady on.", "");
 256
 257 DocStr(wxStyledTextCtrl::SetWordChars,
 258 "Set the set of characters making up words for when moving or selecting by word.
 259 First sets deaults like SetCharsDefault.", "");
 260
 261 DocStr(wxStyledTextCtrl::BeginUndoAction,
 262 "Start a sequence of actions that is undone and redone as a unit.
 263 May be nested.", "");
 264
 265 DocStr(wxStyledTextCtrl::EndUndoAction,
 266 "End a sequence of actions that is undone and redone as a unit.", "");
 267
 268 DocStr(wxStyledTextCtrl::IndicatorSetStyle,
 269 "Set an indicator to plain, squiggle or TT.", "");
 270
 271 DocStr(wxStyledTextCtrl::IndicatorGetStyle,
 272 "Retrieve the style of an indicator.", "");
 273
 274 DocStr(wxStyledTextCtrl::IndicatorSetForeground,
 275 "Set the foreground colour of an indicator.", "");
 276
 277 DocStr(wxStyledTextCtrl::IndicatorGetForeground,
 278 "Retrieve the foreground colour of an indicator.", "");
 279
 280 DocStr(wxStyledTextCtrl::SetWhitespaceForeground,
 281 "Set the foreground colour of all whitespace and whether to use this setting.", "");
 282
 283 DocStr(wxStyledTextCtrl::SetWhitespaceBackground,
 284 "Set the background colour of all whitespace and whether to use this setting.", "");
 285
 286 DocStr(wxStyledTextCtrl::SetStyleBits,
 287 "Divide each styling byte into lexical class bits (default: 5) and indicator
 288 bits (default: 3). If a lexer requires more than 32 lexical states, then this
 289 is used to expand the possible states.", "");
 290
 291 DocStr(wxStyledTextCtrl::GetStyleBits,
 292 "Retrieve number of bits in style bytes used to hold the lexical state.", "");
 293
 294 DocStr(wxStyledTextCtrl::SetLineState,
 295 "Used to hold extra styling information for each line.", "");
 296
 297 DocStr(wxStyledTextCtrl::GetLineState,
 298 "Retrieve the extra styling information for a line.", "");
 299
 300 DocStr(wxStyledTextCtrl::GetMaxLineState,
 301 "Retrieve the last line number that has line state.", "");
 302
 303 DocStr(wxStyledTextCtrl::GetCaretLineVisible,
 304 "Is the background of the line containing the caret in a different colour?", "");
 305
 306 DocStr(wxStyledTextCtrl::SetCaretLineVisible,
 307 "Display the background of the line containing the caret in a different colour.", "");
 308
 309 DocStr(wxStyledTextCtrl::GetCaretLineBackground,
 310 "Get the colour of the background of the line containing the caret.", "");
 311
 312 DocStr(wxStyledTextCtrl::SetCaretLineBackground,
 313 "Set the colour of the background of the line containing the caret.", "");
 314
 315 DocStr(wxStyledTextCtrl::StyleSetChangeable,
 316 "Set a style to be changeable or not (read only).
 317 Experimental feature, currently buggy.", "");
 318
 319 DocStr(wxStyledTextCtrl::AutoCompShow,
 320 "Display a auto-completion list.
 321 The lenEntered parameter indicates how many characters before
 322 the caret should be used to provide context.", "");
 323
 324 DocStr(wxStyledTextCtrl::AutoCompCancel,
 325 "Remove the auto-completion list from the screen.", "");
 326
 327 DocStr(wxStyledTextCtrl::AutoCompActive,
 328 "Is there an auto-completion list visible?", "");
 329
 330 DocStr(wxStyledTextCtrl::AutoCompPosStart,
 331 "Retrieve the position of the caret when the auto-completion list was displayed.", "");
 332
 333 DocStr(wxStyledTextCtrl::AutoCompComplete,
 334 "User has selected an item so remove the list and insert the selection.", "");
 335
 336 DocStr(wxStyledTextCtrl::AutoCompStops,
 337 "Define a set of character that when typed cancel the auto-completion list.", "");
 338
 339 DocStr(wxStyledTextCtrl::AutoCompSetSeparator,
 340 "Change the separator character in the string setting up an auto-completion list.
 341 Default is space but can be changed if items contain space.", "");
 342
 343 DocStr(wxStyledTextCtrl::AutoCompGetSeparator,
 344 "Retrieve the auto-completion list separator character.", "");
 345
 346 DocStr(wxStyledTextCtrl::AutoCompSelect,
 347 "Select the item in the auto-completion list that starts with a string.", "");
 348
 349 DocStr(wxStyledTextCtrl::AutoCompSetCancelAtStart,
 350 "Should the auto-completion list be cancelled if the user backspaces to a
 351 position before where the box was created.", "");
 352
 353 DocStr(wxStyledTextCtrl::AutoCompGetCancelAtStart,
 354 "Retrieve whether auto-completion cancelled by backspacing before start.", "");
 355
 356 DocStr(wxStyledTextCtrl::AutoCompSetFillUps,
 357 "Define a set of characters that when typed will cause the autocompletion to
 358 choose the selected item.", "");
 359
 360 DocStr(wxStyledTextCtrl::AutoCompSetChooseSingle,
 361 "Should a single item auto-completion list automatically choose the item.", "");
 362
 363 DocStr(wxStyledTextCtrl::AutoCompGetChooseSingle,
 364 "Retrieve whether a single item auto-completion list automatically choose the item.", "");
 365
 366 DocStr(wxStyledTextCtrl::AutoCompSetIgnoreCase,
 367 "Set whether case is significant when performing auto-completion searches.", "");
 368
 369 DocStr(wxStyledTextCtrl::AutoCompGetIgnoreCase,
 370 "Retrieve state of ignore case flag.", "");
 371
 372 DocStr(wxStyledTextCtrl::UserListShow,
 373 "Display a list of strings and send notification when user chooses one.", "");
 374
 375 DocStr(wxStyledTextCtrl::AutoCompSetAutoHide,
 376 "Set whether or not autocompletion is hidden automatically when nothing matches.", "");
 377
 378 DocStr(wxStyledTextCtrl::AutoCompGetAutoHide,
 379 "Retrieve whether or not autocompletion is hidden automatically when nothing matches.", "");
 380
 381 DocStr(wxStyledTextCtrl::AutoCompSetDropRestOfWord,
 382 "Set whether or not autocompletion deletes any word characters
 383 after the inserted text upon completion.", "");
 384
 385 DocStr(wxStyledTextCtrl::AutoCompGetDropRestOfWord,
 386 "Retrieve whether or not autocompletion deletes any word characters
 387 after the inserted text upon completion.", "");
 388
 389 DocStr(wxStyledTextCtrl::RegisterImage,
 390 "Register an image for use in autocompletion lists.", "");
 391
 392 DocStr(wxStyledTextCtrl::ClearRegisteredImages,
 393 "Clear all the registered images.", "");
 394
 395 DocStr(wxStyledTextCtrl::AutoCompGetTypeSeparator,
 396 "Retrieve the auto-completion list type-separator character.", "");
 397
 398 DocStr(wxStyledTextCtrl::AutoCompSetTypeSeparator,
 399 "Change the type-separator character in the string setting up an auto-completion list.
 400 Default is '?' but can be changed if items contain '?'.", "");
 401
 402 DocStr(wxStyledTextCtrl::AutoCompSetMaxWidth,
 403 "Set the maximum width, in characters, of auto-completion and user lists.
 404 Set to 0 to autosize to fit longest item, which is the default.", "");
 405
 406 DocStr(wxStyledTextCtrl::AutoCompGetMaxWidth,
 407 "Get the maximum width, in characters, of auto-completion and user lists.", "");
 408
 409 DocStr(wxStyledTextCtrl::AutoCompSetMaxHeight,
 410 "Set the maximum height, in rows, of auto-completion and user lists.
 411 The default is 5 rows.", "");
 412
 413 DocStr(wxStyledTextCtrl::AutoCompGetMaxHeight,
 414 "Set the maximum height, in rows, of auto-completion and user lists.", "");
 415
 416 DocStr(wxStyledTextCtrl::SetIndent,
 417 "Set the number of spaces used for one level of indentation.", "");
 418
 419 DocStr(wxStyledTextCtrl::GetIndent,
 420 "Retrieve indentation size.", "");
 421
 422 DocStr(wxStyledTextCtrl::SetUseTabs,
 423 "Indentation will only use space characters if useTabs is false, otherwise
 424 it will use a combination of tabs and spaces.", "");
 425
 426 DocStr(wxStyledTextCtrl::GetUseTabs,
 427 "Retrieve whether tabs will be used in indentation.", "");
 428
 429 DocStr(wxStyledTextCtrl::SetLineIndentation,
 430 "Change the indentation of a line to a number of columns.", "");
 431
 432 DocStr(wxStyledTextCtrl::GetLineIndentation,
 433 "Retrieve the number of columns that a line is indented.", "");
 434
 435 DocStr(wxStyledTextCtrl::GetLineIndentPosition,
 436 "Retrieve the position before the first non indentation character on a line.", "");
 437
 438 DocStr(wxStyledTextCtrl::GetColumn,
 439 "Retrieve the column number of a position, taking tab width into account.", "");
 440
 441 DocStr(wxStyledTextCtrl::SetUseHorizontalScrollBar,
 442 "Show or hide the horizontal scroll bar.", "");
 443
 444 DocStr(wxStyledTextCtrl::GetUseHorizontalScrollBar,
 445 "Is the horizontal scroll bar visible?", "");
 446
 447 DocStr(wxStyledTextCtrl::SetIndentationGuides,
 448 "Show or hide indentation guides.", "");
 449
 450 DocStr(wxStyledTextCtrl::GetIndentationGuides,
 451 "Are the indentation guides visible?", "");
 452
 453 DocStr(wxStyledTextCtrl::SetHighlightGuide,
 454 "Set the highlighted indentation guide column.
 455 0 = no highlighted guide.", "");
 456
 457 DocStr(wxStyledTextCtrl::GetHighlightGuide,
 458 "Get the highlighted indentation guide column.", "");
 459
 460 DocStr(wxStyledTextCtrl::GetLineEndPosition,
 461 "Get the position after the last visible characters on a line.", "");
 462
 463 DocStr(wxStyledTextCtrl::GetCodePage,
 464 "Get the code page used to interpret the bytes of the document as characters.", "");
 465
 466 DocStr(wxStyledTextCtrl::GetCaretForeground,
 467 "Get the foreground colour of the caret.", "");
 468
 469 DocStr(wxStyledTextCtrl::GetReadOnly,
 470 "In read-only mode?", "");
 471
 472 DocStr(wxStyledTextCtrl::SetCurrentPos,
 473 "Sets the position of the caret.", "");
 474
 475 DocStr(wxStyledTextCtrl::SetSelectionStart,
 476 "Sets the position that starts the selection - this becomes the anchor.", "");
 477
 478 DocStr(wxStyledTextCtrl::GetSelectionStart,
 479 "Returns the position at the start of the selection.", "");
 480
 481 DocStr(wxStyledTextCtrl::SetSelectionEnd,
 482 "Sets the position that ends the selection - this becomes the currentPosition.", "");
 483
 484 DocStr(wxStyledTextCtrl::GetSelectionEnd,
 485 "Returns the position at the end of the selection.", "");
 486
 487 DocStr(wxStyledTextCtrl::SetPrintMagnification,
 488 "Sets the print magnification added to the point size of each style for printing.", "");
 489
 490 DocStr(wxStyledTextCtrl::GetPrintMagnification,
 491 "Returns the print magnification.", "");
 492
 493 DocStr(wxStyledTextCtrl::SetPrintColourMode,
 494 "Modify colours when printing for clearer printed text.", "");
 495
 496 DocStr(wxStyledTextCtrl::GetPrintColourMode,
 497 "Returns the print colour mode.", "");
 498
 499 DocStr(wxStyledTextCtrl::FindText,
 500 "Find some text in the document.", "");
 501
 502 DocStr(wxStyledTextCtrl::FormatRange,
 503 "On Windows, will draw the document into a display context such as a printer.", "");
 504
 505 DocStr(wxStyledTextCtrl::GetFirstVisibleLine,
 506 "Retrieve the display line at the top of the display.", "");
 507
 508 DocStr(wxStyledTextCtrl::GetLine,
 509 "Retrieve the contents of a line.", "");
 510
 511 DocStr(wxStyledTextCtrl::GetLineCount,
 512 "Returns the number of lines in the document. There is always at least one.", "");
 513
 514 DocStr(wxStyledTextCtrl::SetMarginLeft,
 515 "Sets the size in pixels of the left margin.", "");
 516
 517 DocStr(wxStyledTextCtrl::GetMarginLeft,
 518 "Returns the size in pixels of the left margin.", "");
 519
 520 DocStr(wxStyledTextCtrl::SetMarginRight,
 521 "Sets the size in pixels of the right margin.", "");
 522
 523 DocStr(wxStyledTextCtrl::GetMarginRight,
 524 "Returns the size in pixels of the right margin.", "");
 525
 526 DocStr(wxStyledTextCtrl::GetModify,
 527 "Is the document different from when it was last saved?", "");
 528
 529 DocStr(wxStyledTextCtrl::SetSelection,
 530 "Select a range of text.", "");
 531
 532 DocStr(wxStyledTextCtrl::GetSelectedText,
 533 "Retrieve the selected text.", "");
 534
 535 DocStr(wxStyledTextCtrl::GetTextRange,
 536 "Retrieve a range of text.", "");
 537
 538 DocStr(wxStyledTextCtrl::HideSelection,
 539 "Draw the selection in normal style or with selection highlighted.", "");
 540
 541 DocStr(wxStyledTextCtrl::LineFromPosition,
 542 "Retrieve the line containing a position.", "");
 543
 544 DocStr(wxStyledTextCtrl::PositionFromLine,
 545 "Retrieve the position at the start of a line.", "");
 546
 547 DocStr(wxStyledTextCtrl::LineScroll,
 548 "Scroll horizontally and vertically.", "");
 549
 550 DocStr(wxStyledTextCtrl::EnsureCaretVisible,
 551 "Ensure the caret is visible.", "");
 552
 553 DocStr(wxStyledTextCtrl::ReplaceSelection,
 554 "Replace the selected text with the argument text.", "");
 555
 556 DocStr(wxStyledTextCtrl::SetReadOnly,
 557 "Set to read only or read write.", "");
 558
 559 DocStr(wxStyledTextCtrl::CanPaste,
 560 "Will a paste succeed?", "");
 561
 562 DocStr(wxStyledTextCtrl::CanUndo,
 563 "Are there any undoable actions in the undo history?", "");
 564
 565 DocStr(wxStyledTextCtrl::EmptyUndoBuffer,
 566 "Delete the undo history.", "");
 567
 568 DocStr(wxStyledTextCtrl::Undo,
 569 "Undo one action in the undo history.", "");
 570
 571 DocStr(wxStyledTextCtrl::Cut,
 572 "Cut the selection to the clipboard.", "");
 573
 574 DocStr(wxStyledTextCtrl::Copy,
 575 "Copy the selection to the clipboard.", "");
 576
 577 DocStr(wxStyledTextCtrl::Paste,
 578 "Paste the contents of the clipboard into the document replacing the selection.", "");
 579
 580 DocStr(wxStyledTextCtrl::Clear,
 581 "Clear the selection.", "");
 582
 583 DocStr(wxStyledTextCtrl::SetText,
 584 "Replace the contents of the document with the argument text.", "");
 585
 586 DocStr(wxStyledTextCtrl::GetText,
 587 "Retrieve all the text in the document.", "");
 588
 589 DocStr(wxStyledTextCtrl::GetTextLength,
 590 "Retrieve the number of characters in the document.", "");
 591
 592 DocStr(wxStyledTextCtrl::SetOvertype,
 593 "Set to overtype (true) or insert mode.", "");
 594
 595 DocStr(wxStyledTextCtrl::GetOvertype,
 596 "Returns true if overtype mode is active otherwise false is returned.", "");
 597
 598 DocStr(wxStyledTextCtrl::SetCaretWidth,
 599 "Set the width of the insert mode caret.", "");
 600
 601 DocStr(wxStyledTextCtrl::GetCaretWidth,
 602 "Returns the width of the insert mode caret.", "");
 603
 604 DocStr(wxStyledTextCtrl::SetTargetStart,
 605 "Sets the position that starts the target which is used for updating the
 606 document without affecting the scroll position.", "");
 607
 608 DocStr(wxStyledTextCtrl::GetTargetStart,
 609 "Get the position that starts the target.", "");
 610
 611 DocStr(wxStyledTextCtrl::SetTargetEnd,
 612 "Sets the position that ends the target which is used for updating the
 613 document without affecting the scroll position.", "");
 614
 615 DocStr(wxStyledTextCtrl::GetTargetEnd,
 616 "Get the position that ends the target.", "");
 617
 618 DocStr(wxStyledTextCtrl::ReplaceTarget,
 619 "Replace the target text with the argument text.
 620 Text is counted so it can contain NULs.
 621 Returns the length of the replacement text.", "");
 622
 623 DocStr(wxStyledTextCtrl::ReplaceTargetRE,
 624 "Replace the target text with the argument text after \d processing.
 625 Text is counted so it can contain NULs.
 626 Looks for \d where d is between 1 and 9 and replaces these with the strings
 627 matched in the last search operation which were surrounded by \( and \).
 628 Returns the length of the replacement text including any change
 629 caused by processing the \d patterns.", "");
 630
 631 DocStr(wxStyledTextCtrl::SearchInTarget,
 632 "Search for a counted string in the target and set the target to the found
 633 range. Text is counted so it can contain NULs.
 634 Returns length of range or -1 for failure in which case target is not moved.", "");
 635
 636 DocStr(wxStyledTextCtrl::SetSearchFlags,
 637 "Set the search flags used by SearchInTarget.", "");
 638
 639 DocStr(wxStyledTextCtrl::GetSearchFlags,
 640 "Get the search flags used by SearchInTarget.", "");
 641
 642 DocStr(wxStyledTextCtrl::CallTipShow,
 643 "Show a call tip containing a definition near position pos.", "");
 644
 645 DocStr(wxStyledTextCtrl::CallTipCancel,
 646 "Remove the call tip from the screen.", "");
 647
 648 DocStr(wxStyledTextCtrl::CallTipActive,
 649 "Is there an active call tip?", "");
 650
 651 DocStr(wxStyledTextCtrl::CallTipPosAtStart,
 652 "Retrieve the position where the caret was before displaying the call tip.", "");
 653
 654 DocStr(wxStyledTextCtrl::CallTipSetHighlight,
 655 "Highlight a segment of the definition.", "");
 656
 657 DocStr(wxStyledTextCtrl::CallTipSetBackground,
 658 "Set the background colour for the call tip.", "");
 659
 660 DocStr(wxStyledTextCtrl::CallTipSetForeground,
 661 "Set the foreground colour for the call tip.", "");
 662
 663 DocStr(wxStyledTextCtrl::CallTipSetForegroundHighlight,
 664 "Set the foreground colour for the highlighted part of the call tip.", "");
 665
 666 DocStr(wxStyledTextCtrl::CallTipUseStyle,
 667 "Enable use of STYLE_CALLTIP and set call tip tab size in pixels.", "");
 668
 669 DocStr(wxStyledTextCtrl::VisibleFromDocLine,
 670 "Find the display line of a document line taking hidden lines into account.", "");
 671
 672 DocStr(wxStyledTextCtrl::DocLineFromVisible,
 673 "Find the document line of a display line taking hidden lines into account.", "");
 674
 675 DocStr(wxStyledTextCtrl::WrapCount,
 676 "The number of display lines needed to wrap a document line", "");
 677
 678 DocStr(wxStyledTextCtrl::SetFoldLevel,
 679 "Set the fold level of a line.
 680 This encodes an integer level along with flags indicating whether the
 681 line is a header and whether it is effectively white space.", "");
 682
 683 DocStr(wxStyledTextCtrl::GetFoldLevel,
 684 "Retrieve the fold level of a line.", "");
 685
 686 DocStr(wxStyledTextCtrl::GetLastChild,
 687 "Find the last child line of a header line.", "");
 688
 689 DocStr(wxStyledTextCtrl::GetFoldParent,
 690 "Find the parent line of a child line.", "");
 691
 692 DocStr(wxStyledTextCtrl::ShowLines,
 693 "Make a range of lines visible.", "");
 694
 695 DocStr(wxStyledTextCtrl::HideLines,
 696 "Make a range of lines invisible.", "");
 697
 698 DocStr(wxStyledTextCtrl::GetLineVisible,
 699 "Is a line visible?", "");
 700
 701 DocStr(wxStyledTextCtrl::SetFoldExpanded,
 702 "Show the children of a header line.", "");
 703
 704 DocStr(wxStyledTextCtrl::GetFoldExpanded,
 705 "Is a header line expanded?", "");
 706
 707 DocStr(wxStyledTextCtrl::ToggleFold,
 708 "Switch a header line between expanded and contracted.", "");
 709
 710 DocStr(wxStyledTextCtrl::EnsureVisible,
 711 "Ensure a particular line is visible by expanding any header line hiding it.", "");
 712
 713 DocStr(wxStyledTextCtrl::SetFoldFlags,
 714 "Set some style options for folding.", "");
 715
 716 DocStr(wxStyledTextCtrl::EnsureVisibleEnforcePolicy,
 717 "Ensure a particular line is visible by expanding any header line hiding it.
 718 Use the currently set visibility policy to determine which range to display.", "");
 719
 720 DocStr(wxStyledTextCtrl::SetTabIndents,
 721 "Sets whether a tab pressed when caret is within indentation indents.", "");
 722
 723 DocStr(wxStyledTextCtrl::GetTabIndents,
 724 "Does a tab pressed when caret is within indentation indent?", "");
 725
 726 DocStr(wxStyledTextCtrl::SetBackSpaceUnIndents,
 727 "Sets whether a backspace pressed when caret is within indentation unindents.", "");
 728
 729 DocStr(wxStyledTextCtrl::GetBackSpaceUnIndents,
 730 "Does a backspace pressed when caret is within indentation unindent?", "");
 731
 732 DocStr(wxStyledTextCtrl::SetMouseDwellTime,
 733 "Sets the time the mouse must sit still to generate a mouse dwell event.", "");
 734
 735 DocStr(wxStyledTextCtrl::GetMouseDwellTime,
 736 "Retrieve the time the mouse must sit still to generate a mouse dwell event.", "");
 737
 738 DocStr(wxStyledTextCtrl::WordStartPosition,
 739 "Get position of start of word.", "");
 740
 741 DocStr(wxStyledTextCtrl::WordEndPosition,
 742 "Get position of end of word.", "");
 743
 744 DocStr(wxStyledTextCtrl::SetWrapMode,
 745 "Sets whether text is word wrapped.", "");
 746
 747 DocStr(wxStyledTextCtrl::GetWrapMode,
 748 "Retrieve whether text is word wrapped.", "");
 749
 750 DocStr(wxStyledTextCtrl::SetWrapVisualFlags,
 751 "Set the display mode of visual flags for wrapped lines.", "");
 752
 753 DocStr(wxStyledTextCtrl::GetWrapVisualFlags,
 754 "Retrive the display mode of visual flags for wrapped lines.", "");
 755
 756 DocStr(wxStyledTextCtrl::SetWrapVisualFlagsLocation,
 757 "Set the location of visual flags for wrapped lines.", "");
 758
 759 DocStr(wxStyledTextCtrl::GetWrapVisualFlagsLocation,
 760 "Retrive the location of visual flags for wrapped lines.", "");
 761
 762 DocStr(wxStyledTextCtrl::SetWrapStartIndent,
 763 "Set the start indent for wrapped lines.", "");
 764
 765 DocStr(wxStyledTextCtrl::GetWrapStartIndent,
 766 "Retrive the start indent for wrapped lines.", "");
 767
 768 DocStr(wxStyledTextCtrl::SetLayoutCache,
 769 "Sets the degree of caching of layout information.", "");
 770
 771 DocStr(wxStyledTextCtrl::GetLayoutCache,
 772 "Retrieve the degree of caching of layout information.", "");
 773
 774 DocStr(wxStyledTextCtrl::SetScrollWidth,
 775 "Sets the document width assumed for scrolling.", "");
 776
 777 DocStr(wxStyledTextCtrl::GetScrollWidth,
 778 "Retrieve the document width assumed for scrolling.", "");
 779
 780 DocStr(wxStyledTextCtrl::TextWidth,
 781 "Measure the pixel width of some text in a particular style.
 782 NUL terminated text argument.
 783 Does not handle tab or control characters.", "");
 784
 785 DocStr(wxStyledTextCtrl::SetEndAtLastLine,
 786 "Sets the scroll range so that maximum scroll position has
 787 the last line at the bottom of the view (default).
 788 Setting this to false allows scrolling one page below the last line.", "");
 789
 790 DocStr(wxStyledTextCtrl::GetEndAtLastLine,
 791 "Retrieve whether the maximum scroll position has the last
 792 line at the bottom of the view.", "");
 793
 794 DocStr(wxStyledTextCtrl::TextHeight,
 795 "Retrieve the height of a particular line of text in pixels.", "");
 796
 797 DocStr(wxStyledTextCtrl::SetUseVerticalScrollBar,
 798 "Show or hide the vertical scroll bar.", "");
 799
 800 DocStr(wxStyledTextCtrl::GetUseVerticalScrollBar,
 801 "Is the vertical scroll bar visible?", "");
 802
 803 DocStr(wxStyledTextCtrl::AppendText,
 804 "Append a string to the end of the document without changing the selection.", "");
 805
 806 DocStr(wxStyledTextCtrl::GetTwoPhaseDraw,
 807 "Is drawing done in two phases with backgrounds drawn before foregrounds?", "");
 808
 809 DocStr(wxStyledTextCtrl::SetTwoPhaseDraw,
 810 "In twoPhaseDraw mode, drawing is performed in two phases, first the background
 811 and then the foreground. This avoids chopping off characters that overlap the next run.", "");
 812
 813 DocStr(wxStyledTextCtrl::TargetFromSelection,
 814 "Make the target range start and end be the same as the selection range start and end.", "");
 815
 816 DocStr(wxStyledTextCtrl::LinesJoin,
 817 "Join the lines in the target.", "");
 818
 819 DocStr(wxStyledTextCtrl::LinesSplit,
 820 "Split the lines in the target into lines that are less wide than pixelWidth
 821 where possible.", "");
 822
 823 DocStr(wxStyledTextCtrl::SetFoldMarginColour,
 824 "Set the colours used as a chequerboard pattern in the fold margin", "");
 825
 826 DocStr(wxStyledTextCtrl::SetFoldMarginHiColour,
 827 "", "");
 828
 829 DocStr(wxStyledTextCtrl::LineDown,
 830 "Move caret down one line.", "");
 831
 832 DocStr(wxStyledTextCtrl::LineDownExtend,
 833 "Move caret down one line extending selection to new caret position.", "");
 834
 835 DocStr(wxStyledTextCtrl::LineUp,
 836 "Move caret up one line.", "");
 837
 838 DocStr(wxStyledTextCtrl::LineUpExtend,
 839 "Move caret up one line extending selection to new caret position.", "");
 840
 841 DocStr(wxStyledTextCtrl::CharLeft,
 842 "Move caret left one character.", "");
 843
 844 DocStr(wxStyledTextCtrl::CharLeftExtend,
 845 "Move caret left one character extending selection to new caret position.", "");
 846
 847 DocStr(wxStyledTextCtrl::CharRight,
 848 "Move caret right one character.", "");
 849
 850 DocStr(wxStyledTextCtrl::CharRightExtend,
 851 "Move caret right one character extending selection to new caret position.", "");
 852
 853 DocStr(wxStyledTextCtrl::WordLeft,
 854 "Move caret left one word.", "");
 855
 856 DocStr(wxStyledTextCtrl::WordLeftExtend,
 857 "Move caret left one word extending selection to new caret position.", "");
 858
 859 DocStr(wxStyledTextCtrl::WordRight,
 860 "Move caret right one word.", "");
 861
 862 DocStr(wxStyledTextCtrl::WordRightExtend,
 863 "Move caret right one word extending selection to new caret position.", "");
 864
 865 DocStr(wxStyledTextCtrl::Home,
 866 "Move caret to first position on line.", "");
 867
 868 DocStr(wxStyledTextCtrl::HomeExtend,
 869 "Move caret to first position on line extending selection to new caret position.", "");
 870
 871 DocStr(wxStyledTextCtrl::LineEnd,
 872 "Move caret to last position on line.", "");
 873
 874 DocStr(wxStyledTextCtrl::LineEndExtend,
 875 "Move caret to last position on line extending selection to new caret position.", "");
 876
 877 DocStr(wxStyledTextCtrl::DocumentStart,
 878 "Move caret to first position in document.", "");
 879
 880 DocStr(wxStyledTextCtrl::DocumentStartExtend,
 881 "Move caret to first position in document extending selection to new caret position.", "");
 882
 883 DocStr(wxStyledTextCtrl::DocumentEnd,
 884 "Move caret to last position in document.", "");
 885
 886 DocStr(wxStyledTextCtrl::DocumentEndExtend,
 887 "Move caret to last position in document extending selection to new caret position.", "");
 888
 889 DocStr(wxStyledTextCtrl::PageUp,
 890 "Move caret one page up.", "");
 891
 892 DocStr(wxStyledTextCtrl::PageUpExtend,
 893 "Move caret one page up extending selection to new caret position.", "");
 894
 895 DocStr(wxStyledTextCtrl::PageDown,
 896 "Move caret one page down.", "");
 897
 898 DocStr(wxStyledTextCtrl::PageDownExtend,
 899 "Move caret one page down extending selection to new caret position.", "");
 900
 901 DocStr(wxStyledTextCtrl::EditToggleOvertype,
 902 "Switch from insert to overtype mode or the reverse.", "");
 903
 904 DocStr(wxStyledTextCtrl::Cancel,
 905 "Cancel any modes such as call tip or auto-completion list display.", "");
 906
 907 DocStr(wxStyledTextCtrl::DeleteBack,
 908 "Delete the selection or if no selection, the character before the caret.", "");
 909
 910 DocStr(wxStyledTextCtrl::Tab,
 911 "If selection is empty or all on one line replace the selection with a tab character.
 912 If more than one line selected, indent the lines.", "");
 913
 914 DocStr(wxStyledTextCtrl::BackTab,
 915 "Dedent the selected lines.", "");
 916
 917 DocStr(wxStyledTextCtrl::NewLine,
 918 "Insert a new line, may use a CRLF, CR or LF depending on EOL mode.", "");
 919
 920 DocStr(wxStyledTextCtrl::FormFeed,
 921 "Insert a Form Feed character.", "");
 922
 923 DocStr(wxStyledTextCtrl::VCHome,
 924 "Move caret to before first visible character on line.
 925 If already there move to first character on line.", "");
 926
 927 DocStr(wxStyledTextCtrl::VCHomeExtend,
 928 "Like VCHome but extending selection to new caret position.", "");
 929
 930 DocStr(wxStyledTextCtrl::ZoomIn,
 931 "Magnify the displayed text by increasing the sizes by 1 point.", "");
 932
 933 DocStr(wxStyledTextCtrl::ZoomOut,
 934 "Make the displayed text smaller by decreasing the sizes by 1 point.", "");
 935
 936 DocStr(wxStyledTextCtrl::DelWordLeft,
 937 "Delete the word to the left of the caret.", "");
 938
 939 DocStr(wxStyledTextCtrl::DelWordRight,
 940 "Delete the word to the right of the caret.", "");
 941
 942 DocStr(wxStyledTextCtrl::LineCut,
 943 "Cut the line containing the caret.", "");
 944
 945 DocStr(wxStyledTextCtrl::LineDelete,
 946 "Delete the line containing the caret.", "");
 947
 948 DocStr(wxStyledTextCtrl::LineTranspose,
 949 "Switch the current line with the previous.", "");
 950
 951 DocStr(wxStyledTextCtrl::LineDuplicate,
 952 "Duplicate the current line.", "");
 953
 954 DocStr(wxStyledTextCtrl::LowerCase,
 955 "Transform the selection to lower case.", "");
 956
 957 DocStr(wxStyledTextCtrl::UpperCase,
 958 "Transform the selection to upper case.", "");
 959
 960 DocStr(wxStyledTextCtrl::LineScrollDown,
 961 "Scroll the document down, keeping the caret visible.", "");
 962
 963 DocStr(wxStyledTextCtrl::LineScrollUp,
 964 "Scroll the document up, keeping the caret visible.", "");
 965
 966 DocStr(wxStyledTextCtrl::DeleteBackNotLine,
 967 "Delete the selection or if no selection, the character before the caret.
 968 Will not delete the character before at the start of a line.", "");
 969
 970 DocStr(wxStyledTextCtrl::HomeDisplay,
 971 "Move caret to first position on display line.", "");
 972
 973 DocStr(wxStyledTextCtrl::HomeDisplayExtend,
 974 "Move caret to first position on display line extending selection to
 975 new caret position.", "");
 976
 977 DocStr(wxStyledTextCtrl::LineEndDisplay,
 978 "Move caret to last position on display line.", "");
 979
 980 DocStr(wxStyledTextCtrl::LineEndDisplayExtend,
 981 "Move caret to last position on display line extending selection to new
 982 caret position.", "");
 983
 984 DocStr(wxStyledTextCtrl::HomeWrap,
 985 "These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)?
 986 except they behave differently when word-wrap is enabled:
 987 They go first to the start / end of the display line, like (Home|LineEnd)Display
 988 The difference is that, the cursor is already at the point, it goes on to the start
 989 or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.", "");
 990
 991 DocStr(wxStyledTextCtrl::HomeWrapExtend,
 992 "", "");
 993
 994 DocStr(wxStyledTextCtrl::LineEndWrap,
 995 "", "");
 996
 997 DocStr(wxStyledTextCtrl::LineEndWrapExtend,
 998 "", "");
 999
1000 DocStr(wxStyledTextCtrl::VCHomeWrap,
1001 "", "");
1002
1003 DocStr(wxStyledTextCtrl::VCHomeWrapExtend,
1004 "", "");
1005
1006 DocStr(wxStyledTextCtrl::LineCopy,
1007 "Copy the line containing the caret.", "");
1008
1009 DocStr(wxStyledTextCtrl::MoveCaretInsideView,
1010 "Move the caret inside current view if it's not there already.", "");
1011
1012 DocStr(wxStyledTextCtrl::LineLength,
1013 "How many characters are on a line, not including end of line characters?", "");
1014
1015 DocStr(wxStyledTextCtrl::BraceHighlight,
1016 "Highlight the characters at two positions.", "");
1017
1018 DocStr(wxStyledTextCtrl::BraceBadLight,
1019 "Highlight the character at a position indicating there is no matching brace.", "");
1020
1021 DocStr(wxStyledTextCtrl::BraceMatch,
1022 "Find the position of a matching brace or INVALID_POSITION if no match.", "");
1023
1024 DocStr(wxStyledTextCtrl::GetViewEOL,
1025 "Are the end of line characters visible?", "");
1026
1027 DocStr(wxStyledTextCtrl::SetViewEOL,
1028 "Make the end of line characters visible or invisible.", "");
1029
1030 DocStr(wxStyledTextCtrl::GetDocPointer,
1031 "Retrieve a pointer to the document object.", "");
1032
1033 DocStr(wxStyledTextCtrl::SetDocPointer,
1034 "Change the document object used.", "");
1035
1036 DocStr(wxStyledTextCtrl::SetModEventMask,
1037 "Set which document modification events are sent to the container.", "");
1038
1039 DocStr(wxStyledTextCtrl::GetEdgeColumn,
1040 "Retrieve the column number which text should be kept within.", "");
1041
1042 DocStr(wxStyledTextCtrl::SetEdgeColumn,
1043 "Set the column number of the edge.
1044 If text goes past the edge then it is highlighted.", "");
1045
1046 DocStr(wxStyledTextCtrl::GetEdgeMode,
1047 "Retrieve the edge highlight mode.", "");
1048
1049 DocStr(wxStyledTextCtrl::SetEdgeMode,
1050 "The edge may be displayed by a line (EDGE_LINE) or by highlighting text that
1051 goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).", "");
1052
1053 DocStr(wxStyledTextCtrl::GetEdgeColour,
1054 "Retrieve the colour used in edge indication.", "");
1055
1056 DocStr(wxStyledTextCtrl::SetEdgeColour,
1057 "Change the colour used in edge indication.", "");
1058
1059 DocStr(wxStyledTextCtrl::SearchAnchor,
1060 "Sets the current caret position to be the search anchor.", "");
1061
1062 DocStr(wxStyledTextCtrl::SearchNext,
1063 "Find some text starting at the search anchor.
1064 Does not ensure the selection is visible.", "");
1065
1066 DocStr(wxStyledTextCtrl::SearchPrev,
1067 "Find some text starting at the search anchor and moving backwards.
1068 Does not ensure the selection is visible.", "");
1069
1070 DocStr(wxStyledTextCtrl::LinesOnScreen,
1071 "Retrieves the number of lines completely visible.", "");
1072
1073 DocStr(wxStyledTextCtrl::UsePopUp,
1074 "Set whether a pop up menu is displayed automatically when the user presses
1075 the wrong mouse button.", "");
1076
1077 DocStr(wxStyledTextCtrl::SelectionIsRectangle,
1078 "Is the selection rectangular? The alternative is the more common stream selection.", "");
1079
1080 DocStr(wxStyledTextCtrl::SetZoom,
1081 "Set the zoom level. This number of points is added to the size of all fonts.
1082 It may be positive to magnify or negative to reduce.", "");
1083
1084 DocStr(wxStyledTextCtrl::GetZoom,
1085 "Retrieve the zoom level.", "");
1086
1087 DocStr(wxStyledTextCtrl::CreateDocument,
1088 "Create a new document object.
1089 Starts with reference count of 1 and not selected into editor.", "");
1090
1091 DocStr(wxStyledTextCtrl::AddRefDocument,
1092 "Extend life of document.", "");
1093
1094 DocStr(wxStyledTextCtrl::ReleaseDocument,
1095 "Release a reference to the document, deleting document if it fades to black.", "");
1096
1097 DocStr(wxStyledTextCtrl::GetModEventMask,
1098 "Get which document modification events are sent to the container.", "");
1099
1100 DocStr(wxStyledTextCtrl::SetSTCFocus,
1101 "Change internal focus flag.", "");
1102
1103 DocStr(wxStyledTextCtrl::GetSTCFocus,
1104 "Get internal focus flag.", "");
1105
1106 DocStr(wxStyledTextCtrl::SetStatus,
1107 "Change error status - 0 = OK.", "");
1108
1109 DocStr(wxStyledTextCtrl::GetStatus,
1110 "Get error status.", "");
1111
1112 DocStr(wxStyledTextCtrl::SetMouseDownCaptures,
1113 "Set whether the mouse is captured when its button is pressed.", "");
1114
1115 DocStr(wxStyledTextCtrl::GetMouseDownCaptures,
1116 "Get whether mouse gets captured.", "");
1117
1118 DocStr(wxStyledTextCtrl::SetSTCCursor,
1119 "Sets the cursor to one of the SC_CURSOR* values.", "");
1120
1121 DocStr(wxStyledTextCtrl::GetSTCCursor,
1122 "Get cursor type.", "");
1123
1124 DocStr(wxStyledTextCtrl::SetControlCharSymbol,
1125 "Change the way control characters are displayed:
1126 If symbol is < 32, keep the drawn way, else, use the given character.", "");
1127
1128 DocStr(wxStyledTextCtrl::GetControlCharSymbol,
1129 "Get the way control characters are displayed.", "");
1130
1131 DocStr(wxStyledTextCtrl::WordPartLeft,
1132 "Move to the previous change in capitalisation.", "");
1133
1134 DocStr(wxStyledTextCtrl::WordPartLeftExtend,
1135 "Move to the previous change in capitalisation extending selection
1136 to new caret position.", "");
1137
1138 DocStr(wxStyledTextCtrl::WordPartRight,
1139 "Move to the change next in capitalisation.", "");
1140
1141 DocStr(wxStyledTextCtrl::WordPartRightExtend,
1142 "Move to the next change in capitalisation extending selection
1143 to new caret position.", "");
1144
1145 DocStr(wxStyledTextCtrl::SetVisiblePolicy,
1146 "Set the way the display area is determined when a particular line
1147 is to be moved to by Find, FindNext, GotoLine, etc.", "");
1148
1149 DocStr(wxStyledTextCtrl::DelLineLeft,
1150 "Delete back from the current position to the start of the line.", "");
1151
1152 DocStr(wxStyledTextCtrl::DelLineRight,
1153 "Delete forwards from the current position to the end of the line.", "");
1154
1155 DocStr(wxStyledTextCtrl::SetXOffset,
1156 "Get and Set the xOffset (ie, horizonal scroll position).", "");
1157
1158 DocStr(wxStyledTextCtrl::GetXOffset,
1159 "", "");
1160
1161 DocStr(wxStyledTextCtrl::ChooseCaretX,
1162 "Set the last x chosen value to be the caret x position.", "");
1163
1164 DocStr(wxStyledTextCtrl::SetXCaretPolicy,
1165 "Set the way the caret is kept visible when going sideway.
1166 The exclusion zone is given in pixels.", "");
1167
1168 DocStr(wxStyledTextCtrl::SetYCaretPolicy,
1169 "Set the way the line the caret is on is kept visible.
1170 The exclusion zone is given in lines.", "");
1171
1172 DocStr(wxStyledTextCtrl::SetPrintWrapMode,
1173 "Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).", "");
1174
1175 DocStr(wxStyledTextCtrl::GetPrintWrapMode,
1176 "Is printing line wrapped?", "");
1177
1178 DocStr(wxStyledTextCtrl::SetHotspotActiveForeground,
1179 "Set a fore colour for active hotspots.", "");
1180
1181 DocStr(wxStyledTextCtrl::SetHotspotActiveBackground,
1182 "Set a back colour for active hotspots.", "");
1183
1184 DocStr(wxStyledTextCtrl::SetHotspotActiveUnderline,
1185 "Enable / Disable underlining active hotspots.", "");
1186
1187 DocStr(wxStyledTextCtrl::SetHotspotSingleLine,
1188 "Limit hotspots to single line so hotspots on two lines don't merge.", "");
1189
1190 DocStr(wxStyledTextCtrl::ParaDown,
1191 "Move caret between paragraphs (delimited by empty lines).", "");
1192
1193 DocStr(wxStyledTextCtrl::ParaDownExtend,
1194 "", "");
1195
1196 DocStr(wxStyledTextCtrl::ParaUp,
1197 "", "");
1198
1199 DocStr(wxStyledTextCtrl::ParaUpExtend,
1200 "", "");
1201
1202 DocStr(wxStyledTextCtrl::PositionBefore,
1203 "Given a valid document position, return the previous position taking code
1204 page into account. Returns 0 if passed 0.", "");
1205
1206 DocStr(wxStyledTextCtrl::PositionAfter,
1207 "Given a valid document position, return the next position taking code
1208 page into account. Maximum value returned is the last position in the document.", "");
1209
1210 DocStr(wxStyledTextCtrl::CopyRange,
1211 "Copy a range of text to the clipboard. Positions are clipped into the document.", "");
1212
1213 DocStr(wxStyledTextCtrl::CopyText,
1214 "Copy argument text to the clipboard.", "");
1215
1216 DocStr(wxStyledTextCtrl::SetSelectionMode,
1217 "Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE) or
1218 by lines (SC_SEL_LINES).", "");
1219
1220 DocStr(wxStyledTextCtrl::GetSelectionMode,
1221 "Get the mode of the current selection.", "");
1222
1223 DocStr(wxStyledTextCtrl::GetLineSelStartPosition,
1224 "Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).", "");
1225
1226 DocStr(wxStyledTextCtrl::GetLineSelEndPosition,
1227 "Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).", "");
1228
1229 DocStr(wxStyledTextCtrl::LineDownRectExtend,
1230 "Move caret down one line, extending rectangular selection to new caret position.", "");
1231
1232 DocStr(wxStyledTextCtrl::LineUpRectExtend,
1233 "Move caret up one line, extending rectangular selection to new caret position.", "");
1234
1235 DocStr(wxStyledTextCtrl::CharLeftRectExtend,
1236 "Move caret left one character, extending rectangular selection to new caret position.", "");
1237
1238 DocStr(wxStyledTextCtrl::CharRightRectExtend,
1239 "Move caret right one character, extending rectangular selection to new caret position.", "");
1240
1241 DocStr(wxStyledTextCtrl::HomeRectExtend,
1242 "Move caret to first position on line, extending rectangular selection to new caret position.", "");
1243
1244 DocStr(wxStyledTextCtrl::VCHomeRectExtend,
1245 "Move caret to before first visible character on line.
1246 If already there move to first character on line.
1247 In either case, extend rectangular selection to new caret position.", "");
1248
1249 DocStr(wxStyledTextCtrl::LineEndRectExtend,
1250 "Move caret to last position on line, extending rectangular selection to new caret position.", "");
1251
1252 DocStr(wxStyledTextCtrl::PageUpRectExtend,
1253 "Move caret one page up, extending rectangular selection to new caret position.", "");
1254
1255 DocStr(wxStyledTextCtrl::PageDownRectExtend,
1256 "Move caret one page down, extending rectangular selection to new caret position.", "");
1257
1258 DocStr(wxStyledTextCtrl::StutteredPageUp,
1259 "Move caret to top of page, or one page up if already at top of page.", "");
1260
1261 DocStr(wxStyledTextCtrl::StutteredPageUpExtend,
1262 "Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.", "");
1263
1264 DocStr(wxStyledTextCtrl::StutteredPageDown,
1265 "Move caret to bottom of page, or one page down if already at bottom of page.", "");
1266
1267 DocStr(wxStyledTextCtrl::StutteredPageDownExtend,
1268 "Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.", "");
1269
1270 DocStr(wxStyledTextCtrl::WordLeftEnd,
1271 "Move caret left one word, position cursor at end of word.", "");
1272
1273 DocStr(wxStyledTextCtrl::WordLeftEndExtend,
1274 "Move caret left one word, position cursor at end of word, extending selection to new caret position.", "");
1275
1276 DocStr(wxStyledTextCtrl::WordRightEnd,
1277 "Move caret right one word, position cursor at end of word.", "");
1278
1279 DocStr(wxStyledTextCtrl::WordRightEndExtend,
1280 "Move caret right one word, position cursor at end of word, extending selection to new caret position.", "");
1281
1282 DocStr(wxStyledTextCtrl::SetWhitespaceChars,
1283 "Set the set of characters making up whitespace for when moving or selecting by word.
1284 Should be called after SetWordChars.", "");
1285
1286 DocStr(wxStyledTextCtrl::SetCharsDefault,
1287 "Reset the set of characters for whitespace and word characters to the defaults.", "");
1288
1289 DocStr(wxStyledTextCtrl::AutoCompGetCurrent,
1290 "Get currently selected item position in the auto-completion list", "");
1291
1292 DocStr(wxStyledTextCtrl::Allocate,
1293 "Enlarge the document to a particular size of text bytes.", "");
1294
1295 DocStr(wxStyledTextCtrl::FindColumn,
1296 "Find the position of a column on a line taking into account tabs and
1297 multi-byte characters. If beyond end of line, return line end position.", "");
1298
1299 DocStr(wxStyledTextCtrl::GetCaretSticky,
1300 "Can the caret preferred x position only be changed by explicit movement commands?", "");
1301
1302 DocStr(wxStyledTextCtrl::SetCaretSticky,
1303 "Stop the caret preferred x position changing when the user types.", "");
1304
1305 DocStr(wxStyledTextCtrl::ToggleCaretSticky,
1306 "Switch between sticky and non-sticky: meant to be bound to a key.", "");
1307
1308 DocStr(wxStyledTextCtrl::SetPasteConvertEndings,
1309 "Enable/Disable convert-on-paste for line endings", "");
1310
1311 DocStr(wxStyledTextCtrl::GetPasteConvertEndings,
1312 "Get convert-on-paste setting", "");
1313
1314 DocStr(wxStyledTextCtrl::SelectionDuplicate,
1315 "Duplicate the selection. If selection empty duplicate the line containing the caret.", "");
1316
1317 DocStr(wxStyledTextCtrl::SetCaretLineBackAlpha,
1318 "Set background alpha of the caret line.", "");
1319
1320 DocStr(wxStyledTextCtrl::GetCaretLineBackAlpha,
1321 "Get the background alpha of the caret line.", "");
1322
1323 DocStr(wxStyledTextCtrl::StartRecord,
1324 "Start notifying the container of all key presses and commands.", "");
1325
1326 DocStr(wxStyledTextCtrl::StopRecord,
1327 "Stop notifying the container of all key presses and commands.", "");
1328
1329 DocStr(wxStyledTextCtrl::SetLexer,
1330 "Set the lexing language of the document.", "");
1331
1332 DocStr(wxStyledTextCtrl::GetLexer,
1333 "Retrieve the lexing language of the document.", "");
1334
1335 DocStr(wxStyledTextCtrl::Colourise,
1336 "Colourise a segment of the document using the current lexing language.", "");
1337
1338 DocStr(wxStyledTextCtrl::SetProperty,
1339 "Set up a value that may be used by a lexer for some optional feature.", "");
1340
1341 DocStr(wxStyledTextCtrl::SetKeyWords,
1342 "Set up the key words used by the lexer.", "");
1343
1344 DocStr(wxStyledTextCtrl::SetLexerLanguage,
1345 "Set the lexing language of the document based on string name.", "");
1346
1347 DocStr(wxStyledTextCtrl::GetProperty,
1348 "Retrieve a 'property' value previously set with SetProperty.", "");
1349
1350 DocStr(wxStyledTextCtrl::GetPropertyExpanded,
1351 "Retrieve a 'property' value previously set with SetProperty,
1352 with '$()' variable replacement on returned buffer.", "");
1353
1354 DocStr(wxStyledTextCtrl::GetPropertyInt,
1355 "Retrieve a 'property' value previously set with SetProperty,
1356 interpreted as an int AFTER any '$()' variable replacement.", "");
1357
1358 DocStr(wxStyledTextCtrl::GetStyleBitsNeeded,
1359 "Retrieve the number of bits the current lexer needs for styling.", "");