]>
Commit | Line | Data |
---|---|---|
f2ccce28 RD |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: _stc_docstrings.i | |
3 | // Purpose: Docstrings for the wxStyledTextCtrl. The ones in this file | |
4 | // are maintained by hand for those methods that are not | |
5 | // auto-generated by gen_iface.py | |
6 | // | |
7 | // Author: Robin Dunn | |
8 | // | |
9 | // Created: 16-April-2005 | |
10 | // RCS-ID: $Id$ | |
11 | // Copyright: (c) 2005 by Total Control Software | |
12 | // Licence: wxWindows license | |
13 | ///////////////////////////////////////////////////////////////////////////// | |
14 | ||
15 | ||
16 | // First include the autogenerated docstrings so if any of them need | |
17 | // tweaked they can be overridden below | |
18 | %include _stc_gendocs.i | |
19 | ||
20 | ||
21 | // TODO: Class docstring | |
22 | DocStr(wxStyledTextCtrl, | |
23 | "", ""); | |
24 | ||
25 | // TODO: Main constructor | |
26 | DocStr(wxStyledTextCtrl::wxStyledTextCtrl, | |
27 | "", ""); | |
28 | ||
29 | // TODO: "Pre" constructor | |
30 | DocStr(wxStyledTextCtrl::wxStyledTextCtrl(), | |
31 | "", ""); | |
32 | ||
33 | ||
34 | ||
35 | DocStr(wxStyledTextCtrl::GetCurrentLine, | |
36 | "Returns the line number of the line with the caret.", ""); | |
37 | ||
38 | DocStr(wxStyledTextCtrl::StyleSetSpec, | |
39 | "Extract style settings from a spec-string which is composed of one or | |
40 | more of the following comma separated elements:: | |
41 | ||
42 | bold turns on bold | |
43 | italic turns on italics | |
44 | fore:[name or #RRGGBB] sets the foreground colour | |
45 | back:[name or #RRGGBB] sets the background colour | |
46 | face:[facename] sets the font face name to use | |
47 | size:[num] sets the font size in points | |
48 | eol turns on eol filling | |
49 | underline turns on underlining | |
50 | ", ""); | |
51 | ||
52 | DocStr(wxStyledTextCtrl::StyleSetFont, | |
53 | "Set style size, face, bold, italic, and underline attributes from the | |
54 | attributes of a `wx.Font`.", ""); | |
55 | ||
56 | DocStr(wxStyledTextCtrl::StyleSetFontAttr, | |
57 | "Set all font style attributes at once.", ""); | |
58 | ||
3727c043 RD |
59 | DocStr(wxStyledTextCtrl::StyleSetCharacterSet, |
60 | "Set the character set of the font in a style. Converts the Scintilla | |
61 | wx.stc.STC_CHARSET_* set values to a wxFontEncoding.", ""); | |
62 | ||
63 | DocStr(wxStyledTextCtrl::StyleSetFontEncoding, | |
64 | "Set the font encoding to be used by a style.", ""); | |
65 | ||
f2ccce28 RD |
66 | DocStr(wxStyledTextCtrl::CmdKeyExecute, |
67 | "Perform one of the operations defined by the wx.stc.STC_CMD_* constants.", ""); | |
68 | ||
69 | DocStr(wxStyledTextCtrl::SetMargins, | |
70 | "Set the left and right margin in the edit area, measured in pixels.", ""); | |
71 | ||
72 | DocAStr(wxStyledTextCtrl::GetSelection, | |
73 | "GetSelection(self) -> (startPos, endPos)", | |
74 | "Retrieve the start and end positions of the current selection.", ""); | |
75 | ||
76 | DocStr(wxStyledTextCtrl::PointFromPosition, | |
77 | "Retrieve the point in the window where a position is displayed.", ""); | |
78 | ||
79 | DocStr(wxStyledTextCtrl::ScrollToLine, | |
80 | "Scroll enough to make the given line visible.", ""); | |
81 | ||
82 | DocStr(wxStyledTextCtrl::ScrollToColumn, | |
83 | "Scroll enough to make the given column visible", ""); | |
84 | ||
85 | DocStr(wxStyledTextCtrl::SendMsg, | |
86 | "Send a message to Scintilla.", ""); | |
87 | ||
88 | DocStr(wxStyledTextCtrl::SetVScrollBar, | |
89 | "Set the vertical scrollbar to use instead of the one that's built-in.", ""); | |
90 | ||
91 | DocStr(wxStyledTextCtrl::SetHScrollBar, | |
92 | "Set the horizontal scrollbar to use instead of the ont that's built-in.", ""); | |
93 | ||
94 | DocStr(wxStyledTextCtrl::SaveFile, | |
95 | "Write the contents of the editor to filename", ""); | |
96 | ||
97 | DocStr(wxStyledTextCtrl::LoadFile, | |
98 | "Load the contents of filename into the editor", ""); | |
99 | ||
100 | DocStr(wxStyledTextCtrl::DoDragOver, | |
101 | "Allow for simulating a DnD DragOver.", ""); | |
102 | ||
103 | DocStr(wxStyledTextCtrl::DoDropText, | |
104 | "Allow for simulating a DnD DropText.", ""); | |
105 | ||
106 | DocStr(wxStyledTextCtrl::SetUseAntiAliasing, | |
107 | "Specify whether anti-aliased fonts should be used. Will have no | |
108 | effect on some platforms, but on some (wxMac for example) can greatly | |
109 | improve performance.", ""); | |
110 | ||
111 | DocStr(wxStyledTextCtrl::GetUseAntiAliasing, | |
112 | "Returns the current UseAntiAliasing setting.", ""); | |
113 | ||
114 | ||
115 | ||
116 | DocStr(wxStyledTextCtrl::AddTextRaw, | |
117 | "Add text to the document at current position. The text should be | |
118 | utf-8 encoded on unicode builds of wxPython, or can be any 8-bit text | |
119 | in ansi builds.", ""); | |
120 | ||
121 | DocStr(wxStyledTextCtrl::InsertTextRaw, | |
122 | "Insert string at a position. The text should be utf-8 encoded on | |
123 | unicode builds of wxPython, or can be any 8-bit text in ansi builds.", ""); | |
124 | ||
125 | DocAStr(wxStyledTextCtrl::GetCurLineRaw, | |
126 | "GetCurLineRaw() -> (text, index)", | |
127 | "Retrieve the text of the line containing the caret, and also the index | |
128 | of the caret on the line. The returned value is a utf-8 encoded | |
129 | string in unicode builds of wxPython, or raw 8-bit text otherwise.", ""); | |
130 | ||
131 | DocStr(wxStyledTextCtrl::GetLineRaw, | |
132 | "Retrieve the contents of a line. The returned value is a utf-8 | |
133 | encoded string in unicode builds of wxPython, or raw 8-bit text | |
134 | otherwise.", ""); | |
135 | ||
136 | DocStr(wxStyledTextCtrl::GetSelectedTextRaw, | |
137 | "Retrieve the selected text. The returned value is a utf-8 encoded | |
138 | string in unicode builds of wxPython, or raw 8-bit text otherwise.", ""); | |
139 | ||
140 | DocStr(wxStyledTextCtrl::GetTextRangeRaw, | |
141 | "Retrieve a range of text. The returned value is a utf-8 encoded | |
142 | string in unicode builds of wxPython, or raw 8-bit text otherwise.", ""); | |
143 | ||
144 | DocStr(wxStyledTextCtrl::SetTextRaw, | |
145 | "Replace the contents of the document with the argument text. The text | |
146 | should be utf-8 encoded on unicode builds of wxPython, or can be any | |
147 | 8-bit text in ansi builds.", ""); | |
148 | ||
149 | DocStr(wxStyledTextCtrl::GetTextRaw, | |
150 | "Retrieve all the text in the document. The returned value is a utf-8 | |
151 | encoded string in unicode builds of wxPython, or raw 8-bit text | |
152 | otherwise.", ""); | |
153 | ||
154 | DocStr(wxStyledTextCtrl::AppendTextRaw, | |
155 | "Append a string to the end of the document without changing the | |
156 | selection. The text should be utf-8 encoded on unicode builds of | |
157 | wxPython, or can be any 8-bit text in ansi builds.", ""); | |
158 | ||
159 | ||
160 | ||
161 | ||
162 | // Overrides for some of the generated docstrings | |
163 | ||
164 | DocAStr(wxStyledTextCtrl::GetCurLine, | |
165 | "GetCurLine(self) -> (text, pos)", | |
166 | "Retrieve the text of the line containing the caret, and also theindex | |
167 | of the caret on the line.", ""); | |
168 |