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