projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 1e4a197e RD |
1 | """Decorator classes for documentation and shell scripting. |
| 2 | """ | |
| 3 | ||
| 4 | __author__ = "Patrick K. O'Brien <pobrien@orbtech.com>" | |
| 5 | __cvsid__ = "$Id$" | |
| 6 | __revision__ = "$Revision$"[11:-2] | |
| 7 | ||
| 8 | ||
| 9 | # These are not the real wxPython classes. These are Python versions | |
| 10 | # for documentation purposes. They are also used to apply docstrings | |
| 11 | # to the real wxPython classes, which are SWIG-generated wrappers for | |
| 12 | # C-language classes. | |
| 13 | ||
| 14 | ||
| 15 | from Base import Object | |
| 16 | from Controls import Control | |
| 17 | import Parameters as wx | |
| 18 | ||
| 19 | ||
| 20 | class TreeCtrl(Control): | |
| 1fded56b RD |
21 | """A tree control presents information as a hierarchy, with items |
| 22 | that may be expanded to show further items. Items in a tree | |
| 23 | control are referenced by wx.TreeItemId handles, which may be | |
| 24 | tested for validity by calling TreeItemId.IsOk().""" | |
| 1e4a197e RD |
25 | |
| 26 | def AddRoot(self): | |
| 27 | """""" | |
| 28 | pass | |
| 29 | ||
| 30 | def AppendItem(self): | |
| 31 | """""" | |
| 32 | pass | |
| 33 | ||
| 34 | def AssignImageList(self): | |
| 35 | """""" | |
| 36 | pass | |
| 37 | ||
| 38 | def AssignStateImageList(self): | |
| 39 | """""" | |
| 40 | pass | |
| 41 | ||
| 42 | def Collapse(self): | |
| 43 | """""" | |
| 44 | pass | |
| 45 | ||
| 46 | def CollapseAndReset(self): | |
| 47 | """""" | |
| 48 | pass | |
| 49 | ||
| 50 | def Create(self): | |
| 51 | """""" | |
| 52 | pass | |
| 53 | ||
| 54 | def Delete(self): | |
| 55 | """""" | |
| 56 | pass | |
| 57 | ||
| 58 | def DeleteAllItems(self): | |
| 59 | """""" | |
| 60 | pass | |
| 61 | ||
| 62 | def DeleteChildren(self): | |
| 63 | """""" | |
| 64 | pass | |
| 65 | ||
| 66 | def EditLabel(self): | |
| 67 | """""" | |
| 68 | pass | |
| 69 | ||
| 70 | def EnsureVisible(self): | |
| 71 | """""" | |
| 72 | pass | |
| 73 | ||
| 74 | def Expand(self): | |
| 75 | """""" | |
| 76 | pass | |
| 77 | ||
| 78 | def GetBoundingRect(self): | |
| 79 | """""" | |
| 80 | pass | |
| 81 | ||
| 82 | def GetChildrenCount(self): | |
| 83 | """""" | |
| 84 | pass | |
| 85 | ||
| 86 | def GetCount(self): | |
| 87 | """""" | |
| 88 | pass | |
| 89 | ||
| 90 | def GetEditControl(self): | |
| 91 | """""" | |
| 92 | pass | |
| 93 | ||
| 94 | def GetFirstChild(self): | |
| 95 | """""" | |
| 96 | pass | |
| 97 | ||
| 98 | def GetFirstVisibleItem(self): | |
| 99 | """""" | |
| 100 | pass | |
| 101 | ||
| 102 | def GetImageList(self): | |
| 103 | """""" | |
| 104 | pass | |
| 105 | ||
| 106 | def GetIndent(self): | |
| 107 | """""" | |
| 108 | pass | |
| 109 | ||
| 110 | def GetItemBackgroundColour(self): | |
| 111 | """""" | |
| 112 | pass | |
| 113 | ||
| 114 | def GetItemData(self): | |
| 115 | """""" | |
| 116 | pass | |
| 117 | ||
| 118 | def GetItemFont(self): | |
| 119 | """""" | |
| 120 | pass | |
| 121 | ||
| 122 | def GetItemImage(self): | |
| 123 | """""" | |
| 124 | pass | |
| 125 | ||
| 126 | def GetItemParent(self): | |
| 127 | """""" | |
| 128 | pass | |
| 129 | ||
| 130 | def GetItemSelectedImage(self): | |
| 131 | """""" | |
| 132 | pass | |
| 133 | ||
| 134 | def GetItemText(self): | |
| 135 | """""" | |
| 136 | pass | |
| 137 | ||
| 138 | def GetItemTextColour(self): | |
| 139 | """""" | |
| 140 | pass | |
| 141 | ||
| 142 | def GetLastChild(self): | |
| 143 | """""" | |
| 144 | pass | |
| 145 | ||
| 146 | def GetNextChild(self): | |
| 147 | """""" | |
| 148 | pass | |
| 149 | ||
| 150 | def GetNextSibling(self): | |
| 151 | """""" | |
| 152 | pass | |
| 153 | ||
| 154 | def GetNextVisible(self): | |
| 155 | """""" | |
| 156 | pass | |
| 157 | ||
| 158 | def GetPrevSibling(self): | |
| 159 | """""" | |
| 160 | pass | |
| 161 | ||
| 162 | def GetPrevVisible(self): | |
| 163 | """""" | |
| 164 | pass | |
| 165 | ||
| 166 | def GetPyData(self): | |
| 167 | """""" | |
| 168 | pass | |
| 169 | ||
| 170 | def GetRootItem(self): | |
| 171 | """""" | |
| 172 | pass | |
| 173 | ||
| 174 | def GetSelection(self): | |
| 175 | """""" | |
| 176 | pass | |
| 177 | ||
| 178 | def GetSelections(self): | |
| 179 | """""" | |
| 180 | pass | |
| 181 | ||
| 182 | def GetSpacing(self): | |
| 183 | """""" | |
| 184 | pass | |
| 185 | ||
| 186 | def GetStateImageList(self): | |
| 187 | """""" | |
| 188 | pass | |
| 189 | ||
| 190 | def HitTest(self): | |
| 191 | """""" | |
| 192 | pass | |
| 193 | ||
| 194 | def InsertItem(self): | |
| 195 | """""" | |
| 196 | pass | |
| 197 | ||
| 198 | def InsertItemBefore(self): | |
| 199 | """""" | |
| 200 | pass | |
| 201 | ||
| 202 | def IsBold(self): | |
| 203 | """""" | |
| 204 | pass | |
| 205 | ||
| 206 | def IsExpanded(self): | |
| 207 | """""" | |
| 208 | pass | |
| 209 | ||
| 210 | def IsSelected(self): | |
| 211 | """""" | |
| 212 | pass | |
| 213 | ||
| 214 | def IsVisible(self): | |
| 215 | """""" | |
| 216 | pass | |
| 217 | ||
| 218 | def ItemHasChildren(self): | |
| 219 | """""" | |
| 220 | pass | |
| 221 | ||
| 222 | def PrependItem(self): | |
| 223 | """""" | |
| 224 | pass | |
| 225 | ||
| 226 | def ScrollTo(self): | |
| 227 | """""" | |
| 228 | pass | |
| 229 | ||
| 230 | def SelectItem(self): | |
| 231 | """""" | |
| 232 | pass | |
| 233 | ||
| 234 | def SetImageList(self): | |
| 235 | """""" | |
| 236 | pass | |
| 237 | ||
| 238 | def SetIndent(self): | |
| 239 | """""" | |
| 240 | pass | |
| 241 | ||
| 242 | def SetItemBackgroundColour(self): | |
| 243 | """""" | |
| 244 | pass | |
| 245 | ||
| 246 | def SetItemBold(self): | |
| 247 | """""" | |
| 248 | pass | |
| 249 | ||
| 250 | def SetItemData(self): | |
| 251 | """""" | |
| 252 | pass | |
| 253 | ||
| 254 | def SetItemFont(self): | |
| 255 | """""" | |
| 256 | pass | |
| 257 | ||
| 258 | def SetItemHasChildren(self): | |
| 259 | """""" | |
| 260 | pass | |
| 261 | ||
| 262 | def SetItemImage(self): | |
| 263 | """""" | |
| 264 | pass | |
| 265 | ||
| 266 | def SetItemSelectedImage(self): | |
| 267 | """""" | |
| 268 | pass | |
| 269 | ||
| 270 | def SetItemText(self): | |
| 271 | """""" | |
| 272 | pass | |
| 273 | ||
| 274 | def SetItemTextColour(self): | |
| 275 | """""" | |
| 276 | pass | |
| 277 | ||
| 278 | def SetPyData(self): | |
| 279 | """""" | |
| 280 | pass | |
| 281 | ||
| 282 | def SetSpacing(self): | |
| 283 | """""" | |
| 284 | pass | |
| 285 | ||
| 286 | def SetStateImageList(self): | |
| 287 | """""" | |
| 288 | pass | |
| 289 | ||
| 290 | def SortChildren(self): | |
| 291 | """""" | |
| 292 | pass | |
| 293 | ||
| 294 | def Toggle(self): | |
| 295 | """""" | |
| 296 | pass | |
| 297 | ||
| 298 | def Unselect(self): | |
| 299 | """""" | |
| 300 | pass | |
| 301 | ||
| 302 | def UnselectAll(self): | |
| 303 | """""" | |
| 304 | pass | |
| 305 | ||
| 306 | def __init__(self): | |
| 307 | """""" | |
| 308 | pass | |
| 309 | ||
| 310 | def _setCallbackInfo(self): | |
| 311 | """""" | |
| 312 | pass | |
| 313 | ||
| 314 | ||
| 315 | class TreeItemAttr: | |
| 316 | """""" | |
| 317 | ||
| 318 | def GetBackgroundColour(self): | |
| 319 | """""" | |
| 320 | pass | |
| 321 | ||
| 322 | def GetFont(self): | |
| 323 | """""" | |
| 324 | pass | |
| 325 | ||
| 326 | def GetTextColour(self): | |
| 327 | """""" | |
| 328 | pass | |
| 329 | ||
| 330 | def HasBackgroundColour(self): | |
| 331 | """""" | |
| 332 | pass | |
| 333 | ||
| 334 | def HasFont(self): | |
| 335 | """""" | |
| 336 | pass | |
| 337 | ||
| 338 | def HasTextColour(self): | |
| 339 | """""" | |
| 340 | pass | |
| 341 | ||
| 342 | def SetBackgroundColour(self): | |
| 343 | """""" | |
| 344 | pass | |
| 345 | ||
| 346 | def SetFont(self): | |
| 347 | """""" | |
| 348 | pass | |
| 349 | ||
| 350 | def SetTextColour(self): | |
| 351 | """""" | |
| 352 | pass | |
| 353 | ||
| 354 | def __init__(self): | |
| 355 | """""" | |
| 356 | pass | |
| 357 | ||
| 358 | ||
| 359 | class TreeItemData(Object): | |
| 1fded56b RD |
360 | """TreeItemData is some (arbitrary) user class associated with |
| 361 | some item. The main advantage of having this class is that | |
| 362 | TreeItemData objects are destroyed automatically by the tree and | |
| 363 | the memory and any other resources associated with a tree item | |
| 364 | will be automatically freed when it is deleted.""" | |
| 1e4a197e | 365 | |
| 1fded56b RD |
366 | def __init__(self, obj=wx.NULL): |
| 367 | """Associate any Python object with tree item using | |
| 368 | wxTreeItemData as container.""" | |
| 1e4a197e RD |
369 | pass |
| 370 | ||
| 1fded56b RD |
371 | def GetData(self): |
| 372 | """Return the Python object.""" | |
| 1e4a197e RD |
373 | pass |
| 374 | ||
| 1fded56b RD |
375 | def GetId(self): |
| 376 | """Return the item associated with this node.""" | |
| 1e4a197e RD |
377 | pass |
| 378 | ||
| 1fded56b RD |
379 | def SetData(self, obj): |
| 380 | """Associate Python object with tree item.""" | |
| 1e4a197e RD |
381 | pass |
| 382 | ||
| 1fded56b RD |
383 | def SetId(self, id): |
| 384 | """Set the item associated with this node.""" | |
| 1e4a197e RD |
385 | pass |
| 386 | ||
| 387 | ||
| 388 | class TreeItemId: | |
| 1fded56b | 389 | """Item in a TreeCtrl.""" |
| 1e4a197e | 390 | |
| 1fded56b | 391 | ## You wouldn't create these directly. |
| 1e4a197e | 392 | |
| 1fded56b RD |
393 | ## def __init__(self): |
| 394 | ## """""" | |
| 395 | ## pass | |
| 1e4a197e | 396 | |
| 1fded56b RD |
397 | def IsOk(self): |
| 398 | """Return True if item is valid.""" | |
| 1e4a197e RD |
399 | pass |
| 400 | ||
| 1fded56b RD |
401 | def Ok(self): |
| 402 | """Synonym for IsOk.""" | |
| 1e4a197e | 403 | pass |