1wxDC(3)                    Erlang Module Definition                    wxDC(3)
2
3
4

NAME

6       wxDC - See external documentation: wxDC.
7

DESCRIPTION

9       See external documentation: wxDC.
10

DATA TYPES

12         wxDC():
13
14
15           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

EXPORTS

20       blit(This, DestPt, Sz, Source, SrcPt) -> boolean()
21
22              Types:
23
24                 This = wxDC()
25                 DestPt = {X::integer(), Y::integer()}
26                 Sz = {W::integer(), H::integer()}
27                 Source = wxDC()
28                 SrcPt = {X::integer(), Y::integer()}
29
30              Equivalent to blit(This, DestPt, Sz, Source, SrcPt, []).
31
32       blit(This, DestPt, Sz, Source, SrcPt, Options::[Option]) -> boolean()
33
34              Types:
35
36                 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
44              See external documentation.
45              Rop = integer
46
47       calcBoundingBox(This, X, Y) -> ok
48
49              Types:
50
51                 This = wxDC()
52                 X = integer()
53                 Y = integer()
54
55              See external documentation.
56
57       clear(This) -> ok
58
59              Types:
60
61                 This = wxDC()
62
63              See external documentation.
64
65       computeScaleAndOrigin(This) -> ok
66
67              Types:
68
69                 This = wxDC()
70
71              This function is deprecated: deprecated function  not  available
72              in wxWidgets-2.9 and later
73
74              See external documentation.
75
76       crossHair(This, Pt) -> ok
77
78              Types:
79
80                 This = wxDC()
81                 Pt = {X::integer(), Y::integer()}
82
83              See external documentation.
84
85       destroyClippingRegion(This) -> ok
86
87              Types:
88
89                 This = wxDC()
90
91              See external documentation.
92
93       deviceToLogicalX(This, X) -> integer()
94
95              Types:
96
97                 This = wxDC()
98                 X = integer()
99
100              See external documentation.
101
102       deviceToLogicalXRel(This, X) -> integer()
103
104              Types:
105
106                 This = wxDC()
107                 X = integer()
108
109              See external documentation.
110
111       deviceToLogicalY(This, Y) -> integer()
112
113              Types:
114
115                 This = wxDC()
116                 Y = integer()
117
118              See external documentation.
119
120       deviceToLogicalYRel(This, Y) -> integer()
121
122              Types:
123
124                 This = wxDC()
125                 Y = integer()
126
127              See external documentation.
128
129       drawArc(This, Pt1, Pt2, Centre) -> ok
130
131              Types:
132
133                 This = wxDC()
134                 Pt1 = {X::integer(), Y::integer()}
135                 Pt2 = {X::integer(), Y::integer()}
136                 Centre = {X::integer(), Y::integer()}
137
138              See external documentation.
139
140       drawBitmap(This, Bmp, Pt) -> ok
141
142              Types:
143
144                 This = wxDC()
145                 Bmp = wxBitmap:wxBitmap()
146                 Pt = {X::integer(), Y::integer()}
147
148              Equivalent to drawBitmap(This, Bmp, Pt, []).
149
150       drawBitmap(This, Bmp, Pt, Options::[Option]) -> ok
151
152              Types:
153
154                 This = wxDC()
155                 Bmp = wxBitmap:wxBitmap()
156                 Pt = {X::integer(), Y::integer()}
157                 Option = {useMask, boolean()}
158
159              See external documentation.
160
161       drawCheckMark(This, Rect) -> ok
162
163              Types:
164
165                 This = wxDC()
166                 Rect  =  {X::integer(),  Y::integer(), W::integer(), H::inte‐
167                 ger()}
168
169              See external documentation.
170
171       drawCircle(This, Pt, Radius) -> ok
172
173              Types:
174
175                 This = wxDC()
176                 Pt = {X::integer(), Y::integer()}
177                 Radius = integer()
178
179              See external documentation.
180
181       drawEllipse(This, Rect) -> ok
182
183              Types:
184
185                 This = wxDC()
186                 Rect = {X::integer(),  Y::integer(),  W::integer(),  H::inte‐
187                 ger()}
188
189              See external documentation.
190
191       drawEllipse(This, Pt, Sz) -> ok
192
193              Types:
194
195                 This = wxDC()
196                 Pt = {X::integer(), Y::integer()}
197                 Sz = {W::integer(), H::integer()}
198
199              See external documentation.
200
201       drawEllipticArc(This, Pt, Sz, Sa, Ea) -> ok
202
203              Types:
204
205                 This = wxDC()
206                 Pt = {X::integer(), Y::integer()}
207                 Sz = {W::integer(), H::integer()}
208                 Sa = number()
209                 Ea = number()
210
211              See external documentation.
212
213       drawIcon(This, Icon, Pt) -> ok
214
215              Types:
216
217                 This = wxDC()
218                 Icon = wxIcon:wxIcon()
219                 Pt = {X::integer(), Y::integer()}
220
221              See external documentation.
222
223       drawLabel(This, Text, Rect) -> ok
224
225              Types:
226
227                 This = wxDC()
228                 Text = unicode:chardata()
229                 Rect  =  {X::integer(),  Y::integer(), W::integer(), H::inte‐
230                 ger()}
231
232              Equivalent to drawLabel(This, Text, Rect, []).
233
234       drawLabel(This, Text, Rect, Options::[Option]) -> ok
235
236              Types:
237
238                 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
244              See external documentation.
245
246       drawLine(This, Pt1, Pt2) -> ok
247
248              Types:
249
250                 This = wxDC()
251                 Pt1 = {X::integer(), Y::integer()}
252                 Pt2 = {X::integer(), Y::integer()}
253
254              See external documentation.
255
256       drawLines(This, Points) -> ok
257
258              Types:
259
260                 This = wxDC()
261                 Points = [{X::integer(), Y::integer()}]
262
263              Equivalent to drawLines(This, Points, []).
264
265       drawLines(This, Points, Options::[Option]) -> ok
266
267              Types:
268
269                 This = wxDC()
270                 Points = [{X::integer(), Y::integer()}]
271                 Option = {xoffset, integer()} | {yoffset, integer()}
272
273              See external documentation.
274
275       drawPolygon(This, Points) -> ok
276
277              Types:
278
279                 This = wxDC()
280                 Points = [{X::integer(), Y::integer()}]
281
282              Equivalent to drawPolygon(This, Points, []).
283
284       drawPolygon(This, Points, Options::[Option]) -> ok
285
286              Types:
287
288                 This = wxDC()
289                 Points = [{X::integer(), Y::integer()}]
290                 Option = {xoffset, integer()} | {yoffset, integer()} | {fill‐
291                 Style, wx:wx_enum()}
292
293              See external documentation.
294              FillStyle = integer
295
296       drawPoint(This, Pt) -> ok
297
298              Types:
299
300                 This = wxDC()
301                 Pt = {X::integer(), Y::integer()}
302
303              See external documentation.
304
305       drawRectangle(This, Rect) -> ok
306
307              Types:
308
309                 This = wxDC()
310                 Rect = {X::integer(),  Y::integer(),  W::integer(),  H::inte‐
311                 ger()}
312
313              See external documentation.
314
315       drawRectangle(This, Pt, Sz) -> ok
316
317              Types:
318
319                 This = wxDC()
320                 Pt = {X::integer(), Y::integer()}
321                 Sz = {W::integer(), H::integer()}
322
323              See external documentation.
324
325       drawRotatedText(This, Text, Pt, Angle) -> ok
326
327              Types:
328
329                 This = wxDC()
330                 Text = unicode:chardata()
331                 Pt = {X::integer(), Y::integer()}
332                 Angle = number()
333
334              See external documentation.
335
336       drawRoundedRectangle(This, R, Radius) -> ok
337
338              Types:
339
340                 This = wxDC()
341                 R = {X::integer(), Y::integer(), W::integer(), H::integer()}
342                 Radius = number()
343
344              See external documentation.
345
346       drawRoundedRectangle(This, Pt, Sz, Radius) -> ok
347
348              Types:
349
350                 This = wxDC()
351                 Pt = {X::integer(), Y::integer()}
352                 Sz = {W::integer(), H::integer()}
353                 Radius = number()
354
355              See external documentation.
356
357       drawText(This, Text, Pt) -> ok
358
359              Types:
360
361                 This = wxDC()
362                 Text = unicode:chardata()
363                 Pt = {X::integer(), Y::integer()}
364
365              See external documentation.
366
367       endDoc(This) -> ok
368
369              Types:
370
371                 This = wxDC()
372
373              See external documentation.
374
375       endPage(This) -> ok
376
377              Types:
378
379                 This = wxDC()
380
381              See external documentation.
382
383       floodFill(This, Pt, Col) -> boolean()
384
385              Types:
386
387                 This = wxDC()
388                 Pt = {X::integer(), Y::integer()}
389                 Col = wx:wx_colour()
390
391              Equivalent to floodFill(This, Pt, Col, []).
392
393       floodFill(This, Pt, Col, Options::[Option]) -> boolean()
394
395              Types:
396
397                 This = wxDC()
398                 Pt = {X::integer(), Y::integer()}
399                 Col = wx:wx_colour()
400                 Option = {style, wx:wx_enum()}
401
402              See external documentation.
403              Style = integer
404
405       getBackground(This) -> wxBrush:wxBrush()
406
407              Types:
408
409                 This = wxDC()
410
411              See external documentation.
412
413       getBackgroundMode(This) -> integer()
414
415              Types:
416
417                 This = wxDC()
418
419              See external documentation.
420
421       getBrush(This) -> wxBrush:wxBrush()
422
423              Types:
424
425                 This = wxDC()
426
427              See external documentation.
428
429       getCharHeight(This) -> integer()
430
431              Types:
432
433                 This = wxDC()
434
435              See external documentation.
436
437       getCharWidth(This) -> integer()
438
439              Types:
440
441                 This = wxDC()
442
443              See external documentation.
444
445       getClippingBox(This) -> Result
446
447              Types:
448
449                 Result  = {X::integer(), Y::integer(), W::integer(), H::inte‐
450                 ger()}
451                 This = wxDC()
452
453              See external documentation.
454
455       getFont(This) -> wxFont:wxFont()
456
457              Types:
458
459                 This = wxDC()
460
461              See external documentation.
462
463       getLayoutDirection(This) -> wx:wx_enum()
464
465              Types:
466
467                 This = wxDC()
468
469              See external documentation.
470              Res  =  ?wxLayout_Default  |  ?wxLayout_LeftToRight  |   ?wxLay‐
471              out_RightToLeft
472
473       getLogicalFunction(This) -> integer()
474
475              Types:
476
477                 This = wxDC()
478
479              See external documentation.
480
481       getMapMode(This) -> integer()
482
483              Types:
484
485                 This = wxDC()
486
487              See external documentation.
488
489       getMultiLineTextExtent(This, String) -> {W::integer(), H::integer()}
490
491              Types:
492
493                 This = wxDC()
494                 String = unicode:chardata()
495
496              See external documentation.
497
498       getMultiLineTextExtent(This,      String,     Options::[Option])     ->
499       {Width::integer(), Height::integer(), HeightLine::integer()}
500
501              Types:
502
503                 This = wxDC()
504                 String = unicode:chardata()
505                 Option = {font, wxFont:wxFont()}
506
507              See external documentation.
508
509       getPartialTextExtents(This, Text) -> Result
510
511              Types:
512
513                 Result = {Res::boolean(), Widths::[integer()]}
514                 This = wxDC()
515                 Text = unicode:chardata()
516
517              See external documentation.
518
519       getPen(This) -> wxPen:wxPen()
520
521              Types:
522
523                 This = wxDC()
524
525              See external documentation.
526
527       getPixel(This, Pt) -> Result
528
529              Types:
530
531                 Result = {Res::boolean(), Col::wx:wx_colour4()}
532                 This = wxDC()
533                 Pt = {X::integer(), Y::integer()}
534
535              See external documentation.
536
537       getPPI(This) -> {W::integer(), H::integer()}
538
539              Types:
540
541                 This = wxDC()
542
543              See external documentation.
544
545       getSize(This) -> {W::integer(), H::integer()}
546
547              Types:
548
549                 This = wxDC()
550
551              See external documentation.
552
553       getSizeMM(This) -> {W::integer(), H::integer()}
554
555              Types:
556
557                 This = wxDC()
558
559              See external documentation.
560
561       getTextBackground(This) -> wx:wx_colour4()
562
563              Types:
564
565                 This = wxDC()
566
567              See external documentation.
568
569       getTextExtent(This, String) -> {W::integer(), H::integer()}
570
571              Types:
572
573                 This = wxDC()
574                 String = unicode:chardata()
575
576              See external documentation.
577
578       getTextExtent(This, String, Options::[Option]) -> Result
579
580              Types:
581
582                 Result  =  {X::integer(),  Y::integer(),  Descent::integer(),
583                 ExternalLeading::integer()}
584                 This = wxDC()
585                 String = unicode:chardata()
586                 Option = {theFont, wxFont:wxFont()}
587
588              See external documentation.
589
590       getTextForeground(This) -> wx:wx_colour4()
591
592              Types:
593
594                 This = wxDC()
595
596              See external documentation.
597
598       getUserScale(This) -> {X::number(), Y::number()}
599
600              Types:
601
602                 This = wxDC()
603
604              See external documentation.
605
606       gradientFillConcentric(This, Rect, InitialColour, DestColour) -> ok
607
608              Types:
609
610                 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
616              See external documentation.
617
618       gradientFillConcentric(This, Rect, InitialColour,  DestColour,  Circle‐
619       Center) -> ok
620
621              Types:
622
623                 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
630              See external documentation.
631
632       gradientFillLinear(This, Rect, InitialColour, DestColour) -> ok
633
634              Types:
635
636                 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
642              Equivalent   to  gradientFillLinear(This,  Rect,  InitialColour,
643              DestColour, []).
644
645       gradientFillLinear(This,     Rect,      InitialColour,      DestColour,
646       Options::[Option]) -> ok
647
648              Types:
649
650                 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
657              See external documentation.
658              NDirection = ?wxLEFT | ?wxRIGHT | ?wxUP |  ?wxDOWN  |  ?wxTOP  |
659              ?wxBOTTOM | ?wxNORTH | ?wxSOUTH | ?wxWEST | ?wxEAST | ?wxALL
660
661       logicalToDeviceX(This, X) -> integer()
662
663              Types:
664
665                 This = wxDC()
666                 X = integer()
667
668              See external documentation.
669
670       logicalToDeviceXRel(This, X) -> integer()
671
672              Types:
673
674                 This = wxDC()
675                 X = integer()
676
677              See external documentation.
678
679       logicalToDeviceY(This, Y) -> integer()
680
681              Types:
682
683                 This = wxDC()
684                 Y = integer()
685
686              See external documentation.
687
688       logicalToDeviceYRel(This, Y) -> integer()
689
690              Types:
691
692                 This = wxDC()
693                 Y = integer()
694
695              See external documentation.
696
697       maxX(This) -> integer()
698
699              Types:
700
701                 This = wxDC()
702
703              See external documentation.
704
705       maxY(This) -> integer()
706
707              Types:
708
709                 This = wxDC()
710
711              See external documentation.
712
713       minX(This) -> integer()
714
715              Types:
716
717                 This = wxDC()
718
719              See external documentation.
720
721       minY(This) -> integer()
722
723              Types:
724
725                 This = wxDC()
726
727              See external documentation.
728
729       isOk(This) -> boolean()
730
731              Types:
732
733                 This = wxDC()
734
735              See external documentation.
736
737       resetBoundingBox(This) -> ok
738
739              Types:
740
741                 This = wxDC()
742
743              See external documentation.
744
745       setAxisOrientation(This, XLeftRight, YBottomUp) -> ok
746
747              Types:
748
749                 This = wxDC()
750                 XLeftRight = boolean()
751                 YBottomUp = boolean()
752
753              See external documentation.
754
755       setBackground(This, Brush) -> ok
756
757              Types:
758
759                 This = wxDC()
760                 Brush = wxBrush:wxBrush()
761
762              See external documentation.
763
764       setBackgroundMode(This, Mode) -> ok
765
766              Types:
767
768                 This = wxDC()
769                 Mode = integer()
770
771              See external documentation.
772
773       setBrush(This, Brush) -> ok
774
775              Types:
776
777                 This = wxDC()
778                 Brush = wxBrush:wxBrush()
779
780              See external documentation.
781
782       setClippingRegion(This, Region) -> ok
783
784              Types:
785
786                 This = wxDC()
787                 Region = wxRegion:wxRegion()
788
789              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
795
796       setClippingRegion(This, Pt, Sz) -> ok
797
798              Types:
799
800                 This = wxDC()
801                 Pt = {X::integer(), Y::integer()}
802                 Sz = {W::integer(), H::integer()}
803
804              See external documentation.
805
806       setDeviceOrigin(This, X, Y) -> ok
807
808              Types:
809
810                 This = wxDC()
811                 X = integer()
812                 Y = integer()
813
814              See external documentation.
815
816       setFont(This, Font) -> ok
817
818              Types:
819
820                 This = wxDC()
821                 Font = wxFont:wxFont()
822
823              See external documentation.
824
825       setLayoutDirection(This, Dir) -> ok
826
827              Types:
828
829                 This = wxDC()
830                 Dir = wx:wx_enum()
831
832              See external documentation.
833              Dir  =  ?wxLayout_Default  |  ?wxLayout_LeftToRight  |   ?wxLay‐
834              out_RightToLeft
835
836       setLogicalFunction(This, Function) -> ok
837
838              Types:
839
840                 This = wxDC()
841                 Function = wx:wx_enum()
842
843              See external documentation.
844              Function = integer
845
846       setMapMode(This, Mode) -> ok
847
848              Types:
849
850                 This = wxDC()
851                 Mode = wx:wx_enum()
852
853              See external documentation.
854              Mode = integer
855
856       setPalette(This, Palette) -> ok
857
858              Types:
859
860                 This = wxDC()
861                 Palette = wxPalette:wxPalette()
862
863              See external documentation.
864
865       setPen(This, Pen) -> ok
866
867              Types:
868
869                 This = wxDC()
870                 Pen = wxPen:wxPen()
871
872              See external documentation.
873
874       setTextBackground(This, Colour) -> ok
875
876              Types:
877
878                 This = wxDC()
879                 Colour = wx:wx_colour()
880
881              See external documentation.
882
883       setTextForeground(This, Colour) -> ok
884
885              Types:
886
887                 This = wxDC()
888                 Colour = wx:wx_colour()
889
890              See external documentation.
891
892       setUserScale(This, X, Y) -> ok
893
894              Types:
895
896                 This = wxDC()
897                 X = number()
898                 Y = number()
899
900              See external documentation.
901
902       startDoc(This, Message) -> boolean()
903
904              Types:
905
906                 This = wxDC()
907                 Message = unicode:chardata()
908
909              See external documentation.
910
911       startPage(This) -> ok
912
913              Types:
914
915                 This = wxDC()
916
917              See external documentation.
918

AUTHORS

920       <>
921
922
923
924                                    wx 1.9                             wxDC(3)
Impressum