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

NAME

6       wxDisplay - Functions for wxDisplay class
7

DESCRIPTION

9       Determines the sizes and locations of displays connected to the system.
10
11       wxWidgets docs: wxDisplay
12

DATA TYPES

14       wxDisplay() = wx:wx_object()
15

EXPORTS

17       new() -> wxDisplay()
18
19              Default  constructor  creating wxDisplay object representing the
20              primary display.
21
22       new(Index) -> wxDisplay()
23
24       new(Window) -> wxDisplay()
25
26              Types:
27
28                 Window = wxWindow:wxWindow()
29
30              Constructor creating the  display  object  associated  with  the
31              given window.
32
33              This  is the most convenient way of finding the display on which
34              the given window is shown while falling back to the default dis‐
35              play if it is not shown at all or positioned outside of any dis‐
36              play.
37
38              See: getFromWindow/1
39
40              Since: 3.1.2
41
42       destroy(This :: wxDisplay()) -> ok
43
44              Destructor.
45
46       isOk(This) -> boolean()
47
48              Types:
49
50                 This = wxDisplay()
51
52              Returns true if the object was initialized successfully.
53
54       getClientArea(This) ->
55                        {X :: integer(),
56                         Y :: integer(),
57                         W :: integer(),
58                         H :: integer()}
59
60              Types:
61
62                 This = wxDisplay()
63
64              Returns the client area of the display.
65
66              The client area is the part of the  display  available  for  the
67              normal (non full screen) windows, usually it is the same as get‐
68              Geometry/1 but it could be less if there is a taskbar (or equiv‐
69              alent) on this display.
70
71       getGeometry(This) ->
72                      {X :: integer(),
73                       Y :: integer(),
74                       W :: integer(),
75                       H :: integer()}
76
77              Types:
78
79                 This = wxDisplay()
80
81              Returns  the  bounding  rectangle of the display whose index was
82              passed to the constructor.
83
84              See: getClientArea/1, wx_misc:displaySize/0
85
86       getName(This) -> unicode:charlist()
87
88              Types:
89
90                 This = wxDisplay()
91
92              Returns the display's name.
93
94              The returned value is currently an empty string under all  plat‐
95              forms except MSW.
96
97       isPrimary(This) -> boolean()
98
99              Types:
100
101                 This = wxDisplay()
102
103              Returns true if the display is the primary display.
104
105              The primary display is the one whose index is 0.
106
107       getCount() -> integer()
108
109              Returns the number of connected displays.
110
111       getFromPoint(Pt) -> integer()
112
113              Types:
114
115                 Pt = {X :: integer(), Y :: integer()}
116
117              Returns  the index of the display on which the given point lies,
118              or wxNOT_FOUND if the point is not on any connected display.
119
120       getFromWindow(Win) -> integer()
121
122              Types:
123
124                 Win = wxWindow:wxWindow()
125
126              Returns the index of the display on which the given window lies.
127
128              If the window is on more than one display it  gets  the  display
129              that overlaps the window the most.
130
131              Returns  wxNOT_FOUND  if the window is not on any connected dis‐
132              play.
133
134       getPPI(This) -> {W :: integer(), H :: integer()}
135
136              Types:
137
138                 This = wxDisplay()
139
140              Returns display resolution in pixels per inch.
141
142              Horizontal and vertical resolution are returned in x and y  com‐
143              ponents of the {Width,Height} object respectively.
144
145              If the resolution information is not available, returns.
146
147              Since: 3.1.2
148
149
150
151wxWidgets team.                     wx 2.1                        wxDisplay(3)