use bitmap mask if any in splash screen (closes #10470)
[wxWidgets.git] / 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 // At least for GTK+ 2.0, this hint is not available.
56 #if defined(__WXGTK20__)
57 #if GTK_CHECK_VERSION(2,2,0)
58 gtk_window_set_type_hint(GTK_WINDOW(m_widget),
59 GDK_WINDOW_TYPE_HINT_SPLASHSCREEN);
60 #endif
61 #endif
62
63 m_window = NULL;
64 m_splashStyle = splashStyle;
65 m_milliseconds = milliseconds;
66
67 m_window = new wxSplashScreenWindow(bitmap, this, wxID_ANY, pos, size, wxNO_BORDER);
68
69 SetClientSize(bitmap.GetWidth(), bitmap.GetHeight());
70
71 if (m_splashStyle & wxSPLASH_CENTRE_ON_PARENT)
72 CentreOnParent();
73 else if (m_splashStyle & wxSPLASH_CENTRE_ON_SCREEN)
74 CentreOnScreen();
75
76 if (m_splashStyle & wxSPLASH_TIMEOUT)
77 {
78 m_timer.SetOwner(this, wxSPLASH_TIMER_ID);
79 m_timer.Start(milliseconds, true);
80 }
81
82 Show(true);
83 m_window->SetFocus();
84 #if defined( __WXMSW__ ) || defined(__WXMAC__)
85 Update(); // Without this, you see a blank screen for an instant
86 #elif defined(__WXGTK20__)
87 // we don't need to do anything at least on wxGTK with GTK+ 2.12.9
88 #else
89 wxYieldIfNeeded(); // Should eliminate this
90 #endif
91 }
92
93 wxSplashScreen::~wxSplashScreen()
94 {
95 m_timer.Stop();
96 }
97
98 void wxSplashScreen::OnNotify(wxTimerEvent& WXUNUSED(event))
99 {
100 Close(true);
101 }
102
103 void wxSplashScreen::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
104 {
105 m_timer.Stop();
106 this->Destroy();
107 }
108
109 // ----------------------------------------------------------------------------
110 // wxSplashScreenWindow
111 // ----------------------------------------------------------------------------
112
113 BEGIN_EVENT_TABLE(wxSplashScreenWindow, wxWindow)
114 #ifdef __WXGTK__
115 EVT_PAINT(wxSplashScreenWindow::OnPaint)
116 #endif
117 EVT_ERASE_BACKGROUND(wxSplashScreenWindow::OnEraseBackground)
118 EVT_CHAR(wxSplashScreenWindow::OnChar)
119 EVT_MOUSE_EVENTS(wxSplashScreenWindow::OnMouseEvent)
120 END_EVENT_TABLE()
121
122 wxSplashScreenWindow::wxSplashScreenWindow(const wxBitmap& bitmap, wxWindow* parent,
123 wxWindowID id, const wxPoint& pos,
124 const wxSize& size, long style)
125 : wxWindow(parent, id, pos, size, style)
126 {
127 m_bitmap = bitmap;
128
129 #if !defined(__WXGTK__) && wxUSE_PALETTE
130 bool hiColour = (wxDisplayDepth() >= 16) ;
131
132 if (bitmap.GetPalette() && !hiColour)
133 {
134 SetPalette(* bitmap.GetPalette());
135 }
136 #endif
137 }
138
139 // VZ: why don't we do it under wxGTK?
140 #if !defined(__WXGTK__) && wxUSE_PALETTE
141 #define USE_PALETTE_IN_SPLASH
142 #endif
143
144 static void wxDrawSplashBitmap(wxDC& dc, const wxBitmap& bitmap, int WXUNUSED(x), int WXUNUSED(y))
145 {
146 wxMemoryDC dcMem;
147
148 #ifdef USE_PALETTE_IN_SPLASH
149 bool hiColour = (wxDisplayDepth() >= 16) ;
150
151 if (bitmap.GetPalette() && !hiColour)
152 {
153 dcMem.SetPalette(* bitmap.GetPalette());
154 }
155 #endif // USE_PALETTE_IN_SPLASH
156
157 dcMem.SelectObjectAsSource(bitmap);
158 dc.Blit(0, 0, bitmap.GetWidth(), bitmap.GetHeight(), &dcMem, 0, 0, wxCOPY,
159 true /* use mask */);
160 dcMem.SelectObject(wxNullBitmap);
161
162 #ifdef USE_PALETTE_IN_SPLASH
163 if (bitmap.GetPalette() && !hiColour)
164 {
165 dcMem.SetPalette(wxNullPalette);
166 }
167 #endif // USE_PALETTE_IN_SPLASH
168 }
169
170 void wxSplashScreenWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
171 {
172 wxPaintDC dc(this);
173 if (m_bitmap.Ok())
174 wxDrawSplashBitmap(dc, m_bitmap, 0, 0);
175 }
176
177 void wxSplashScreenWindow::OnEraseBackground(wxEraseEvent& event)
178 {
179 if (event.GetDC() && m_bitmap.Ok())
180 {
181 wxDrawSplashBitmap(* event.GetDC(), m_bitmap, 0, 0);
182 }
183 else
184 {
185 wxClientDC dc(this);
186 if (m_bitmap.Ok())
187 wxDrawSplashBitmap(dc, m_bitmap, 0, 0);
188 }
189 }
190
191 void wxSplashScreenWindow::OnMouseEvent(wxMouseEvent& event)
192 {
193 if (event.LeftDown() || event.RightDown())
194 GetParent()->Close(true);
195 else
196 event.Skip();
197 }
198
199 void wxSplashScreenWindow::OnChar(wxKeyEvent& WXUNUSED(event))
200 {
201 GetParent()->Close(true);
202 }
203
204 #endif // wxUSE_SPLASH