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

NAME

6       wxCaret - Functions for wxCaret class
7

DESCRIPTION

9       A  caret is a blinking cursor showing the position where the typed text
10       will appear. Text controls usually have their  own  caret  but  wxCaret
11       provides a way to use a caret in other windows.
12
13       Currently,  the  caret appears as a rectangle of the given size. In the
14       future, it will be possible to specify a bitmap  to  be  used  for  the
15       caret shape.
16
17       A caret is always associated with a window and the current caret can be
18       retrieved using wxWindow:getCaret/1. The same caret can't be reused  in
19       two different windows.
20
21       wxWidgets docs: wxCaret
22

DATA TYPES

24       wxCaret() = wx:wx_object()
25

EXPORTS

27       new(Window, Size) -> wxCaret()
28
29              Types:
30
31                 Window = wxWindow:wxWindow()
32                 Size = {W :: integer(), H :: integer()}
33
34       new(Window, Width, Height) -> wxCaret()
35
36              Types:
37
38                 Window = wxWindow:wxWindow()
39                 Width = Height = integer()
40
41              Creates  a  caret with the given size (in pixels) and associates
42              it with the window.
43
44       create(This, Window, Size) -> boolean()
45
46              Types:
47
48                 This = wxCaret()
49                 Window = wxWindow:wxWindow()
50                 Size = {W :: integer(), H :: integer()}
51
52       create(This, Window, Width, Height) -> boolean()
53
54              Types:
55
56                 This = wxCaret()
57                 Window = wxWindow:wxWindow()
58                 Width = Height = integer()
59
60              Creates a caret with the given size (in pixels)  and  associates
61              it with the window (same as the equivalent constructors).
62
63       getBlinkTime() -> integer()
64
65              Returns  the blink time which is measured in milliseconds and is
66              the time elapsed between 2 inversions of the caret  (blink  time
67              of  the  caret  is the same for all carets, so this functions is
68              static).
69
70       getPosition(This) -> {X :: integer(), Y :: integer()}
71
72              Types:
73
74                 This = wxCaret()
75
76       getSize(This) -> {W :: integer(), H :: integer()}
77
78              Types:
79
80                 This = wxCaret()
81
82       getWindow(This) -> wxWindow:wxWindow()
83
84              Types:
85
86                 This = wxCaret()
87
88              Get the window the caret is associated with.
89
90       hide(This) -> ok
91
92              Types:
93
94                 This = wxCaret()
95
96              Hides the caret, same as Show(false).
97
98       isOk(This) -> boolean()
99
100              Types:
101
102                 This = wxCaret()
103
104              Returns true if the caret was created successfully.
105
106       isVisible(This) -> boolean()
107
108              Types:
109
110                 This = wxCaret()
111
112              Returns true if the caret is visible and false if it  is  perma‐
113              nently  hidden  (if  it  is blinking and not shown currently but
114              will be after the next blink, this method still returns true).
115
116       move(This, Pt) -> ok
117
118              Types:
119
120                 This = wxCaret()
121                 Pt = {X :: integer(), Y :: integer()}
122
123       move(This, X, Y) -> ok
124
125              Types:
126
127                 This = wxCaret()
128                 X = Y = integer()
129
130              Move the caret to given position (in logical coordinates).
131
132       setBlinkTime(Milliseconds) -> ok
133
134              Types:
135
136                 Milliseconds = integer()
137
138              Sets the blink time for all the carets.
139
140              Warning: Under Windows, this function will change the blink time
141              for  all  carets permanently (until the next time it is called),
142              even for carets in other applications.
143
144              See: getBlinkTime/0
145
146       setSize(This, Size) -> ok
147
148              Types:
149
150                 This = wxCaret()
151                 Size = {W :: integer(), H :: integer()}
152
153       setSize(This, Width, Height) -> ok
154
155              Types:
156
157                 This = wxCaret()
158                 Width = Height = integer()
159
160              Changes the size of the caret.
161
162       show(This) -> ok
163
164              Types:
165
166                 This = wxCaret()
167
168       show(This, Options :: [Option]) -> ok
169
170              Types:
171
172                 This = wxCaret()
173                 Option = {show, boolean()}
174
175              Shows or hides the caret.
176
177              Notice that if the caret was hidden N times, it must be shown  N
178              times as well to reappear on the screen.
179
180       destroy(This :: wxCaret()) -> ok
181
182              Destroys the object.
183
184
185
186wxWidgets team.                    wx 2.2.1                         wxCaret(3)