src/generic/splash.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/generic/splash.cpp
   3 // Purpose:     wxSplashScreen class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     28/6/2000
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx/wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifdef __BORLANDC__
  16     #pragma hdrstop
  17 #endif
  18
  19 #if wxUSE_SPLASH
  20
  21 #ifdef __WXGTK20__
  22     #include <gtk/gtk.h>
  23 #endif
  24
  25 #include "wx/splash.h"
  26
  27 #ifndef WX_PRECOMP
  28     #include "wx/dcmemory.h"
  29     #include "wx/dcclient.h"
  30 #endif
  31
  32
  33 // ----------------------------------------------------------------------------
  34 // wxSplashScreen
  35 // ----------------------------------------------------------------------------
  36
  37 #define wxSPLASH_TIMER_ID       9999
  38
  39 IMPLEMENT_DYNAMIC_CLASS(wxSplashScreen, wxFrame)
  40 BEGIN_EVENT_TABLE(wxSplashScreen, wxFrame)
  41     EVT_TIMER(wxSPLASH_TIMER_ID, wxSplashScreen::OnNotify)
  42     EVT_CLOSE(wxSplashScreen::OnCloseWindow)
  43 END_EVENT_TABLE()
  44
  45 /* Note that unless we pass a non-default size to the frame, SetClientSize
  46  * won't work properly under Windows, and the splash screen frame is sized
  47  * slightly too small.
  48  */
  49
  50 wxSplashScreen::wxSplashScreen(const wxBitmap& bitmap, long splashStyle, int milliseconds,
  51                                wxWindow* parent, wxWindowID id, const wxPoint& pos,
  52                                const wxSize& size, long style)
  53     : wxFrame(parent, id, wxEmptyString, wxPoint(0,0), wxSize(100, 100), style)
  54 {
  55     // splash screen must not be used as parent by the other windows because it
  56     // is going to disappear soon, indicate it by giving it this special style
  57     SetExtraStyle(GetExtraStyle() | wxWS_EX_TRANSIENT);
  58
  59 #if defined(__WXGTK20__)
  60     gtk_window_set_type_hint(GTK_WINDOW(m_widget),
  61                              GDK_WINDOW_TYPE_HINT_SPLASHSCREEN);
  62 #endif
  63
  64     m_window = NULL;
  65     m_splashStyle = splashStyle;
  66     m_milliseconds = milliseconds;
  67
  68     m_window = new wxSplashScreenWindow(bitmap, this, wxID_ANY, pos, size, wxNO_BORDER);
  69
  70     SetClientSize(bitmap.GetWidth(), bitmap.GetHeight());
  71
  72     if (m_splashStyle & wxSPLASH_CENTRE_ON_PARENT)
  73         CentreOnParent();
  74     else if (m_splashStyle & wxSPLASH_CENTRE_ON_SCREEN)
  75         CentreOnScreen();
  76
  77     if (m_splashStyle & wxSPLASH_TIMEOUT)
  78     {
  79         m_timer.SetOwner(this, wxSPLASH_TIMER_ID);
  80         m_timer.Start(milliseconds, true);
  81     }
  82
  83     Show(true);
  84     m_window->SetFocus();
  85 #if defined( __WXMSW__ ) || defined(__WXMAC__)
  86     Update(); // Without this, you see a blank screen for an instant
  87 #elif defined(__WXGTK20__)
  88     // we don't need to do anything at least on wxGTK with GTK+ 2.12.9
  89 #else
  90     wxYieldIfNeeded(); // Should eliminate this
  91 #endif
  92 }
  93
  94 wxSplashScreen::~wxSplashScreen()
  95 {
  96     m_timer.Stop();
  97 }
  98
  99 void wxSplashScreen::OnNotify(wxTimerEvent& WXUNUSED(event))
 100 {
 101     Close(true);
 102 }
 103
 104 void wxSplashScreen::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
 105 {
 106     m_timer.Stop();
 107     this->Destroy();
 108 }
 109
 110 // ----------------------------------------------------------------------------
 111 // wxSplashScreenWindow
 112 // ----------------------------------------------------------------------------
 113
 114 BEGIN_EVENT_TABLE(wxSplashScreenWindow, wxWindow)
 115 #ifdef __WXGTK__
 116     EVT_PAINT(wxSplashScreenWindow::OnPaint)
 117 #endif
 118     EVT_ERASE_BACKGROUND(wxSplashScreenWindow::OnEraseBackground)
 119     EVT_CHAR(wxSplashScreenWindow::OnChar)
 120     EVT_MOUSE_EVENTS(wxSplashScreenWindow::OnMouseEvent)
 121 END_EVENT_TABLE()
 122
 123 wxSplashScreenWindow::wxSplashScreenWindow(const wxBitmap& bitmap, wxWindow* parent,
 124                                            wxWindowID id, const wxPoint& pos,
 125                                            const wxSize& size, long style)
 126     : wxWindow(parent, id, pos, size, style)
 127 {
 128     m_bitmap = bitmap;
 129
 130 #if !defined(__WXGTK__) && wxUSE_PALETTE
 131     bool hiColour = (wxDisplayDepth() >= 16) ;
 132
 133     if (bitmap.GetPalette() && !hiColour)
 134     {
 135         SetPalette(* bitmap.GetPalette());
 136     }
 137 #endif
 138 }
 139
 140 // VZ: why don't we do it under wxGTK?
 141 #if !defined(__WXGTK__) && wxUSE_PALETTE
 142     #define USE_PALETTE_IN_SPLASH
 143 #endif
 144
 145 static void wxDrawSplashBitmap(wxDC& dc, const wxBitmap& bitmap, int WXUNUSED(x), int WXUNUSED(y))
 146 {
 147     wxMemoryDC dcMem;
 148
 149 #ifdef USE_PALETTE_IN_SPLASH
 150     bool hiColour = (wxDisplayDepth() >= 16) ;
 151
 152     if (bitmap.GetPalette() && !hiColour)
 153     {
 154         dcMem.SetPalette(* bitmap.GetPalette());
 155     }
 156 #endif // USE_PALETTE_IN_SPLASH
 157
 158     dcMem.SelectObjectAsSource(bitmap);
 159     dc.Blit(0, 0, bitmap.GetWidth(), bitmap.GetHeight(), &dcMem, 0, 0, wxCOPY,
 160             true /* use mask */);
 161     dcMem.SelectObject(wxNullBitmap);
 162
 163 #ifdef USE_PALETTE_IN_SPLASH
 164     if (bitmap.GetPalette() && !hiColour)
 165     {
 166         dcMem.SetPalette(wxNullPalette);
 167     }
 168 #endif // USE_PALETTE_IN_SPLASH
 169 }
 170
 171 void wxSplashScreenWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
 172 {
 173     wxPaintDC dc(this);
 174     if (m_bitmap.IsOk())
 175         wxDrawSplashBitmap(dc, m_bitmap, 0, 0);
 176 }
 177
 178 void wxSplashScreenWindow::OnEraseBackground(wxEraseEvent& event)
 179 {
 180     if (event.GetDC() && m_bitmap.IsOk())
 181     {
 182         wxDrawSplashBitmap(* event.GetDC(), m_bitmap, 0, 0);
 183     }
 184     else
 185     {
 186         wxClientDC dc(this);
 187         if (m_bitmap.IsOk())
 188             wxDrawSplashBitmap(dc, m_bitmap, 0, 0);
 189     }
 190 }
 191
 192 void wxSplashScreenWindow::OnMouseEvent(wxMouseEvent& event)
 193 {
 194     if (event.LeftDown() || event.RightDown())
 195         GetParent()->Close(true);
 196     else
 197         event.Skip();
 198 }
 199
 200 void wxSplashScreenWindow::OnChar(wxKeyEvent& WXUNUSED(event))
 201 {
 202     GetParent()->Close(true);
 203 }
 204
 205 #endif // wxUSE_SPLASH