utils/wxPython/lib/splashscreen.py

   1 #----------------------------------------------------------------------
   2 # Name:        wxPython.lib.splashscreen
   3 # Purpose:     A simple frame that can display a bitmap and closes itself
   4 #              after a specified timeout or a mouse click.
   5 #
   6 # Author:      Mike Fletcher, Robin Dunn
   7 #
   8 # Created:     19-Nov-1999
   9 # RCS-ID:      $Id$
  10 # Copyright:   (c) 1999 by Total Control Software
  11 # Licence:     wxWindows license
  12 #----------------------------------------------------------------------
  13
  14 from wxPython.wx import *
  15
  16 #----------------------------------------------------------------------
  17
  18 def bitmapFromFile(filename):
  19     '''Non-portable test for bitmap type...'''
  20     import imghdr
  21     BITMAPTYPEGUESSDICT = {
  22         "bmp" :wxBITMAP_TYPE_BMP,
  23         "png" :wxBITMAP_TYPE_PNG,
  24         "jpeg":wxBITMAP_TYPE_JPEG,
  25         "gif" :wxBITMAP_TYPE_GIF,
  26         "xbm" :wxBITMAP_TYPE_XBM,
  27     }
  28     # following assumes bitmap type if we cannot resolve image type
  29     typ = BITMAPTYPEGUESSDICT.get(imghdr.what(filename), wxBITMAP_TYPE_BMP)
  30     bitmap = wxImage(filename, typ).ConvertToBitmap()
  31     return bitmap
  32
  33 #----------------------------------------------------------------------
  34
  35 class SplashScreen(wxFrame):
  36     def __init__(self, parent, ID=-1, title="SplashScreen",
  37                  style=wxSIMPLE_BORDER|wxSTAY_ON_TOP,
  38                  duration=1500, bitmapfile="bitmaps/splashscreen.bmp",
  39                  callback = None):
  40         '''
  41         parent, ID, title, style -- see wxFrame
  42         duration -- milliseconds to display the splash screen
  43         bitmapfile -- absolute or relative pathname, extension used for type negotiation
  44         callback -- if specified, is called when timer completes, callback is responsible for closing the splash screen
  45         '''
  46         ### Loading bitmap
  47         self.bitmap = bmp = bitmapFromFile(bitmapfile)
  48         ### Determine size of bitmap to size window...
  49         size = (bmp.GetWidth(), bmp.GetHeight())
  50         # size of screen
  51         width = wxSystemSettings_GetSystemMetric(wxSYS_SCREEN_X)
  52         height = wxSystemSettings_GetSystemMetric(wxSYS_SCREEN_Y)
  53         pos = ((width-size[0])/2, (height-size[1])/2)
  54
  55         # check for overflow...
  56         if pos[0] < 0:
  57             size = (wxSystemSettings_GetSystemMetric(wxSYS_SCREEN_X), size[1])
  58         if pos[1] < 0:
  59             size = (size[0], wxSystemSettings_GetSystemMetric(wxSYS_SCREEN_Y))
  60
  61         wxFrame.__init__(self, parent, ID, title, pos, size, style)
  62         self.Show(true)
  63         dc = wxClientDC(self)
  64         dc.DrawBitmap(self.bitmap, 0,0, false)
  65
  66         class SplashTimer(wxTimer):
  67             def __init__(self, targetFunction):
  68                 self.Notify = targetFunction
  69                 wxTimer.__init__(self)
  70
  71         if callback is None:
  72             callback = self.OnSplashExitDefault
  73
  74         self.timer = SplashTimer(callback)
  75         self.timer.Start(duration, 1) # one-shot only
  76         EVT_LEFT_DOWN(self, self.OnMouseClick)
  77
  78     def OnPaint(self, event):
  79         dc = wxPaintDC(self)
  80         dc.DrawBitmap(self.bitmap, 0,0, false)
  81
  82
  83     def OnSplashExitDefault(self, event=None):
  84         self.Close(true)
  85
  86
  87     def OnCloseWindow(self, event=None):
  88         self.Show(false)
  89         self.timer.Stop()
  90         del self.timer
  91         self.Destroy()
  92
  93
  94     def OnMouseClick(self, event):
  95         self.timer.Notify()
  96
  97 #----------------------------------------------------------------------
  98
  99
 100 if __name__ == "__main__":
 101     class DemoApp(wxApp):
 102         def OnInit(self):
 103             wxImage_AddHandler(wxJPEGHandler())
 104             wxImage_AddHandler(wxPNGHandler())
 105             wxImage_AddHandler(wxGIFHandler())
 106             self.splash = SplashScreen(NULL, bitmapfile="splashscreen.jpg", callback=self.OnSplashExit)
 107             self.splash.Show(true)
 108             self.SetTopWindow(self.splash)
 109             return true
 110         def OnSplashExit(self, event=None):
 111             print "Yay! Application callback worked!"
 112             self.splash.Close(true)
 113             del self.splash
 114             ### Build working windows here...
 115     def test(sceneGraph=None):
 116         app = DemoApp(0)
 117         app.MainLoop()
 118     test()