docstring update

[wxWidgets.git] / wxPython / wx / lib / analogclock.py

# -*- coding: iso-8859-1 -*-
#----------------------------------------------------------------------
# Name:        wx.lib.analogclock
# Purpose:     A simple analog clock window
#
# Author:      several folks on wxPython-users
#
# Created:     16-April-2003
# RCS-ID:      $Id$
# Copyright:   (c) 2003 by Total Control Software
# Licence:     wxWindows license
#----------------------------------------------------------------------
# 11/30/2003 - Jeff Grimmett (grimmtooth@softhome.net)
#
# o Updated for wx namespace
# o Tested with updated demo and with builtin test.
# 
# 15-February-2004 - E. A. Tacao
#
# o Many ehnacements
#

"""
`AnalogClockWindow` is a simple analog clock class.
"""

import math
import sys
import string
import time

import wx

from analogclockopts import ACCustomizationFrame


# self.clockStyle:
SHOW_QUARTERS_TICKS = 1
SHOW_HOURS_TICKS    = 2
SHOW_MINUTES_TICKS  = 4
ROTATE_TICKS        = 8
SHOW_HOURS_HAND     = 16
SHOW_MINUTES_HAND   = 32
SHOW_SECONDS_HAND   = 64
SHOW_SHADOWS        = 128
OVERLAP_TICKS       = 256

# self.tickMarkHoursStyle and self.tickMarkMinutesStyle:
TICKS_NONE          = 1
TICKS_SQUARE        = 2
TICKS_CIRCLE        = 4
TICKS_POLY          = 8
TICKS_DECIMAL       = 16
TICKS_ROMAN         = 32


class AnalogClockWindow(wx.PyWindow):
    """An analog clock window"""

    def __init__(self, parent, ID=-1, pos=wx.DefaultPosition, size=wx.DefaultSize,
                 style=0, name="clock"):
        
        # Initialize the wxWindow...
        wx.PyWindow.__init__(self, parent, ID, pos, size, style, name)

        # Initialize some variables and defaults...
        self.clockStep = 1
        self.prefs_open = False

        self.tickShapeHours = self.tickShapeMinutes= [[0,0],
                                                      [1,-1],
                                                      [2,0],
                                                      [1,4]]
        self.handHoursThickness = 5
        self.handHoursColour = (0, 0, 0)

        self.handMinutesThickness = 3
        self.handMinutesColour = (0, 0, 0)

        self.handSecondsThickness = 1
        self.handSecondsColour = (0, 0, 0)

        self.tickMarkHoursPen = wx.Pen((0, 0, 0), 1, wx.SOLID)
        self.tickMarkHoursBrush = wx.Brush((0, 0, 0), wx.SOLID)
        self.markSizeHour = 10
        self.tickMarkHoursFont = wx.Font(1, wx.SWISS, wx.NORMAL, wx.BOLD)
        self.tickMarkHoursFont.SetPointSize(self.markSizeHour)

        self.tickMarkMinutesPen = wx.Pen((0, 0, 0), 1, wx.SOLID)
        self.tickMarkMinutesBrush = wx.Brush((0, 0, 0), wx.SOLID)
        self.markSizeMin = 6
        self.tickMarkMinutesFont = wx.Font(self.markSizeMin, wx.SWISS, wx.NORMAL, wx.BOLD)

        self.offM = 0

        self.shadowPenColour = self.shadowBrushColour = (128,128,128)

        self.watchPen = None
        self.watchBrush = None

        self.clockStyle = SHOW_HOURS_TICKS | SHOW_MINUTES_TICKS | SHOW_SHADOWS | ROTATE_TICKS
        self.handsStyle = SHOW_SECONDS_HAND

        self.tickMarkHoursStyle = TICKS_POLY
        self.tickMarkMinutesStyle = TICKS_CIRCLE

        self.currentTime=None

        size = wx.Size(*size)
        bestSize = self.GetBestSize()
        size.x = max(size.x, bestSize.x)
        size.y = max(size.y, bestSize.y)
        self.SetSize(size)
        
        # Make an initial bitmap for the face, it will be updated and
        # painted at the first EVT_SIZE event.
        W, H = size
        self.faceBitmap = wx.EmptyBitmap(max(W,1), max(H,1))
        
        # Set event handlers...
        self.Bind(wx.EVT_PAINT, self.OnPaint)
        self.Bind(wx.EVT_ERASE_BACKGROUND, lambda x: None)
        self.Bind(wx.EVT_SIZE, self.OnSize)
        self.Bind(wx.EVT_TIMER, self.OnTimerExpire)
        self.Bind(wx.EVT_WINDOW_DESTROY, self.OnQuit)
        self.Bind(wx.EVT_RIGHT_DOWN, self.OnRightDown)
        self.Bind(wx.EVT_RIGHT_UP, self.OnRightClick)         

        # Initialize the timer that drives the update of the clock
        # face.  Update every half second to ensure that there is at
        # least one true update during each realtime second.
        self.timer = wx.Timer(self)
        self.timer.Start(500)


    def DoGetBestSize(self):
        return wx.Size(25,25)


    def OnPaint(self, event):
        dc = wx.BufferedPaintDC(self)
        if hasattr(self, 'coords'):
            self._doDrawHands(dc, True)


    def OnTimerExpire(self, event):
        size = self.GetClientSize()
        dc = wx.BufferedDC(wx.ClientDC(self), size)
        self._doDrawHands(dc, True)


    def OnQuit(self, event):
        self.timer.Stop()
        del self.timer

        
    def OnRightDown(self, event):
        self.x = event.GetX()
        self.y = event.GetY()
        event.Skip()


    def OnRightClick(self, event):
        # only do this part the first time so the events are only bound once
        if not hasattr(self, "popupID1"):
            self.popupID1 = wx.NewId()
            self.popupID2 = wx.NewId()
            self.Bind(wx.EVT_MENU, self.OnPopupOne, id=self.popupID1)
            self.Bind(wx.EVT_MENU, self.OnPopupTwo, id=self.popupID2)

        # make a menu
        sm = wx.Menu()

        sm.Append(self.popupID1, "Customize...")
        sm.Append(self.popupID2, "About...")

        # If there already a setup window open, we must not appear...
        if not self.prefs_open:
            # Popup the menu.  If an item is selected then its handler
            # will be called before PopupMenu returns.
            self.PopupMenu(sm, (self.x,self.y))
        sm.Destroy()


    def OnPopupOne(self, event):
        self.prefs_open=True
        frame = ACCustomizationFrame(self, -1, "AnalogClock Preferences")
        frame.Show(True)


    def OnPopupTwo(self, event):