1 #----------------------------------------------------------------------------
3 # Purpose: Calendar display control
5 # Author: Lorne White (email: lorne.white@telusplanet.net)
10 # Licence: wxWindows license
11 #----------------------------------------------------------------------------
12 # 12/01/2003 - Jeff Grimmett (grimmtooth@softhome.net)
14 # o Updated for wx namespace
15 # o Tested with updated demo
16 # o Added new event type EVT_CALENDAR. The reason for this is that the original
17 # library used a hardcoded ID of 2100 for generating events. This makes it
18 # very difficult to fathom when trying to decode the code since there's no
19 # published API. Creating the new event binder might seem like overkill -
20 # after all, you might ask, why not just use a new event ID and be done with
21 # it? However, a consistent interface is very useful at times; also it makes
22 # it clear that we're not just hunting for mouse clicks -- we're hunting
23 # wabbit^H^H^H^H (sorry bout that) for calender-driven mouse clicks. So
24 # that's my sad story. Shoot me if you must :-)
25 # o There's still one deprecation warning buried in here somewhere, but I
26 # haven't been able to find it yet. It only occurs when displaying a
27 # print preview, and only the first time. It *could* be an error in the
30 # Here's the traceback:
32 # C:\Python\lib\site-packages\wx\core.py:949: DeprecationWarning:
33 # integer argument expected, got float
34 # newobj = _core.new_Rect(*args, **kwargs)
36 # 12/17/2003 - Jeff Grimmett (grimmtooth@softhome.net)
38 # o A few style-guide nips and tucks
39 # o Renamed wxCalendar to Calendar
40 # o Couple of bugfixes
47 CalDays
= [6, 0, 1, 2, 3, 4, 5]
48 AbrWeekday
= {6:"Sun", 0:"Mon", 1:"Tue", 2:"Wed", 3:"Thu", 4:"Fri", 5:"Sat"}
51 BusCalDays
= [0, 1, 2, 3, 4, 5, 6]
53 # Calendar click event - added 12/1/03 by jmg (see above)
54 wxEVT_COMMAND_PYCALENDAR_DAY_CLICKED
= wx
.NewEventType()
55 EVT_CALENDAR
= wx
.PyEventBinder(wxEVT_COMMAND_PYCALENDAR_DAY_CLICKED
, 1)
62 monthlist
.append(name
)
65 # calendar drawing routing
68 def __init__(self
, parent
):
72 self
.scale
= parent
.scale
79 self
.num_auto
= True # auto scale of the cal number day size
80 self
.num_size
= 12 # default size of calendar if no auto size
81 self
.max_num_size
= 12 # maximum size for calendar number
83 self
.num_align_horz
= wx
.ALIGN_CENTRE
# alignment of numbers
84 self
.num_align_vert
= wx
.ALIGN_CENTRE
85 self
.num_indent_horz
= 0 # points indent from position, used to offset if not centered
86 self
.num_indent_vert
= 0
88 self
.week_auto
= True # auto scale of week font text
90 self
.max_week_size
= 12
92 self
.grid_color
= 'BLACK' # grid and selection colors
93 self
.back_color
= 'WHITE'
94 self
.sel_color
= 'RED'
96 self
.high_color
= 'LIGHT BLUE'
97 self
.border_color
= 'BLACK'
98 self
.week_color
= 'LIGHT GREY'
100 self
.week_font_color
= 'BLACK' # font colors
101 self
.day_font_color
= 'BLACK'
104 self
.bold
= wx
.NORMAL
106 self
.hide_title
= False
107 self
.hide_grid
= False
108 self
.outer_border
= True
110 self
.title_offset
= 0
111 self
.cal_week_scale
= 0.7
112 self
.show_weekend
= False
113 self
.cal_type
= "NORMAL"
115 def SetWeekColor(self
, font_color
, week_color
): # set font and background color for week title
116 self
.week_font_color
= font_color
117 self
.week_color
= week_color
119 def SetSize(self
, size
):
120 self
.set_sizew
= size
[0]
121 self
.set_sizeh
= size
[1]
123 def InitValues(self
): # default dimensions of various elements of the calendar
126 self
.set_cy_st
= 0 # start position
129 self
.set_y_mrg
= 15 # start of vertical draw default
133 def SetPos(self
, xpos
, ypos
):
134 self
.set_cx_st
= xpos
135 self
.set_cy_st
= ypos
137 def SetMarg(self
, xmarg
, ymarg
):
138 self
.set_x_st
= xmarg
139 self
.set_y_st
= ymarg
140 self
.set_y_end
= ymarg
142 def InitScale(self
): # scale position values
143 self
.sizew
= self
.set_sizew
* self
.pwidth
144 self
.sizeh
= self
.set_sizeh
* self
.pheight
146 self
.cx_st
= self
.set_cx_st
* self
.pwidth
# draw start position
147 self
.cy_st
= self
.set_cy_st
* self
.pheight
149 self
.x_mrg
= self
.set_x_mrg
* self
.pwidth
# calendar draw margins
150 self
.y_mrg
= self
.set_y_mrg
* self
.pheight
151 self
.y_end
= self
.set_y_end
* self
.pheight
153 def DrawCal(self
, DC
, sel_lst
=[]):
159 if self
.hide_title
is False:
167 if self
.show_weekend
is True: # highlight weekend dates
170 self
.AddSelect(sel_lst
) # overrides the weekend highlight
172 self
.DrawSel() # highlighted days
176 def AddSelect(self
, list, cfont
=None, cbackgrd
= None):
178 cfont
= self
.sel_color
# font digit color
181 cbackgrd
= self
.high_color
# select background color
184 self
.cal_sel
[val
] = (cfont
, cbackgrd
)
186 # draw border around the outside of the main display rectangle
187 def DrawBorder(self
):
188 brush
= wx
.Brush(wx
.NamedColour(self
.back_color
), wx
.SOLID
)
189 self
.DC
.SetBrush(brush
)
190 self
.DC
.SetPen(wx
.Pen(wx
.NamedColour(self
.border_color
), 1))
192 if self
.outer_border
is True:
193 # full display window area
194 rect
= wx
.Rect(self
.cx_st
, self
.cy_st
, self
.sizew
, self
.sizeh
)
195 self
.DC
.DrawRectangleRect(rect
)
197 def DrawNumVal(self
):
200 # calculate the calendar days and offset position
202 def SetCal(self
, year
, month
):
203 self
.InitValues() # reset initial values
209 t
= Date(year
, month
, day
)
210 dow
= self
.dow
= t
.day_of_week
# start day in month
211 dim
= self
.dim
= t
.days_in_month
# number of days in month
213 if self
.cal_type
== "NORMAL":
218 self
.st_pos
= start_pos
221 for i
in range(start_pos
):
226 self
.cal
.append(str(i
))
231 def SetWeekEnd(self
, font_color
='BLACK', backgrd
= 'LIGHT GREY'):
232 date
= 6 - int(self
.dow
) # start day of first saturday
234 while date
<= self
.dim
:
235 self
.cal_sel
[date
] = (font_color
, backgrd
) # Saturday
239 self
.cal_sel
[date
] = (font_color
, backgrd
) # Sunday
244 # get the display rectange list of the day grid
247 for y
in self
.gridy
[1:-1]:
248 for x
in self
.gridx
[:-1]:
249 rect
= wx
.Rect(x
, y
, self
.dl_w
, self
.dl_h
) # create rect region
261 # month and year title
263 month
= Month
[self
.month
]
266 if self
.sizeh
< _MIDSIZE
:
269 f
= wx
.Font(sizef
, self
.font
, wx
.NORMAL
, self
.bold
)
272 tw
,th
= self
.DC
.GetTextExtent(month
)
273 adjust
= self
.cx_st
+ (self
.sizew
-tw
)/2
274 self
.DC
.DrawText(month
, (adjust
, self
.cy_st
+ th
))
276 year
= str(self
.year
)
277 tw
,th
= self
.DC
.GetTextExtent(year
)
278 adjust
= self
.sizew
- tw
- self
.x_mrg
280 self
.title_offset
= th
* 2
282 f
= wx
.Font(sizef
, self
.font
, wx
.NORMAL
, self
.bold
)
284 self
.DC
.DrawText(year
, (self
.cx_st
+ adjust
, self
.cy_st
+ th
))
286 def DrawWeek(self
): # draw the week days
287 width
= self
.gridx
[1]-self
.gridx
[0]
288 height
= self
.gridy
[1] - self
.gridy
[0]
289 rect_w
= self
.gridx
[7]-self
.gridx
[0]
291 f
= wx
.Font(10, self
.font
, wx
.NORMAL
, self
.bold
) # initial font setting
293 if self
.week_auto
== True:
294 test_size
= self
.max_week_size
# max size
297 f
.SetPointSize(test_size
)
299 tw
,th
= self
.DC
.GetTextExtent(test_day
)
301 if tw
< width
and th
< height
:
304 test_size
= test_size
- 1
306 f
.SetPointSize(self
.week_size
) # set fixed size
309 self
.DC
.SetTextForeground(wx
.NamedColour(self
.week_font_color
))
314 brush
= wx
.Brush(wx
.NamedColour(self
.week_color
), wx
.SOLID
)
315 self
.DC
.SetBrush(brush
)
316 self
.DC
.DrawRectangle((self
.gridx
[0], self
.gridy
[0]), (rect_w
+1, height
))
318 if self
.cal_type
== "NORMAL":
321 cal_days
= BusCalDays
324 day
= AbrWeekday
[val
]
329 dw
,dh
= self
.DC
.GetTextExtent(day
)
331 diffy
= (height
-dh
)/2
333 x
= self
.gridx
[cnt_x
]
334 y
= self
.gridy
[cnt_y
]
335 self
.DC
.DrawRectangle((self
.gridx
[cnt_x
], self
.gridy
[0]), (width
+1, height
))
336 self
.DC
.DrawText(day
, (x
+diffx
, y
+diffy
))
339 # draw the day numbers
341 f
= wx
.Font(10, self
.font
, wx
.NORMAL
, self
.bold
) # initial font setting
343 if self
.num_auto
== True:
344 test_size
= self
.max_num_size
# max size
348 f
.SetPointSize(test_size
)
350 tw
,th
= self
.DC
.GetTextExtent(test_day
)
352 if tw
< self
.dl_w
and th
< self
.dl_h
:
355 test_size
= test_size
- 1
357 f
.SetPointSize(self
.num_size
) # set fixed size
363 x
= self
.gridx
[cnt_x
]
364 y
= self
.gridy
[cnt_y
]
368 num_color
= self
.cal_sel
[num_val
][0]
370 num_color
= self
.day_font_color
372 self
.DC
.SetTextForeground(wx
.NamedColour(num_color
))
375 tw
,th
= self
.DC
.GetTextExtent(val
)
377 if self
.num_align_horz
== wx
.ALIGN_CENTRE
:
378 adj_h
= (self
.dl_w
- tw
)/2
379 elif self
.num_align_horz
== wx
.ALIGN_RIGHT
:
380 adj_h
= self
.dl_w
- tw
382 adj_h
= 0 # left alignment
384 adj_h
= adj_h
+ self
.num_indent_horz
386 if self
.num_align_vert
== wx
.ALIGN_CENTRE
:
387 adj_v
= (self
.dl_h
- th
)/2
388 elif self
.num_align_horz
== wx
.ALIGN_RIGHT
:
389 adj_v
= self
.dl_h
- th
391 adj_v
= 0 # left alignment
393 adj_v
= adj_v
+ self
.num_indent_vert
395 self
.DC
.DrawText(val
, (x
+adj_h
, y
+adj_v
))
403 # calculate the dimensions in the center of the drawing area
406 bdh
= self
.y_mrg
+ self
.y_end
+ self
.title_offset
408 self
.dl_w
= int((self
.sizew
-bdw
)/7)
409 self
.dl_h
= int((self
.sizeh
-bdh
)/7)
411 # week title adjustment
412 self
.dl_th
= int(self
.dl_h
*self
.cal_week_scale
)
413 self
.cwidth
= self
.dl_w
* 7
414 self
.cheight
= self
.dl_h
* 6 + self
.dl_th
416 # highlighted selected days
418 for key
in self
.cal_sel
.keys():
419 sel_color
= self
.cal_sel
[key
][1]
420 brush
= wx
.Brush(wx
.NamedColour(sel_color
), wx
.SOLID
)
421 self
.DC
.SetBrush(brush
)
423 if self
.hide_grid
is False:
424 self
.DC
.SetPen(wx
.Pen(wx
.NamedColour(self
.grid_color
), 0))
426 self
.DC
.SetPen(wx
.Pen(wx
.NamedColour(self
.back_color
), 0))
428 nkey
= key
+ self
.st_pos
-1
430 self
.DC
.DrawRectangle((rect
.x
, rect
.y
), (rect
.width
+1, rect
.height
+1))
432 # calculate and draw the grid lines
434 self
.DC
.SetPen(wx
.Pen(wx
.NamedColour(self
.grid_color
), 0))
439 self
.x_st
= self
.cx_st
+ self
.x_mrg
440 # start postion of draw
441 self
.y_st
= self
.cy_st
+ self
.y_mrg
+ self
.title_offset
445 y2
= y1
+ self
.cheight
448 if self
.hide_grid
is False:
449 self
.DC
.DrawLine((x1
, y1
), (x1
, y2
))
450 self
.gridx
.append(x1
)
455 x2
= x1
+ self
.cwidth
458 if self
.hide_grid
is False:
459 self
.DC
.DrawLine((x1
, y1
), (x2
, y1
))
461 self
.gridy
.append(y1
)
469 class PrtCalDraw(CalDraw
):
470 def InitValues(self
):
473 # start draw border location
477 # draw offset position
482 # calculate the dimensions in the center of the drawing area
483 def SetPSize(self
, pwidth
, pheight
):
484 self
.pwidth
= int(pwidth
)/self
.scale
485 self
.pheight
= int(pheight
)/self
.scale
487 def SetPreview(self
, preview
):
488 self
.preview
= preview
490 class Calendar(wx
.Window
):
491 def __init__(self
, parent
, id, pos
=wx
.DefaultPosition
, size
=wx
.DefaultSize
):
492 wx
.Window
.__init
__(self
, parent
, id, pos
, size
)
494 # set the calendar control attributes
496 self
.grid_color
= 'BLACK'
497 self
.back_color
= 'WHITE'
498 self
.hide_grid
= False
499 self
.sel_color
= 'RED'
500 self
.hide_title
= False
501 self
.show_weekend
= False
502 self
.cal_type
= "NORMAL"
505 self
.week_color
= 'LIGHT GREY'
506 self
.week_font_color
= 'BLACK'
508 self
.select_list
= []
510 self
.SetBackgroundColour(self
.back_color
)
511 self
.Bind(wx
.EVT_LEFT_DOWN
, self
.OnLeftEvent
)
512 self
.Bind(wx
.EVT_LEFT_DCLICK
, self
.OnLeftDEvent
)
513 self
.Bind(wx
.EVT_RIGHT_DOWN
, self
.OnRightEvent
)
514 self
.Bind(wx
.EVT_RIGHT_DCLICK
, self
.OnRightDEvent
)
516 self
.sel_key
= None # last used by
517 self
.sel_lst
= [] # highlighted selected days
519 # default calendar for current month
525 self
.Bind(wx
.EVT_PAINT
, self
.OnPaint
)
526 self
.Bind(wx
.EVT_SIZE
, self
.OnSize
)
528 # control some of the main calendar attributes
531 self
.hide_title
= True
534 self
.hide_grid
= True
536 # determine the calendar rectangle click area and draw a selection
538 def ProcessClick(self
, event
):
539 self
.x
, self
.y
= event
.GetX(), event
.GetY()
540 key
= self
.GetDayHit(self
.x
, self
.y
)
543 # tab mouse click events and process
545 def OnLeftEvent(self
, event
):
547 self
.shiftkey
= event
.ShiftDown()
548 self
.ctrlkey
= event
.ControlDown()
549 self
.ProcessClick(event
)
551 def OnLeftDEvent(self
, event
):
553 self
.ProcessClick(event
)
555 def OnRightEvent(self
, event
):
557 self
.ProcessClick(event
)
559 def OnRightDEvent(self
, event
):
560 self
.click
= 'DRIGHT'
561 self
.ProcessClick(event
)
563 def SetSize(self
, set_size
):
566 def SetSelDay(self
, sel
):
567 # list of highlighted days
570 # get the current date
573 self
.month
= dt
.month
577 # set the current day
578 def SetCurrentDay(self
):
580 self
.set_day
= self
.day
582 # get the date, day, month, year set in calendar
585 return self
.day
, self
.month
, self
.year
596 # set the day, month, and year
598 def SetDayValue(self
, day
):
601 def SetMonth(self
, month
):
602 if month
>= 1 and month
<= 12:
608 def SetYear(self
, year
):
611 # increment year and month
614 self
.year
= self
.year
+ 1
618 self
.year
= self
.year
- 1
622 self
.month
= self
.month
+ 1
625 self
.year
= self
.year
+ 1
629 self
.month
= self
.month
- 1
632 self
.year
= self
.year
- 1
635 # test to see if the selection has a date and create event
637 def TestDay(self
, key
):
639 self
.day
= int(self
.cal
[key
])
645 # Changed 12/1/03 by jmg (see above) to support 2.5 event binding
646 evt
= wx
.PyCommandEvent(wxEVT_COMMAND_PYCALENDAR_DAY_CLICKED
, self
.GetId())
647 evt
.click
, evt
.day
, evt
.month
, evt
.year
= self
.click
, self
.day
, self
.month
, self
.year
648 evt
.shiftkey
= self
.shiftkey
649 evt
.ctrlkey
= self
.ctrlkey
650 self
.GetEventHandler().ProcessEvent(evt
)
652 self
.set_day
= self
.day
655 # find the clicked area rectangle
657 def GetDayHit(self
, mx
, my
):
658 for key
in self
.rg
.keys():
660 ms_rect
= wx
.Rect(mx
, my
, 1, 1)
661 if wx
.IntersectRect(ms_rect
, val
) is not None:
662 result
= self
.TestDay(key
)
669 def SetWeekColor(self
, font_color
, week_color
):
670 # set font and background color for week title
671 self
.week_font_color
= font_color
672 self
.week_color
= week_color
674 def AddSelect(self
, list, font_color
, back_color
):
675 list_val
= [list, font_color
, back_color
]
676 self
.select_list
.append(list_val
)
678 def ShowWeekEnd(self
):
680 self
.show_weekend
= True
682 def SetBusType(self
):
683 self
.cal_type
= "BUS"
685 def OnSize(self
, evt
):
689 def OnPaint(self
, event
):
690 DC
= wx
.PaintDC(self
)
693 def DoDrawing(self
, DC
):
694 DC
= wx
.PaintDC(self
)
697 self
.cal
= cal
= CalDraw(self
)
699 cal
.grid_color
= self
.grid_color
700 cal
.back_color
= self
.back_color
701 cal
.hide_grid
= self
.hide_grid
702 cal
.grid_color
= self
.grid_color
703 cal
.hide_title
= self
.hide_title
704 cal
.show_weekend
= self
.show_weekend
705 cal
.cal_type
= self
.cal_type
707 if self
.size
is None:
708 size
= self
.GetClientSize()
714 cal
.week_font_color
= self
.week_font_color
715 cal
.week_color
= self
.week_color
718 cal
.SetCal(self
.year
, self
.month
)
720 for val
in self
.select_list
:
721 cal
.AddSelect(val
[0], val
[1], val
[2])
723 cal
.DrawCal(DC
, self
.sel_lst
)
725 self
.rg
= cal
.GetRect()
726 self
.cal
= cal
.GetCal()
727 self
.st_pos
= cal
.GetOffset()
728 self
.ymax
= DC
.MaxY()
730 if self
.set_day
!= None:
731 self
.SetDay(self
.set_day
)
735 # draw the selection rectangle
736 def DrawRect(self
, key
, color
= 'BLACK', width
= 0):
740 DC
= wx
.ClientDC(self
)
743 brush
= wx
.Brush(wx
.Colour(0, 0xFF, 0x80), wx
.TRANSPARENT
)
745 DC
.SetPen(wx
.Pen(wx
.NamedColour(color
), width
))
748 DC
.DrawRectangle((rect
.x
, rect
.y
), (rect
.width
+1, rect
.height
+1))
752 # set the day selection
754 def SetDay(self
, day
):
755 day
= day
+ self
.st_pos
- 1
758 def SelectDay(self
, key
):
760 # clear large selection
761 self
.DrawRect(self
.sel_key
, self
.back_color
, sel_size
)
763 if self
.hide_grid
is False:
764 self
.DrawRect(self
.sel_key
, self
.grid_color
)
766 self
.DrawRect(key
, self
.sel_color
, sel_size
)
769 self
.select_day
= None
774 class CalenDlg(wx
.Dialog
):
775 def __init__(self
, parent
, month
=None, day
= None, year
=None):
776 wx
.Dialog
.__init
__(self
, parent
, -1, "Event Calendar", wx
.DefaultPosition
, (280, 360))
778 # set the calendar and attributes
779 self
.calend
= Calendar(self
, -1, (20, 60), (240, 200))
782 self
.calend
.SetCurrentDay()
783 start_month
= self
.calend
.GetMonth()
784 start_year
= self
.calend
.GetYear()
786 self
.calend
.month
= start_month
= month
787 self
.calend
.year
= start_year
= year
788 self
.calend
.SetDayValue(day
)
790 self
.calend
.HideTitle()
793 # get month list from DateTime
794 monthlist
= GetMonthList()
797 self
.date
= wx
.ComboBox(self
, -1, Month
[start_month
], (20, 20), (90, -1),
798 monthlist
, wx
.CB_DROPDOWN
)
799 self
.Bind(wx
.EVT_COMBOBOX
, self
.EvtComboBox
, self
.date
)
801 # alternate spin button to control the month
802 h
= self
.date
.GetSize().height
803 self
.m_spin
= wx
.SpinButton(self
, -1, (130, 20), (h
*2, h
), wx
.SP_VERTICAL
)
804 self
.m_spin
.SetRange(1, 12)
805 self
.m_spin
.SetValue(start_month
)
806 self
.Bind(wx
.EVT_SPIN
, self
.OnMonthSpin
, self
.m_spin
)
808 # spin button to control the year
809 self
.dtext
= wx
.TextCtrl(self
, -1, str(start_year
), (160, 20), (60, -1))
810 h
= self
.dtext
.GetSize().height
812 self
.y_spin
= wx
.SpinButton(self
, -1, (220, 20), (h
*2, h
), wx
.SP_VERTICAL
)
813 self
.y_spin
.SetRange(1980, 2010)
814 self
.y_spin
.SetValue(start_year
)
816 self
.Bind(wx
.EVT_SPIN
, self
.OnYrSpin
, self
.y_spin
)
817 self
.Bind(EVT_CALENDAR
, self
.MouseClick
, self
.calend
)
823 btn
= wx
.Button(self
, -1, ' Ok ', (x_pos
, y_pos
), but_size
)
824 self
.Bind(wx
.EVT_BUTTON
, self
.OnOk
, btn
)
826 btn
= wx
.Button(self
, -1, ' Close ', (x_pos
+ 120, y_pos
), but_size
)
827 self
.Bind(wx
.EVT_BUTTON
, self
.OnCancel
, btn
)
829 def OnOk(self
, event
):
830 self
.EndModal(wx
.ID_OK
)
832 def OnCancel(self
, event
):
833 self
.EndModal(wx
.ID_CANCEL
)
835 # log the mouse clicks
836 def MouseClick(self
, evt
):
837 self
.month
= evt
.month
838 # result click type and date
839 self
.result
= [evt
.click
, str(evt
.day
), Month
[evt
.month
], str(evt
.year
)]
841 if evt
.click
== 'DLEFT':
842 self
.EndModal(wx
.ID_OK
)
844 # month and year spin selection routines
845 def OnMonthSpin(self
, event
):
846 month
= event
.GetPosition()
847 self
.date
.SetValue(Month
[month
])
848 self
.calend
.SetMonth(month
)
849 self
.calend
.Refresh()
851 def OnYrSpin(self
, event
):
852 year
= event
.GetPosition()
853 self
.dtext
.SetValue(str(year
))
854 self
.calend
.SetYear(year
)
855 self
.calend
.Refresh()
857 def EvtComboBox(self
, event
):
858 name
= event
.GetString()
859 monthval
= self
.date
.FindString(name
)
860 self
.m_spin
.SetValue(monthval
+1)
862 self
.calend
.SetMonth(monthval
+1)
865 # set the calendar for highlighted days
867 def ResetDisplay(self
):
868 month
= self
.calend
.GetMonth()
869 self
.calend
.Refresh()