summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxCalendarDateAttr.xml
blob: a978d35ee37e6ad0009ff0ebdfd0e7568c9cc073 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxCalendarDateAttr</title>
</header>
<module>wxCalendarDateAttr</module>
<modulesummary>Functions for wxCalendarDateAttr class</modulesummary>
<description><p><seeerl marker="wxCalendarDateAttr"><c>wxCalendarDateAttr</c></seeerl> is a custom attributes for a calendar date. The objects of this class are used with <seeerl marker="wxCalendarCtrl"><c>wxCalendarCtrl</c></seeerl>.
      </p><p>See: <seeerl marker="wxCalendarCtrl"><c>wxCalendarCtrl</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_calendar_date_attr.html">wxCalendarDateAttr</url></p>
  </description>
<datatypes><datatype><name name="wxCalendarDateAttr"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>See: <c>new/1</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
  
    <name name="new" arity="1" clause_i="2" since=""/>
    <fsummary>Constructor for specifying all <c>wxCalendarDateAttr</c> properties. </fsummary>
    <desc><p>Constructor for specifying all <seeerl marker="wxCalendarDateAttr"><c>wxCalendarDateAttr</c></seeerl> properties. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>Constructor using default properties except the given border. </fsummary>
    <desc><p>Constructor using default properties except the given border. 
      </p></desc>
  </func>
  
  <func>
    <name name="setTextColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the text (foreground) colour to use. </fsummary>
    <desc><p>Sets the text (foreground) colour to use. 
      </p></desc>
  </func>
  
  <func>
    <name name="setBackgroundColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the text background colour to use. </fsummary>
    <desc><p>Sets the text background colour to use. 
      </p></desc>
  </func>
  
  <func>
    <name name="setBorderColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the border colour to use. </fsummary>
    <desc><p>Sets the border colour to use. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFont" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the font to use. </fsummary>
    <desc><p>Sets the font to use. 
      </p></desc>
  </func>
  
  <func>
    <name name="setBorder" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the border to use. </fsummary>
    <desc><p>Sets the border to use. 
      </p></desc>
  </func>
  
  <func>
    <name name="setHoliday" arity="2" clause_i="1" since=""/>
    <fsummary>If <c>holiday</c> is true, this calendar day will be displayed as a holiday. </fsummary>
    <desc><p>If <c>holiday</c> is true, this calendar day will be displayed as a holiday. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasTextColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if a non-default text foreground colour is set. </fsummary>
    <desc><p>Returns true if a non-default text foreground colour is set. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasBackgroundColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if a non-default text background colour is set. </fsummary>
    <desc><p>Returns true if a non-default text background colour is set. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasBorderColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if a non-default border colour is set. </fsummary>
    <desc><p>Returns true if a non-default border colour is set. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasFont" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if a non-default font is set. </fsummary>
    <desc><p>Returns true if a non-default font is set. 
      </p></desc>
  </func>
  
  <func>
    <name name="hasBorder" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if a non-default (i.e. any) border is set. </fsummary>
    <desc><p>Returns true if a non-default (i.e. any) border is set. 
      </p></desc>
  </func>
  
  <func>
    <name name="isHoliday" arity="1" clause_i="1" since=""/>
    <fsummary>Returns true if this calendar day is displayed as a holiday. </fsummary>
    <desc><p>Returns true if this calendar day is displayed as a holiday. 
      </p></desc>
  </func>
  
  <func>
    <name name="getTextColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the text colour set for the calendar date. </fsummary>
    <desc><p>Returns the text colour set for the calendar date. 
      </p></desc>
  </func>
  
  <func>
    <name name="getBackgroundColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the background colour set for the calendar date. </fsummary>
    <desc><p>Returns the background colour set for the calendar date. 
      </p></desc>
  </func>
  
  <func>
    <name name="getBorderColour" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the border colour set for the calendar date. </fsummary>
    <desc><p>Returns the border colour set for the calendar date. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFont" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the font set for the calendar date. </fsummary>
    <desc><p>Returns the font set for the calendar date. 
      </p></desc>
  </func>
  
  <func>
    <name name="getBorder" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the border set for the calendar date. </fsummary>
    <desc><p>Returns the border set for the calendar date. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>