Added wxHelpEvent, wxContextHelp (MSW only so far), modified help sample
[wxWidgets.git] / src / generic / splash.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: 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 #ifdef __GNUG__
13 #pragma implementation "splash.h"
14 #endif
15
16 // For compilers that support precompilation, includes "wx/wx.h".
17 #include "wx/wxprec.h"
18
19 #ifdef __BORLANDC__
20 #pragma hdrstop
21 #endif
22
23 #ifndef WX_PRECOMP
24 #include "wx/wx.h"
25 #endif
26
27 #include "wx/splash.h"
28
29 /*
30 * wxSplashScreen
31 */
32
33 #define wxSPLASH_TIMER_ID 9999
34
35 BEGIN_EVENT_TABLE(wxSplashScreen, wxFrame)
36 EVT_TIMER(wxSPLASH_TIMER_ID, wxSplashScreen::OnNotify)
37 EVT_CLOSE(wxSplashScreen::OnCloseWindow)
38 END_EVENT_TABLE()
39
40 wxSplashScreen::wxSplashScreen(const wxBitmap& bitmap, long splashStyle, int milliseconds, wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style):
41 wxFrame(parent, id, wxEmptyString, pos, size, style)
42 {
43 m_window = NULL;
44 m_splashStyle = splashStyle;
45 m_milliseconds = milliseconds;
46
47 m_window = new wxSplashScreenWindow(bitmap, this, -1, pos, size, wxNO_BORDER);
48
49 // For some reason, we need to make the client size a couple of pixels
50 // bigger for all of the bitmap to show.
51 #ifdef __WXMSW__
52 int fudge = 2;
53 #else
54 int fudge = 0;
55 #endif
56 SetClientSize(bitmap.GetWidth()+fudge, bitmap.GetHeight()+fudge);
57
58 if (m_splashStyle & wxSPLASH_CENTRE_ON_PARENT)
59 CentreOnParent();
60 else if (m_splashStyle & wxSPLASH_CENTRE_ON_SCREEN)
61 CentreOnScreen();
62
63 if (m_splashStyle & wxSPLASH_TIMEOUT)
64 {
65 m_timer.SetOwner(this, wxSPLASH_TIMER_ID);
66 m_timer.Start(milliseconds, TRUE);
67 }
68
69 Show(TRUE);
70 m_window->SetFocus();
71 wxYield(); // Without this, you see a blank screen for an instant
72 }
73
74 wxSplashScreen::~wxSplashScreen()
75 {
76 m_timer.Stop();
77 }
78
79 void wxSplashScreen::OnNotify(wxTimerEvent& event)
80 {
81 m_timer.Stop();
82 this->Destroy();
83 }
84
85 void wxSplashScreen::OnCloseWindow(wxCloseEvent& event)
86 {
87 m_timer.Stop();
88 this->Destroy();
89 }
90
91 /*
92 * wxSplashScreenWindow
93 */
94
95 BEGIN_EVENT_TABLE(wxSplashScreenWindow, wxWindow)
96 //EVT_PAINT(wxSplashScreenWindow::OnPaint)
97 EVT_ERASE_BACKGROUND(wxSplashScreenWindow::OnEraseBackground)
98 EVT_CHAR(wxSplashScreenWindow::OnChar)
99 EVT_MOUSE_EVENTS(wxSplashScreenWindow::OnMouseEvent)
100 END_EVENT_TABLE()
101
102 wxSplashScreenWindow::wxSplashScreenWindow(const wxBitmap& bitmap, wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style):
103 wxWindow(parent, id, pos, size, style)
104 {
105 m_bitmap = bitmap;
106 }
107
108 void wxSplashScreenWindow::OnPaint(wxPaintEvent& event)
109 {
110 wxPaintDC dc(this);
111 if (m_bitmap.Ok())
112 dc.DrawBitmap(m_bitmap, 0, 0);
113 }
114
115 static void wxDrawSplashBitmap(wxDC& dc, const wxBitmap& bitmap, int x, int y)
116 {
117 wxMemoryDC dcMem;
118
119 bool hiColour = (wxDisplayDepth() >= 16) ;
120
121 #ifndef __WXGTK__
122 if (bitmap.GetPalette() && !hiColour)
123 {
124 dc.SetPalette(* bitmap.GetPalette());
125 dcMem.SetPalette(* bitmap.GetPalette());
126 }
127 #endif
128
129 dcMem.SelectObject(bitmap);
130 dc.Blit(0, 0, bitmap.GetWidth(), bitmap.GetHeight(), & dcMem, 0, 0);
131 dcMem.SelectObject(wxNullBitmap);
132
133 #ifndef __WXGTK__
134 if (bitmap.GetPalette() && !hiColour)
135 {
136 dc.SetPalette(wxNullPalette);
137 dcMem.SetPalette(wxNullPalette);
138 }
139 #endif
140 }
141
142 void wxSplashScreenWindow::OnEraseBackground(wxEraseEvent& event)
143 {
144 if (event.GetDC())
145 {
146 if (m_bitmap.Ok())
147 {
148 wxDrawSplashBitmap(* event.GetDC(), m_bitmap, 0, 0);
149 }
150 }
151 else
152 {
153 wxClientDC dc(this);
154 if (m_bitmap.Ok())
155 {
156 wxDrawSplashBitmap(dc, m_bitmap, 0, 0);
157 }
158 }
159 }
160
161 void wxSplashScreenWindow::OnMouseEvent(wxMouseEvent& event)
162 {
163 if (event.LeftDown() || event.RightDown())
164 GetParent()->Close(TRUE);
165 }
166
167 void wxSplashScreenWindow::OnChar(wxKeyEvent& event)
168 {
169 GetParent()->Close(TRUE);
170 }
171