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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.calendar
.. highlight:: python
.. _wx.lib.calendar.CalDraw:
==========================================================================================================================================
|phoenix_title| **wx.lib.calendar.CalDraw**
==========================================================================================================================================
A class to draw a calendar.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>CalDraw</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.calendar.CalDraw_inheritance.png" alt="Inheritance diagram of CalDraw" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.calendar.CalDraw.html" title="wx.lib.calendar.CalDraw" alt="" coords="5,5,176,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.calendar.CalDraw.__init__` Default class constructor
:meth:`~wx.lib.calendar.CalDraw.AddSelect` Add a selection of days.
:meth:`~wx.lib.calendar.CalDraw.Center` Calculate the dimensions in the center of the drawing area.
:meth:`~wx.lib.calendar.CalDraw.DefParms` Setup the default parameters.
:meth:`~wx.lib.calendar.CalDraw.DrawBorder` Draw a border around the outside of the main display rectangle.
:meth:`~wx.lib.calendar.CalDraw.DrawCal` Draw the calendar.
:meth:`~wx.lib.calendar.CalDraw.DrawDayText` Draw the day text.
:meth:`~wx.lib.calendar.CalDraw.DrawFocusIndicator` Draw the focus indicator
:meth:`~wx.lib.calendar.CalDraw.DrawGrid` Calculate and draw the grid lines.
:meth:`~wx.lib.calendar.CalDraw.DrawMonth` Draw the month and year titles.
:meth:`~wx.lib.calendar.CalDraw.DrawNum` Draw the day numbers
:meth:`~wx.lib.calendar.CalDraw.DrawNumVal` Draw the numeric values.
:meth:`~wx.lib.calendar.CalDraw.DrawSel` Highlight selected days.
:meth:`~wx.lib.calendar.CalDraw.DrawWeek` Draw the week days.
:meth:`~wx.lib.calendar.CalDraw.GetCal` Get the calendar days.
:meth:`~wx.lib.calendar.CalDraw.GetColor` Get a color.
:meth:`~wx.lib.calendar.CalDraw.GetOffset` Get the offset position.
:meth:`~wx.lib.calendar.CalDraw.GetRect` Get the display rectange list of the day grid.
:meth:`~wx.lib.calendar.CalDraw.InitScale` Set the default scale values.
:meth:`~wx.lib.calendar.CalDraw.InitValues` Default dimensions of various elements of the calendar.
:meth:`~wx.lib.calendar.CalDraw.SetCal` Calculate the calendar days and offset position.
:meth:`~wx.lib.calendar.CalDraw.SetColor` Set a color.
:meth:`~wx.lib.calendar.CalDraw.SetMarg` Set the margins.
:meth:`~wx.lib.calendar.CalDraw.SetPos` Set the position.
:meth:`~wx.lib.calendar.CalDraw.SetSize` Set the size.
:meth:`~wx.lib.calendar.CalDraw.SetWeekColor` Set the font and background color of the week title.
:meth:`~wx.lib.calendar.CalDraw.SetWeekEnd` Set the weekend backgrounds.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: CalDraw
A class to draw a calendar.
.. method:: __init__(self, parent)
Default class constructor
:param wx.Window `parent`: parent window.
.. method:: AddSelect(self, list, cfont=None, cbackgrd=None)
Add a selection of days.
:param `list`: a list of days to select
:param `cfont`: the font color to use
:param `cbackgrd`: the background color to use
.. method:: Center(self)
Calculate the dimensions in the center of the drawing area.
.. method:: DefParms(self)
Setup the default parameters.
.. method:: DrawBorder(self, DC, transparent=False)
Draw a border around the outside of the main display rectangle.
:param `DC`: the :class:`wx.DC` to use
:param `transparent`: use a transparent brush, default is ``False``.
.. method:: DrawCal(self, DC, sel_lst=[])
Draw the calendar.
:param `DC`: the :class:`wx.DC` to use to draw upon.
:param `sel_list`: a list of days to override the weekend highlight.
.. method:: DrawDayText(self, DC, key)
Draw the day text.
:param `DC`: the :class:`wx.DC` to use.
:param `key`: the day to draw
.. method:: DrawFocusIndicator(self, DC)
Draw the focus indicator
:param `DC`: the :class:`wx.DC` to use
.. method:: DrawGrid(self, DC)
Calculate and draw the grid lines.
:param `DC`: the :class:`wx.DC` to use
.. method:: DrawMonth(self, DC)
Draw the month and year titles.
:param `DC`: the :class:`wx.DC` to use.
.. method:: DrawNum(self, DC)
Draw the day numbers
:param `DC`: the :class:`wx.DC` to use.
.. method:: DrawNumVal(self)
Draw the numeric values.
.. method:: DrawSel(self, DC)
Highlight selected days.
:param `DC`: the :class:`wx.DC` to use
.. method:: DrawWeek(self, DC)
Draw the week days.
:param `DC`: the :class:`wx.DC` to use.
.. method:: GetCal(self)
Get the calendar days.
.. method:: GetColor(self, name)
Get a color.
:param `name`: one of the defined color names.
.. method:: GetOffset(self)
Get the offset position.
.. method:: GetRect(self)
Get the display rectange list of the day grid.
.. method:: InitScale(self)
Set the default scale values.
.. method:: InitValues(self)
Default dimensions of various elements of the calendar.
.. method:: SetCal(self, year, month)
Calculate the calendar days and offset position.
:param int `year`: the year to calculate.
:param int `month`: the month to calculate.
.. method:: SetColor(self, name, value)
Set a color.
:param `name`: the name to assign the color too.
:param `value`: the color to use, see :class:`wx.Colour`
.. method:: SetMarg(self, xmarg, ymarg)
Set the margins.
:param `xmarg`: the x margin
:param `ymarg`: the y margin, also used for the end margin
.. method:: SetPos(self, xpos, ypos)
Set the position.
:param int `xpos`: the x position
:param int `ypos`: the y position
.. method:: SetSize(self, size)
Set the size.
:param `size`: a tuple/list with width and height
.. method:: SetWeekColor(self, font_color, week_color)
Set the font and background color of the week title.
:param `font_color`: the font color, a value as is accepted by :class:`wx.Colour`
:param `week_color`: the week color, a value as is accepted by :class:`wx.Colour`
.. method:: SetWeekEnd(self, font_color=None, backgrd=None)
Set the weekend backgrounds.
:param `font_color`: the font color to use, if ``None`` the default is used.
:param `backgrd`: the background color to use, if ``None`` the default is used.
|
