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