Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / generic / splash.h

diff --git a/include/wx/generic/splash.h b/include/wx/generic/splash.h
index 498eee8eec4202fa4386287e89ea72fb24158780..1441be4420c36fc86d98184d861a63dcffcf1c89 100644 (file)
--- a/include/wx/generic/splash.h
+++ b/include/wx/generic/splash.h
@@ -1,27 +1,21 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        splash.h
+// Name:        wx/generic/splash.h
 // Purpose:     Splash screen class
 // Author:      Julian Smart
 // Modified by:
 // Created:     28/6/2000
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
-// Licence:
+// Licence:     wxWindows Licence
 /////////////////////////////////////////////////////////////////////////////
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "splash.h"
-#endif
-
 #ifndef _WX_SPLASH_H_
 #define _WX_SPLASH_H_
 
-#ifndef WX_PRECOMP
 #include "wx/bitmap.h"
-#include "wx/timer.h"
-#endif
-
+#include "wx/eventfilter.h"
 #include "wx/frame.h"
+#include "wx/timer.h"
 
 
 /*
@@ -34,23 +28,24 @@
 #define wxSPLASH_TIMEOUT            0x04
 #define wxSPLASH_NO_TIMEOUT         0x00
 
-class WXDLLIMPEXP_ADV wxSplashScreenWindow;
+class WXDLLIMPEXP_FWD_ADV wxSplashScreenWindow;
 
 /*
  * wxSplashScreen
  */
 
-class WXDLLIMPEXP_ADV wxSplashScreen: public wxFrame
+class WXDLLIMPEXP_ADV wxSplashScreen: public wxFrame,
+                                      public wxEventFilter
 {
 public:
     // for RTTI macros only
-    wxSplashScreen() {};
+    wxSplashScreen() { Init(); }
     wxSplashScreen(const wxBitmap& bitmap, long splashStyle, int milliseconds,
                    wxWindow* parent, wxWindowID id,
                    const wxPoint& pos = wxDefaultPosition,
                    const wxSize& size = wxDefaultSize,
                    long style = wxSIMPLE_BORDER|wxFRAME_NO_TASKBAR|wxSTAY_ON_TOP);
-    ~wxSplashScreen();
+    virtual ~wxSplashScreen();
 
     void OnCloseWindow(wxCloseEvent& event);
     void OnNotify(wxTimerEvent& event);
@@ -59,7 +54,13 @@ public:
     wxSplashScreenWindow* GetSplashWindow() const { return m_window; }
     int GetTimeout() const { return m_milliseconds; }
 
+    // Override wxEventFilter method to hide splash screen on any user input.
+    virtual int FilterEvent(wxEvent& event);
+
 protected:
+    // Common part of all ctors.
+    void Init();
+
     wxSplashScreenWindow*   m_window;
     long                    m_splashStyle;
     int                     m_milliseconds;
@@ -67,7 +68,7 @@ protected:
 
     DECLARE_DYNAMIC_CLASS(wxSplashScreen)
     DECLARE_EVENT_TABLE()
-    DECLARE_NO_COPY_CLASS(wxSplashScreen)
+    wxDECLARE_NO_COPY_CLASS(wxSplashScreen);
 };
 
 /*
@@ -81,8 +82,6 @@ public:
 
     void OnPaint(wxPaintEvent& event);
     void OnEraseBackground(wxEraseEvent& event);
-    void OnMouseEvent(wxMouseEvent& event);
-    void OnChar(wxKeyEvent& event);
 
     void SetBitmap(const wxBitmap& bitmap) { m_bitmap = bitmap; }
     wxBitmap& GetBitmap() { return m_bitmap; }
@@ -91,7 +90,7 @@ protected:
     wxBitmap    m_bitmap;
 
     DECLARE_EVENT_TABLE()
-    DECLARE_NO_COPY_CLASS(wxSplashScreenWindow)
+    wxDECLARE_NO_COPY_CLASS(wxSplashScreenWindow);
 };