1wxDC(3) Erlang Module Definition wxDC(3)
2
6 wxDC - See external documentation: wxDC.
7
9 See external documentation: wxDC.
10
12 wxDC():
13 An object reference, The representation is internal and can be
16 changed without notice. It can't be used for comparsion stored on
17 disc or distributed for use on other nodes.
18
20 blit(This, DestPt, Sz, Source, SrcPt) -> boolean()
21 Types:
23 This = wxDC()
25 DestPt = {X::integer(), Y::integer()}
26 Sz = {W::integer(), H::integer()}
27 Source = wxDC()
28 SrcPt = {X::integer(), Y::integer()}
29 Equivalent to blit(This, DestPt, Sz, Source, SrcPt, []).
31 blit(This, DestPt, Sz, Source, SrcPt, Options::[Option]) -> boolean()
33 Types:
35 This = wxDC()
37 DestPt = {X::integer(), Y::integer()}
38 Sz = {W::integer(), H::integer()}
39 Source = wxDC()
40 SrcPt = {X::integer(), Y::integer()}
41 Option = {rop, wx:wx_enum()} | {useMask, boolean()} | {srcPt‐
42 Mask, {X::integer(), Y::integer()}}
43 See external documentation.
45 Rop = integer
46 calcBoundingBox(This, X, Y) -> ok
48 Types:
50 This = wxDC()
52 X = integer()
53 Y = integer()
54 See external documentation.
56 clear(This) -> ok
58 Types:
60 This = wxDC()
62 See external documentation.
64 computeScaleAndOrigin(This) -> ok
66 Types:
68 This = wxDC()
70 This function is deprecated: deprecated function not available
72 in wxWidgets-2.9 and later
73 See external documentation.
75 crossHair(This, Pt) -> ok
77 Types:
79 This = wxDC()
81 Pt = {X::integer(), Y::integer()}
82 See external documentation.
84 destroyClippingRegion(This) -> ok
86 Types:
88 This = wxDC()
90 See external documentation.
92 deviceToLogicalX(This, X) -> integer()
94 Types:
96 This = wxDC()
98 X = integer()
99 See external documentation.
101 deviceToLogicalXRel(This, X) -> integer()
103 Types:
105 This = wxDC()
107 X = integer()
108 See external documentation.
110 deviceToLogicalY(This, Y) -> integer()
112 Types:
114 This = wxDC()
116 Y = integer()
117 See external documentation.
119 deviceToLogicalYRel(This, Y) -> integer()
121 Types:
123 This = wxDC()
125 Y = integer()
126 See external documentation.
128 drawArc(This, Pt1, Pt2, Centre) -> ok
130 Types:
132 This = wxDC()
134 Pt1 = {X::integer(), Y::integer()}
135 Pt2 = {X::integer(), Y::integer()}
136 Centre = {X::integer(), Y::integer()}
137 See external documentation.
139 drawBitmap(This, Bmp, Pt) -> ok
141 Types:
143 This = wxDC()
145 Bmp = wxBitmap:wxBitmap()
146 Pt = {X::integer(), Y::integer()}
147 Equivalent to drawBitmap(This, Bmp, Pt, []).
149 drawBitmap(This, Bmp, Pt, Options::[Option]) -> ok
151 Types:
153 This = wxDC()
155 Bmp = wxBitmap:wxBitmap()
156 Pt = {X::integer(), Y::integer()}
157 Option = {useMask, boolean()}
158 See external documentation.
160 drawCheckMark(This, Rect) -> ok
162 Types:
164 This = wxDC()
166 Rect = {X::integer(), Y::integer(), W::integer(), H::inte‐
167 ger()}
168 See external documentation.
170 drawCircle(This, Pt, Radius) -> ok
172 Types:
174 This = wxDC()
176 Pt = {X::integer(), Y::integer()}
177 Radius = integer()
178 See external documentation.
180 drawEllipse(This, Rect) -> ok
182 Types:
184 This = wxDC()
186 Rect = {X::integer(), Y::integer(), W::integer(), H::inte‐
187 ger()}
188 See external documentation.
190 drawEllipse(This, Pt, Sz) -> ok
192 Types:
194 This = wxDC()
196 Pt = {X::integer(), Y::integer()}
197 Sz = {W::integer(), H::integer()}
198 See external documentation.
200 drawEllipticArc(This, Pt, Sz, Sa, Ea) -> ok
202 Types:
204 This = wxDC()
206 Pt = {X::integer(), Y::integer()}
207 Sz = {W::integer(), H::integer()}
208 Sa = number()
209 Ea = number()
210 See external documentation.
212 drawIcon(This, Icon, Pt) -> ok
214 Types:
216 This = wxDC()
218 Icon = wxIcon:wxIcon()
219 Pt = {X::integer(), Y::integer()}
220 See external documentation.
222 drawLabel(This, Text, Rect) -> ok
224 Types:
226 This = wxDC()
228 Text = unicode:chardata()
229 Rect = {X::integer(), Y::integer(), W::integer(), H::inte‐
230 ger()}
231 Equivalent to drawLabel(This, Text, Rect, []).
233 drawLabel(This, Text, Rect, Options::[Option]) -> ok
235 Types:
237 This = wxDC()
239 Text = unicode:chardata()
240 Rect = {X::integer(), Y::integer(), W::integer(), H::inte‐
241 ger()}
242 Option = {alignment, integer()} | {indexAccel, integer()}
243 See external documentation.
245 drawLine(This, Pt1, Pt2) -> ok
247 Types:
249 This = wxDC()
251 Pt1 = {X::integer(), Y::integer()}
252 Pt2 = {X::integer(), Y::integer()}
253 See external documentation.
255 drawLines(This, Points) -> ok
257 Types:
259 This = wxDC()
261 Points = [{X::integer(), Y::integer()}]
262 Equivalent to drawLines(This, Points, []).
264 drawLines(This, Points, Options::[Option]) -> ok
266 Types:
268 This = wxDC()
270 Points = [{X::integer(), Y::integer()}]
271 Option = {xoffset, integer()} | {yoffset, integer()}
272 See external documentation.
274 drawPolygon(This, Points) -> ok
276 Types:
278 This = wxDC()
280 Points = [{X::integer(), Y::integer()}]
281 Equivalent to drawPolygon(This, Points, []).
283 drawPolygon(This, Points, Options::[Option]) -> ok
285 Types:
287 This = wxDC()
289 Points = [{X::integer(), Y::integer()}]
290 Option = {xoffset, integer()} | {yoffset, integer()} | {fill‐
291 Style, wx:wx_enum()}
292 See external documentation.
294 FillStyle = integer
295 drawPoint(This, Pt) -> ok
297 Types:
299 This = wxDC()
301 Pt = {X::integer(), Y::integer()}
302 See external documentation.
304 drawRectangle(This, Rect) -> ok
306 Types:
308 This = wxDC()
310 Rect = {X::integer(), Y::integer(), W::integer(), H::inte‐
311 ger()}
312 See external documentation.
314 drawRectangle(This, Pt, Sz) -> ok
316 Types:
318 This = wxDC()
320 Pt = {X::integer(), Y::integer()}
321 Sz = {W::integer(), H::integer()}
322 See external documentation.
324 drawRotatedText(This, Text, Pt, Angle) -> ok
326 Types:
328 This = wxDC()
330 Text = unicode:chardata()
331 Pt = {X::integer(), Y::integer()}
332 Angle = number()
333 See external documentation.
335 drawRoundedRectangle(This, R, Radius) -> ok
337 Types:
339 This = wxDC()
341 R = {X::integer(), Y::integer(), W::integer(), H::integer()}
342 Radius = number()
343 See external documentation.
345 drawRoundedRectangle(This, Pt, Sz, Radius) -> ok
347 Types:
349 This = wxDC()
351 Pt = {X::integer(), Y::integer()}
352 Sz = {W::integer(), H::integer()}
353 Radius = number()
354 See external documentation.
356 drawText(This, Text, Pt) -> ok
358 Types:
360 This = wxDC()
362 Text = unicode:chardata()
363 Pt = {X::integer(), Y::integer()}
364 See external documentation.
366 endDoc(This) -> ok
368 Types:
370 This = wxDC()
372 See external documentation.
374 endPage(This) -> ok
376 Types:
378 This = wxDC()
380 See external documentation.
382 floodFill(This, Pt, Col) -> boolean()
384 Types:
386 This = wxDC()
388 Pt = {X::integer(), Y::integer()}
389 Col = wx:wx_colour()
390 Equivalent to floodFill(This, Pt, Col, []).
392 floodFill(This, Pt, Col, Options::[Option]) -> boolean()
394 Types:
396 This = wxDC()
398 Pt = {X::integer(), Y::integer()}
399 Col = wx:wx_colour()
400 Option = {style, wx:wx_enum()}
401 See external documentation.
403 Style = integer
404 getBackground(This) -> wxBrush:wxBrush()
406 Types:
408 This = wxDC()
410 See external documentation.
412 getBackgroundMode(This) -> integer()
414 Types:
416 This = wxDC()
418 See external documentation.
420 getBrush(This) -> wxBrush:wxBrush()
422 Types:
424 This = wxDC()
426 See external documentation.
428 getCharHeight(This) -> integer()
430 Types:
432 This = wxDC()
434 See external documentation.
436 getCharWidth(This) -> integer()
438 Types:
440 This = wxDC()
442 See external documentation.
444 getClippingBox(This) -> Result
446 Types:
448 Result = {X::integer(), Y::integer(), W::integer(), H::inte‐
450 ger()}
451 This = wxDC()
452 See external documentation.
454 getFont(This) -> wxFont:wxFont()
456 Types:
458 This = wxDC()
460 See external documentation.
462 getLayoutDirection(This) -> wx:wx_enum()
464 Types:
466 This = wxDC()
468 See external documentation.
470 Res = ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLay‐
471 out_RightToLeft
472 getLogicalFunction(This) -> integer()
474 Types:
476 This = wxDC()
478 See external documentation.
480 getMapMode(This) -> integer()
482 Types:
484 This = wxDC()
486 See external documentation.
488 getMultiLineTextExtent(This, String) -> {W::integer(), H::integer()}
490 Types:
492 This = wxDC()
494 String = unicode:chardata()
495 See external documentation.
497 getMultiLineTextExtent(This, String, Options::[Option]) ->
499 {Width::integer(), Height::integer(), HeightLine::integer()}
500 Types:
502 This = wxDC()
504 String = unicode:chardata()
505 Option = {font, wxFont:wxFont()}
506 See external documentation.
508 getPartialTextExtents(This, Text) -> Result
510 Types:
512 Result = {Res::boolean(), Widths::[integer()]}
514 This = wxDC()
515 Text = unicode:chardata()
516 See external documentation.
518 getPen(This) -> wxPen:wxPen()
520 Types:
522 This = wxDC()
524 See external documentation.
526 getPixel(This, Pt) -> Result
528 Types:
530 Result = {Res::boolean(), Col::wx:wx_colour4()}
532 This = wxDC()
533 Pt = {X::integer(), Y::integer()}
534 See external documentation.
536 getPPI(This) -> {W::integer(), H::integer()}
538 Types:
540 This = wxDC()
542 See external documentation.
544 getSize(This) -> {W::integer(), H::integer()}
546 Types:
548 This = wxDC()
550 See external documentation.
552 getSizeMM(This) -> {W::integer(), H::integer()}
554 Types:
556 This = wxDC()
558 See external documentation.
560 getTextBackground(This) -> wx:wx_colour4()
562 Types:
564 This = wxDC()
566 See external documentation.
568 getTextExtent(This, String) -> {W::integer(), H::integer()}
570 Types:
572 This = wxDC()
574 String = unicode:chardata()
575 See external documentation.
577 getTextExtent(This, String, Options::[Option]) -> Result
579 Types:
581 Result = {X::integer(), Y::integer(), Descent::integer(),
583 ExternalLeading::integer()}
584 This = wxDC()
585 String = unicode:chardata()
586 Option = {theFont, wxFont:wxFont()}
587 See external documentation.
589 getTextForeground(This) -> wx:wx_colour4()
591 Types:
593 This = wxDC()
595 See external documentation.
597 getUserScale(This) -> {X::number(), Y::number()}
599 Types:
601 This = wxDC()
603 See external documentation.
605 gradientFillConcentric(This, Rect, InitialColour, DestColour) -> ok
607 Types:
609 This = wxDC()
611 Rect = {X::integer(), Y::integer(), W::integer(), H::inte‐
612 ger()}
613 InitialColour = wx:wx_colour()
614 DestColour = wx:wx_colour()
615 See external documentation.
617 gradientFillConcentric(This, Rect, InitialColour, DestColour, Circle‐
619 Center) -> ok
620 Types:
622 This = wxDC()
624 Rect = {X::integer(), Y::integer(), W::integer(), H::inte‐
625 ger()}
626 InitialColour = wx:wx_colour()
627 DestColour = wx:wx_colour()
628 CircleCenter = {X::integer(), Y::integer()}
629 See external documentation.
631 gradientFillLinear(This, Rect, InitialColour, DestColour) -> ok
633 Types:
635 This = wxDC()
637 Rect = {X::integer(), Y::integer(), W::integer(), H::inte‐
638 ger()}
639 InitialColour = wx:wx_colour()
640 DestColour = wx:wx_colour()
641 Equivalent to gradientFillLinear(This, Rect, InitialColour,
643 DestColour, []).
644 gradientFillLinear(This, Rect, InitialColour, DestColour,
646 Options::[Option]) -> ok
647 Types:
649 This = wxDC()
651 Rect = {X::integer(), Y::integer(), W::integer(), H::inte‐
652 ger()}
653 InitialColour = wx:wx_colour()
654 DestColour = wx:wx_colour()
655 Option = {nDirection, wx:wx_enum()}
656 See external documentation.
658 NDirection = ?wxLEFT | ?wxRIGHT | ?wxUP | ?wxDOWN | ?wxTOP |
659 ?wxBOTTOM | ?wxNORTH | ?wxSOUTH | ?wxWEST | ?wxEAST | ?wxALL
660 logicalToDeviceX(This, X) -> integer()
662 Types:
664 This = wxDC()
666 X = integer()
667 See external documentation.
669 logicalToDeviceXRel(This, X) -> integer()
671 Types:
673 This = wxDC()
675 X = integer()
676 See external documentation.
678 logicalToDeviceY(This, Y) -> integer()
680 Types:
682 This = wxDC()
684 Y = integer()
685 See external documentation.
687 logicalToDeviceYRel(This, Y) -> integer()
689 Types:
691 This = wxDC()
693 Y = integer()
694 See external documentation.
696 maxX(This) -> integer()
698 Types:
700 This = wxDC()
702 See external documentation.
704 maxY(This) -> integer()
706 Types:
708 This = wxDC()
710 See external documentation.
712 minX(This) -> integer()
714 Types:
716 This = wxDC()
718 See external documentation.
720 minY(This) -> integer()
722 Types:
724 This = wxDC()
726 See external documentation.
728 isOk(This) -> boolean()
730 Types:
732 This = wxDC()
734 See external documentation.
736 resetBoundingBox(This) -> ok
738 Types:
740 This = wxDC()
742 See external documentation.
744 setAxisOrientation(This, XLeftRight, YBottomUp) -> ok
746 Types:
748 This = wxDC()
750 XLeftRight = boolean()
751 YBottomUp = boolean()
752 See external documentation.
754 setBackground(This, Brush) -> ok
756 Types:
758 This = wxDC()
760 Brush = wxBrush:wxBrush()
761 See external documentation.
763 setBackgroundMode(This, Mode) -> ok
765 Types:
767 This = wxDC()
769 Mode = integer()
770 See external documentation.
772 setBrush(This, Brush) -> ok
774 Types:
776 This = wxDC()
778 Brush = wxBrush:wxBrush()
779 See external documentation.
781 setClippingRegion(This, Region) -> ok
783 Types:
785 This = wxDC()
787 Region = wxRegion:wxRegion()
788 See external documentation.
790 Also:
791 setClippingRegion(This, Rect) -> 'ok' when
792 This::wxDC(), Rect::{X::integer(), Y::integer(), W::integer(),
793 H::integer()}.
794 setClippingRegion(This, Pt, Sz) -> ok
797 Types:
799 This = wxDC()
801 Pt = {X::integer(), Y::integer()}
802 Sz = {W::integer(), H::integer()}
803 See external documentation.
805 setDeviceOrigin(This, X, Y) -> ok
807 Types:
809 This = wxDC()
811 X = integer()
812 Y = integer()
813 See external documentation.
815 setFont(This, Font) -> ok
817 Types:
819 This = wxDC()
821 Font = wxFont:wxFont()
822 See external documentation.
824 setLayoutDirection(This, Dir) -> ok
826 Types:
828 This = wxDC()
830 Dir = wx:wx_enum()
831 See external documentation.
833 Dir = ?wxLayout_Default | ?wxLayout_LeftToRight | ?wxLay‐
834 out_RightToLeft
835 setLogicalFunction(This, Function) -> ok
837 Types:
839 This = wxDC()
841 Function = wx:wx_enum()
842 See external documentation.
844 Function = integer
845 setMapMode(This, Mode) -> ok
847 Types:
849 This = wxDC()
851 Mode = wx:wx_enum()
852 See external documentation.
854 Mode = integer
855 setPalette(This, Palette) -> ok
857 Types:
859 This = wxDC()
861 Palette = wxPalette:wxPalette()
862 See external documentation.
864 setPen(This, Pen) -> ok
866 Types:
868 This = wxDC()
870 Pen = wxPen:wxPen()
871 See external documentation.
873 setTextBackground(This, Colour) -> ok
875 Types:
877 This = wxDC()
879 Colour = wx:wx_colour()
880 See external documentation.
882 setTextForeground(This, Colour) -> ok
884 Types:
886 This = wxDC()
888 Colour = wx:wx_colour()
889 See external documentation.
891 setUserScale(This, X, Y) -> ok
893 Types:
895 This = wxDC()
897 X = number()
898 Y = number()
899 See external documentation.
901 startDoc(This, Message) -> boolean()
903 Types:
905 This = wxDC()
907 Message = unicode:chardata()
908 See external documentation.
910 startPage(This) -> ok
912 Types:
914 This = wxDC()
916 See external documentation.
918
920 <>
921 wx 1.9 wxDC(3)