root/trunk/RBSkinning/RBSkinning/wxTools/wxRolloverEvents.py

#!/usr/bin/env python
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##~ License 
##~ 
##- The RuneBlade Foundation library is intended to ease some 
##- aspects of writing intricate Jabber, XML, and User Interface (wxPython, etc.) 
##- applications, while providing the flexibility to modularly change the 
##- architecture. Enjoy.
##~ 
##~ Copyright (C) 2002  TechGame Networks, LLC.
##~ 
##~ This library is free software; you can redistribute it and/or
##~ modify it under the terms of the BSD style License as found in the 
##~ LICENSE file included with this distribution.
##~ 
##~ TechGame Networks, LLC can be reached at:
##~ 3578 E. Hartsel Drive #211
##~ Colorado Springs, Colorado, USA, 80920
##~
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

"""Provides a simple interface for creating rollover events.

Note: Currently only works with Windows.
"""
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Imports 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

from wxPython import wx
from RBFoundation.BindCallable import BindCallable

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Definitions 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class wxRolloverMixin:
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Constants / Variables / Etc. 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    _rollover_bitmap = None
    _nonrollover_bitmap = None

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Public Methods 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def _SetupEvents(self):
        self._eventhandler = wx.wxEvtHandler()
        wx.EVT_ENTER_WINDOW(self._eventhandler, BindCallable(self._SetRolloverBitmap))
        wx.EVT_LEAVE_WINDOW(self._eventhandler, BindCallable(self._SetNonRolloverBitmap))
        self.PushEventHandler(self._eventhandler)
        return self._eventhandler

    def GetBitmapRollover(self):
        return self._rollover_bitmap 
    def SetBitmapRollover(self, rollover):
        self._rollover_bitmap = rollover

    def GetBitmapNonRollover(self):
        return self._nonrollover_bitmap 
    def SetBitmapNonRollover(self, nonrollover):
        self._nonrollover_bitmap = nonrollover

    def _SetRolloverBitmap(self, evt):
        raise NotImplementedError

    def _SetNonRolloverBitmap(self, evt):
        raise NotImplementedError