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