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

NAME

6       wxCalendarDateAttr - Functions for wxCalendarDateAttr class
7

DESCRIPTION

9       wxCalendarDateAttr  is a custom attributes for a calendar date. The ob‐
10       jects of this class are used with wxCalendarCtrl.
11
12       See: wxCalendarCtrl
13
14       wxWidgets docs: wxCalendarDateAttr
15

DATA TYPES

17       wxCalendarDateAttr() = wx:wx_object()
18

EXPORTS

20       new() -> wxCalendarDateAttr()
21
22       new(Border) -> wxCalendarDateAttr()
23
24       new(Border :: [Option]) -> wxCalendarDateAttr()
25
26              Types:
27
28                 Option =
29                     {colText, wx:wx_colour()} |
30                     {colBack, wx:wx_colour()} |
31                     {colBorder, wx:wx_colour()} |
32                     {font, wxFont:wxFont()} |
33                     {border, wx:wx_enum()}
34
35              Constructor for specifying all wxCalendarDateAttr properties.
36
37       new(Border, Options :: [Option]) -> wxCalendarDateAttr()
38
39              Types:
40
41                 Border = wx:wx_enum()
42                 Option = {colBorder, wx:wx_colour()}
43
44              Constructor using default properties except the given border.
45
46       setTextColour(This, ColText) -> ok
47
48              Types:
49
50                 This = wxCalendarDateAttr()
51                 ColText = wx:wx_colour()
52
53              Sets the text (foreground) colour to use.
54
55       setBackgroundColour(This, ColBack) -> ok
56
57              Types:
58
59                 This = wxCalendarDateAttr()
60                 ColBack = wx:wx_colour()
61
62              Sets the text background colour to use.
63
64       setBorderColour(This, Col) -> ok
65
66              Types:
67
68                 This = wxCalendarDateAttr()
69                 Col = wx:wx_colour()
70
71              Sets the border colour to use.
72
73       setFont(This, Font) -> ok
74
75              Types:
76
77                 This = wxCalendarDateAttr()
78                 Font = wxFont:wxFont()
79
80              Sets the font to use.
81
82       setBorder(This, Border) -> ok
83
84              Types:
85
86                 This = wxCalendarDateAttr()
87                 Border = wx:wx_enum()
88
89              Sets the border to use.
90
91       setHoliday(This, Holiday) -> ok
92
93              Types:
94
95                 This = wxCalendarDateAttr()
96                 Holiday = boolean()
97
98              If holiday is true, this calendar day will  be  displayed  as  a
99              holiday.
100
101       hasTextColour(This) -> boolean()
102
103              Types:
104
105                 This = wxCalendarDateAttr()
106
107              Returns true if a non-default text foreground colour is set.
108
109       hasBackgroundColour(This) -> boolean()
110
111              Types:
112
113                 This = wxCalendarDateAttr()
114
115              Returns true if a non-default text background colour is set.
116
117       hasBorderColour(This) -> boolean()
118
119              Types:
120
121                 This = wxCalendarDateAttr()
122
123              Returns true if a non-default border colour is set.
124
125       hasFont(This) -> boolean()
126
127              Types:
128
129                 This = wxCalendarDateAttr()
130
131              Returns true if a non-default font is set.
132
133       hasBorder(This) -> boolean()
134
135              Types:
136
137                 This = wxCalendarDateAttr()
138
139              Returns true if a non-default (i.e. any) border is set.
140
141       isHoliday(This) -> boolean()
142
143              Types:
144
145                 This = wxCalendarDateAttr()
146
147              Returns true if this calendar day is displayed as a holiday.
148
149       getTextColour(This) -> wx:wx_colour4()
150
151              Types:
152
153                 This = wxCalendarDateAttr()
154
155              Returns the text colour set for the calendar date.
156
157       getBackgroundColour(This) -> wx:wx_colour4()
158
159              Types:
160
161                 This = wxCalendarDateAttr()
162
163              Returns the background colour set for the calendar date.
164
165       getBorderColour(This) -> wx:wx_colour4()
166
167              Types:
168
169                 This = wxCalendarDateAttr()
170
171              Returns the border colour set for the calendar date.
172
173       getFont(This) -> wxFont:wxFont()
174
175              Types:
176
177                 This = wxCalendarDateAttr()
178
179              Returns the font set for the calendar date.
180
181       getBorder(This) -> wx:wx_enum()
182
183              Types:
184
185                 This = wxCalendarDateAttr()
186
187              Returns the border set for the calendar date.
188
189       destroy(This :: wxCalendarDateAttr()) -> ok
190
191              Destroys the object.
192
193
194
195wxWidgets team.                     wx 2.1               wxCalendarDateAttr(3)