]> git.saurik.com Git - wxWidgets.git/blame - wxPython/wx/py/wxd/Drawing.py
doc tweaks, typo fixed, etc.
[wxWidgets.git] / wxPython / wx / py / wxd / Drawing.py
CommitLineData
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
15from Base import Object
16import Parameters as wx
17
18
19class DC(Object):
20 """"""
21
22 def BeginDrawing(self):
23 """"""
24 pass
25
26 def Blit(self):
27 """"""
28 pass
29
30 def CalcBoundingBox(self):
31 """"""
32 pass
33
34 def CanDrawBitmap(self):
35 """"""
36 pass
37
38 def CanGetTextExtent(self):
39 """"""
40 pass
41
42 def Clear(self):
43 """"""
44 pass
45
46 def CrossHair(self):
47 """"""
48 pass
49
50 def DestroyClippingRegion(self):
51 """"""
52 pass
53
54 def DeviceToLogicalX(self):
55 """"""
56 pass
57
58 def DeviceToLogicalXRel(self):
59 """"""
60 pass
61
62 def DeviceToLogicalY(self):
63 """"""
64 pass
65
66 def DeviceToLogicalYRel(self):
67 """"""
68 pass
69
70 def DrawArc(self):
71 """"""
72 pass
73
74 def DrawBitmap(self):
75 """"""
76 pass
77
78 def DrawCircle(self):
79 """"""
80 pass
81
82 def DrawEllipse(self):
83 """"""
84 pass
85
86 def DrawEllipticArc(self):
87 """"""
88 pass
89
90 def DrawIcon(self):
91 """"""
92 pass
93
94 def DrawImageLabel(self):
95 """"""
96 pass
97
98 def DrawLabel(self):
99 """"""
100 pass
101
102 def DrawLine(self):
103 """"""
104 pass
105
106 def DrawLineList(self):
107 """"""
108 pass
109
110 def DrawLines(self):
111 """"""
112 pass
113
114 def DrawPoint(self):
115 """"""
116 pass
117
118 def DrawPointList(self):
119 """"""
120 pass
121
122 def DrawPolygon(self):
123 """"""
124 pass
125
126 def DrawRectangle(self):
127 """"""
128 pass
129
130 def DrawRectangleRect(self):
131 """"""
132 pass
133
134 def DrawRotatedText(self):
135 """"""
136 pass
137
138 def DrawRoundedRectangle(self):
139 """"""
140 pass
141
142 def DrawSpline(self):
143 """"""
144 pass
145
146 def DrawText(self):
147 """"""
148 pass
149
150 def EndDoc(self):
151 """"""
152 pass
153
154 def EndDrawing(self):
155 """"""
156 pass
157
158 def EndPage(self):
159 """"""
160 pass
161
162 def FloodFill(self):
163 """"""
164 pass
165
166 def GetBackground(self):
167 """"""
168 pass
169
170 def GetBoundingBox(self):
171 """"""
172 pass
173
174 def GetBrush(self):
175 """"""
176 pass
177
178 def GetCharHeight(self):
179 """"""
180 pass
181
182 def GetCharWidth(self):
183 """"""
184 pass
185
186 def GetClippingBox(self):
187 """"""
188 pass
189
190 def GetDepth(self):
191 """"""
192 pass
193
194 def GetDeviceOrigin(self):
195 """"""
196 pass
197
198 def GetFont(self):
199 """"""
200 pass
201
202 def GetFullTextExtent(self):
203 """"""
204 pass
205
206 def GetLogicalFunction(self):
207 """"""
208 pass
209
210 def GetLogicalOrigin(self):
211 """"""
212 pass
213
214 def GetLogicalScale(self):
215 """"""
216 pass
217
218 def GetMapMode(self):
219 """"""
220 pass
221
222 def GetMultiLineTextExtent(self):
223 """"""
224 pass
225
226 def GetOptimization(self):
227 """"""
228 pass
229
230 def GetPPI(self):
231 """"""
232 pass
233
234 def GetPen(self):
235 """"""
236 pass
237
238 def GetPixel(self):
239 """"""
240 pass
241
242 def GetSize(self):
243 """"""
244 pass
245
246 def GetSizeMM(self):
247 """"""
248 pass
249
250 def GetSizeTuple(self):
251 """"""
252 pass
253
254 def GetTextBackground(self):
255 """"""
256 pass
257
258 def GetTextExtent(self):
259 """"""
260 pass
261
262 def GetTextForeground(self):
263 """"""
264 pass
265
266 def GetUserScale(self):
267 """"""
268 pass
269
270 def LogicalToDeviceX(self):
271 """"""
272 pass
273
274 def LogicalToDeviceXRel(self):
275 """"""
276 pass
277
278 def LogicalToDeviceY(self):
279 """"""
280 pass
281
282 def LogicalToDeviceYRel(self):
283 """"""
284 pass
285
286 def MaxX(self):
287 """"""
288 pass
289
290 def MaxY(self):
291 """"""
292 pass
293
294 def MinX(self):
295 """"""
296 pass
297
298 def MinY(self):
299 """"""
300 pass
301
302 def Ok(self):
303 """"""
304 pass
305
306 def ResetBoundingBox(self):
307 """"""
308 pass
309
310 def SetAxisOrientation(self):
311 """"""
312 pass
313
314 def SetBackground(self):
315 """"""
316 pass
317
318 def SetBackgroundMode(self):
319 """"""
320 pass
321
322 def SetBrush(self):
323 """"""
324 pass
325
326 def SetClippingRect(self):
327 """"""
328 pass
329
330 def SetClippingRegion(self):
331 """"""
332 pass
333
334 def SetClippingRegionAsRegion(self):
335 """"""
336 pass
337
338 def SetDeviceOrigin(self):
339 """"""
340 pass
341
342 def SetFont(self):
343 """"""
344 pass
345
346 def SetLogicalFunction(self):
347 """"""
348 pass
349
350 def SetLogicalOrigin(self):
351 """"""
352 pass
353
354 def SetLogicalScale(self):
355 """"""
356 pass
357
358 def SetMapMode(self):
359 """"""
360 pass
361
362 def SetOptimization(self):
363 """"""
364 pass
365
366 def SetPalette(self):
367 """"""
368 pass
369
370 def SetPen(self):
371 """"""
372 pass
373
374 def SetTextBackground(self):
375 """"""
376 pass
377
378 def SetTextForeground(self):
379 """"""
380 pass
381
382 def SetUserScale(self):
383 """"""
384 pass
385
386 def StartDoc(self):
387 """"""
388 pass
389
390 def StartPage(self):
391 """"""
392 pass
393
394 def _DrawLineList(self):
395 """"""
396 pass
397
398 def _DrawPointList(self):
399 """"""
400 pass
401
402 def __del__(self):
403 """"""
404 pass
405
406 def __init__(self):
407 """"""
408 pass
409
410
411class ClientDC(DC):
412 """"""
413
414 def __init__(self):
415 """"""
416 pass
417
418
419class MemoryDC(DC):
420 """"""
421
422 def SelectObject(self):
423 """"""
424 pass
425
426 def __init__(self):
427 """"""
428 pass
429
430
431class BufferedDC(MemoryDC):
432 """"""
433
434 def UnMask(self):
435 """"""
436 pass
437
438 def __init__(self):
439 """"""
440 pass
441
442
443class BufferedPaintDC(BufferedDC):
444 """"""
445
446 def __init__(self):
447 """"""
448 pass
449
450
451class PaintDC(DC):
452 """"""
453
454 def __init__(self):
455 """"""
456 pass
457
458
459class PostScriptDC(DC):
460 """"""
461
462 def GetPrintData(self):
463 """"""
464 pass
465
466 def SetPrintData(self):
467 """"""
468 pass
469
470 def __init__(self):
471 """"""
472 pass
473
474
475class ScreenDC(DC):
476 """"""
477
478 def EndDrawingOnTop(self):
479 """"""
480 pass
481
482 def StartDrawingOnTop(self):
483 """"""
484 pass
485
486 def StartDrawingOnTopWin(self):
487 """"""
488 pass
489
490 def __init__(self):
491 """"""
492 pass
493
494
495class WindowDC(DC):
496 """"""
497
498 def __init__(self):
499 """"""
500 pass
501
502
503class GDIObject(Object):
504 """"""
505
506 def GetVisible(self):
507 """"""
508 pass
509
510 def IsNull(self):
511 """"""
512 pass
513
514 def SetVisible(self):
515 """"""
516 pass
517
518 def __del__(self):
519 """"""
520 pass
521
522 def __init__(self):
523 """"""
524 pass
525
526
527class Bitmap(GDIObject):
528 """"""
529
530 def CopyFromIcon(self):
531 """"""
532 pass
533
534 def GetDepth(self):
535 """"""
536 pass
537
538 def GetHeight(self):
539 """"""
540 pass
541
542 def GetMask(self):
543 """"""
544 pass
545
546 def GetPalette(self):
547 """"""
548 pass
549
550 def GetSubBitmap(self):
551 """"""
552 pass
553
554 def GetWidth(self):
555 """"""
556 pass
557
558 def LoadFile(self):
559 """"""
560 pass
561
562 def Ok(self):
563 """"""
564 pass
565
566 def SaveFile(self):
567 """"""
568 pass
569
570 def SetDepth(self):
571 """"""
572 pass
573
574 def SetHeight(self):
575 """"""
576 pass
577
578 def SetMask(self):
579 """"""
580 pass
581
582 def SetWidth(self):
583 """"""
584 pass
585
586 def __del__(self):
587 """"""
588 pass
589
590 def __init__(self):
591 """"""
592 pass
593
594
595class Brush(GDIObject):
596 """"""
597
598 def GetColour(self):
599 """"""
600 pass
601
602 def GetStipple(self):
603 """"""
604 pass
605
606 def GetStyle(self):
607 """"""
608 pass
609
610 def Ok(self):
611 """"""
612 pass
613
614 def SetColour(self):
615 """"""
616 pass
617
618 def SetStipple(self):
619 """"""
620 pass
621
622 def SetStyle(self):
623 """"""
624 pass
625
626 def __del__(self):
627 """"""
628 pass
629
630 def __init__(self):
631 """"""
632 pass
633
634
635class BrushList(Object):
636 """"""
637
638 def AddBrush(self):
639 """"""
640 pass
641
642 def FindOrCreateBrush(self):
643 """"""
644 pass
645
646 def GetCount(self):
647 """"""
648 pass
649
650 def RemoveBrush(self):
651 """"""
652 pass
653
654 def __init__(self):
655 """"""
656 pass
657
658
659class Colour(Object):
660 """"""
661
662 def Blue(self):
663 """"""
664 pass
665
666 def Get(self):
667 """"""
668 pass
669
670 def Green(self):
671 """"""
672 pass
673
674 def Ok(self):
675 """"""
676 pass
677
678 def Red(self):
679 """"""
680 pass
681
682 def Set(self):
683 """"""
684 pass
685
686 def __del__(self):
687 """"""
688 pass
689
690 def __eq__(self):
691 """"""
692 pass
693
694 def __init__(self):
695 """"""
696 pass
697
698 def __ne__(self):
699 """"""
700 pass
701
702 def __nonzero__(self):
703 """"""
704 pass
705
706 def __str__(self):
707 """"""
708 pass
709
710 def asTuple(self):
711 """"""
712 pass
713
714
715class Cursor(GDIObject):
716 """"""
717
718 def Ok(self):
719 """"""
720 pass
721
722 def __del__(self):
723 """"""
724 pass
725
726 def __init__(self):
727 """"""
728 pass
729
730
731class Font(Object):
732 """"""
733
734 def GetEncoding(self):
735 """"""
736 pass
737
738 def GetFaceName(self):
739 """"""
740 pass
741
742 def GetFamily(self):
743 """"""
744 pass
745
746 def GetFamilyString(self):
747 """"""
748 pass
749
750 def GetNativeFontInfo(self):
751 """"""
752 pass
753
754 def GetNativeFontInfoDesc(self):
755 """"""
756 pass
757
758 def GetNativeFontInfoUserDesc(self):
759 """"""
760 pass
761
762 def GetNoAntiAliasing(self):
763 """"""
764 pass
765
766 def GetPointSize(self):
767 """"""
768 pass
769
770 def GetStyle(self):
771 """"""
772 pass
773
774 def GetStyleString(self):
775 """"""
776 pass
777
778 def GetUnderlined(self):
779 """"""
780 pass
781
782 def GetWeight(self):
783 """"""
784 pass
785
786 def GetWeightString(self):
787 """"""
788 pass
789
790 def IsFixedWidth(self):
791 """"""
792 pass
793
794 def Ok(self):
795 """"""
796 pass
797
798 def SetEncoding(self):
799 """"""
800 pass
801
802 def SetFaceName(self):
803 """"""
804 pass
805
806 def SetFamily(self):
807 """"""
808 pass
809
810 def SetNativeFontInfo(self):
811 """"""
812 pass
813
814 def SetNativeFontInfoUserDesc(self):
815 """"""
816 pass
817
818 def SetNoAntiAliasing(self):
819 """"""
820 pass
821
822 def SetPointSize(self):
823 """"""
824 pass
825
826 def SetStyle(self):
827 """"""
828 pass
829
830 def SetUnderlined(self):
831 """"""
832 pass
833
834 def SetWeight(self):
835 """"""
836 pass
837
838 def __del__(self):
839 """"""
840 pass
841
842 def __init__(self):
843 """"""
844 pass
845
846 def wxFontFromNativeInfoString(self):
847 """"""
848 pass
849
850
851class FontList(Object):
852 """"""
853
854 def AddFont(self):
855 """"""
856 pass
857
858 def FindOrCreateFont(self):
859 """"""
860 pass
861
862 def GetCount(self):
863 """"""
864 pass
865
866 def RemoveFont(self):
867 """"""
868 pass
869
870 def __init__(self):
871 """"""
872 pass
873
874
875class Icon(GDIObject):
876 """"""
877
878 def CopyFromBitmap(self):
879 """"""
880 pass
881
882 def GetDepth(self):
883 """"""
884 pass
885
886 def GetHeight(self):
887 """"""
888 pass
889
890 def GetWidth(self):
891 """"""
892 pass
893
894 def LoadFile(self):
895 """"""
896 pass
897
898 def Ok(self):
899 """"""
900 pass
901
902 def SetDepth(self):
903 """"""
904 pass
905
906 def SetHeight(self):
907 """"""
908 pass
909
910 def SetWidth(self):
911 """"""
912 pass
913
914 def __del__(self):
915 """"""
916 pass
917
918 def __init__(self):
919 """"""
920 pass
921
922
923class IconBundle:
924 """"""
925
926 def AddIcon(self):
927 """"""
928 pass
929
930 def AddIconFromFile(self):
931 """"""
932 pass
933
934 def GetIcon(self):
935 """"""
936 pass
937
938 def __del__(self):
939 """"""
940 pass
941
942 def __init__(self):
943 """"""
944 pass
945
946
947class Image(Object):
948 """"""
949
950 def ConvertToBitmap(self):
951 """"""
952 pass
953
954 def ConvertToMono(self):
955 """"""
956 pass
957
958 def ConvertToMonoBitmap(self):
959 """"""
960 pass
961
962 def Copy(self):
963 """"""
964 pass
965
966 def CountColours(self):
967 """"""
968 pass
969
970 def Create(self):
971 """"""
972 pass
973
974 def Destroy(self):
975 """"""
976 pass
977
978 def FindFirstUnusedColour(self):
979 """"""
980 pass
981
982 def GetBlue(self):
983 """"""
984 pass
985
986 def GetData(self):
987 """"""
988 pass
989
990 def GetDataBuffer(self):
991 """"""
992 pass
993
994 def GetGreen(self):
995 """"""
996 pass
997
998 def GetHeight(self):
999 """"""
1000 pass
1001
1002 def GetMaskBlue(self):
1003 """"""
1004 pass
1005
1006 def GetMaskGreen(self):
1007 """"""
1008 pass
1009
1010 def GetMaskRed(self):
1011 """"""
1012 pass
1013
1014 def GetOption(self):
1015 """"""
1016 pass
1017
1018 def GetOptionInt(self):
1019 """"""
1020 pass
1021
1022 def GetRed(self):
1023 """"""
1024 pass
1025
1026 def GetSubImage(self):
1027 """"""
1028 pass
1029
1030 def GetWidth(self):
1031 """"""
1032 pass
1033
1034 def HasMask(self):
1035 """"""
1036 pass
1037
1038 def HasOption(self):
1039 """"""
1040 pass
1041
1042 def LoadFile(self):
1043 """"""
1044 pass
1045
1046 def LoadMimeFile(self):
1047 """"""
1048 pass
1049
1050 def LoadMimeStream(self):
1051 """"""
1052 pass
1053
1054 def LoadStream(self):
1055 """"""
1056 pass
1057
1058 def Mirror(self):
1059 """"""
1060 pass
1061
1062 def Ok(self):
1063 """"""
1064 pass
1065
1066 def Paste(self):
1067 """"""
1068 pass
1069
1070 def Replace(self):
1071 """"""
1072 pass
1073
1074 def Rescale(self):
1075 """"""
1076 pass
1077
1078 def Rotate(self):
1079 """"""
1080 pass
1081
1082 def Rotate90(self):
1083 """"""
1084 pass
1085
1086 def SaveFile(self):
1087 """"""
1088 pass
1089
1090 def SaveMimeFile(self):
1091 """"""
1092 pass
1093
1094 def Scale(self):
1095 """"""
1096 pass
1097
1098 def SetData(self):
1099 """"""
1100 pass
1101
1102 def SetMask(self):
1103 """"""
1104 pass
1105
1106 def SetMaskColour(self):
1107 """"""
1108 pass
1109
1110 def SetMaskFromImage(self):
1111 """"""
1112 pass
1113
1114 def SetOption(self):
1115 """"""
1116 pass
1117
1118 def SetOptionInt(self):
1119 """"""
1120 pass
1121
1122 def SetRGB(self):
1123 """"""
1124 pass
1125
1126 def __del__(self):
1127 """"""
1128 pass
1129
1130 def __init__(self):
1131 """"""
1132 pass
1133
1134
1135class ImageList(Object):
1136 """"""
1137
1138 def Add(self):
1139 """"""
1140 pass
1141
1142 def AddIcon(self):
1143 """"""
1144 pass
1145
1146 def AddWithColourMask(self):
1147 """"""
1148 pass
1149
1150 def Draw(self):
1151 """"""
1152 pass
1153
1154 def GetImageCount(self):
1155 """"""
1156 pass
1157
1158 def GetSize(self):
1159 """"""
1160 pass
1161
1162 def Remove(self):
1163 """"""
1164 pass
1165
1166 def RemoveAll(self):
1167 """"""
1168 pass
1169
1170 def Replace(self):
1171 """"""
1172 pass
1173
1174 def __del__(self):
1175 """"""
1176 pass
1177
1178 def __init__(self):
1179 """"""
1180 pass
1181
1182
1183class Mask(Object):
1184 """"""
1185
1186 def Destroy(self):
1187 """"""
1188 pass
1189
1190 def __init__(self):
1191 """"""
1192 pass
1193
1194
1195class Palette(GDIObject):
1196 """"""
1197
1198 def GetPixel(self):
1199 """"""
1200 pass
1201
1202 def GetRGB(self):
1203 """"""
1204 pass
1205
1206 def Ok(self):
1207 """"""
1208 pass
1209
1210 def __del__(self):
1211 """"""
1212 pass
1213
1214 def __init__(self):
1215 """"""
1216 pass
1217
1218
1219class Pen(GDIObject):
1220 """"""
1221
1222 def GetCap(self):
1223 """"""
1224 pass
1225
1226 def GetColour(self):
1227 """"""
1228 pass
1229
1230 def GetDashes(self):
1231 """"""
1232 pass
1233
1234 def GetJoin(self):
1235 """"""
1236 pass
1237
1238 def GetStyle(self):
1239 """"""
1240 pass
1241
1242 def GetWidth(self):
1243 """"""
1244 pass
1245
1246 def Ok(self):
1247 """"""
1248 pass
1249
1250 def SetCap(self):
1251 """"""
1252 pass
1253
1254 def SetColour(self):
1255 """"""
1256 pass
1257
1258 def SetDashes(self):
1259 """"""
1260 pass
1261
1262 def SetJoin(self):
1263 """"""
1264 pass
1265
1266 def SetStyle(self):
1267 """"""
1268 pass
1269
1270 def SetWidth(self):
1271 """"""
1272 pass
1273
1274 def __del__(self):
1275 """"""
1276 pass
1277
1278 def __init__(self):
1279 """"""
1280 pass
1281
1282
1283class PenList(Object):
1284 """"""
1285
1286 def AddPen(self):
1287 """"""
1288 pass
1289
1290 def FindOrCreatePen(self):
1291 """"""
1292 pass
1293
1294 def GetCount(self):
1295 """"""
1296 pass
1297
1298 def RemovePen(self):
1299 """"""
1300 pass
1301
1302 def __init__(self):
1303 """"""
1304 pass
1305
1306
1307class PyPen(Pen):
1308 """"""
1309
1310 def SetDashes(self):
1311 """"""
1312 pass
1313
1314 def __del__(self):
1315 """"""
1316 pass
1317
1318 def __init__(self):
1319 """"""
1320 pass
1321
1322
1323class Region(GDIObject):
1324 """"""
1325
1326 def Clear(self):
1327 """"""
1328 pass
1329
1330 def Contains(self):
1331 """"""
1332 pass
1333
1334 def ContainsPoint(self):
1335 """"""
1336 pass
1337
1338 def ContainsRect(self):
1339 """"""
1340 pass
1341
1342 def ContainsRectDim(self):
1343 """"""
1344 pass
1345
1346 def GetBox(self):
1347 """"""
1348 pass
1349
1350 def Intersect(self):
1351 """"""
1352 pass
1353
1354 def IntersectRect(self):
1355 """"""
1356 pass
1357
1358 def IntersectRegion(self):
1359 """"""
1360 pass
1361
1362 def IsEmpty(self):
1363 """"""
1364 pass
1365
1366 def Offset(self):
1367 """"""
1368 pass
1369
1370 def Subtract(self):
1371 """"""
1372 pass
1373
1374 def SubtractRect(self):
1375 """"""
1376 pass
1377
1378 def SubtractRegion(self):
1379 """"""
1380 pass
1381
1382 def Union(self):
1383 """"""
1384 pass
1385
1386 def UnionRect(self):
1387 """"""
1388 pass
1389
1390 def UnionRegion(self):
1391 """"""
1392 pass
1393
1394 def Xor(self):
1395 """"""
1396 pass
1397
1398 def XorRect(self):
1399 """"""
1400 pass
1401
1402 def XorRegion(self):
1403 """"""
1404 pass
1405
1406 def __del__(self):
1407 """"""
1408 pass
1409
1410 def __init__(self):
1411 """"""
1412 pass
1413
1414
1415class RegionIterator(Object):
1416 """"""
1417
1418 def GetH(self):
1419 """"""
1420 pass
1421
1422 def GetHeight(self):
1423 """"""
1424 pass
1425
1426 def GetRect(self):
1427 """"""
1428 pass
1429
1430 def GetW(self):
1431 """"""
1432 pass
1433
1434 def GetWidth(self):
1435 """"""
1436 pass
1437
1438 def GetX(self):
1439 """"""
1440 pass
1441
1442 def GetY(self):
1443 """"""
1444 pass
1445
1446 def HaveRects(self):
1447 """"""
1448 pass
1449
1450 def Next(self):
1451 """"""
1452 pass
1453
1454 def Reset(self):
1455 """"""
1456 pass
1457
1458 def __del__(self):
1459 """"""
1460 pass
1461
1462 def __init__(self):
1463 """"""
1464 pass
1465
1466