Split documentation of non-GUI wxEvent-related classes.

[wxWidgets.git] / interface / wx / splash.h

diff --git a/interface/wx/splash.h b/interface/wx/splash.h
index 8f1b0b51fdd4e5c7f539ace3992548f27851d1fb..9da9b593ff43ab7896ddbf54fcbe6ae964d0ae5f 100644 (file)
--- a/interface/wx/splash.h
+++ b/interface/wx/splash.h
@@ -3,22 +3,29 @@
 // Purpose:     interface of wxSplashScreen
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxSplashScreen
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+#define wxSPLASH_CENTRE_ON_PARENT   0x01
+#define wxSPLASH_CENTRE_ON_SCREEN   0x02
+#define wxSPLASH_NO_CENTRE          0x00
+#define wxSPLASH_TIMEOUT            0x04
+#define wxSPLASH_NO_TIMEOUT         0x00
+
+

 /**
     @class wxSplashScreen
 
     wxSplashScreen shows a window with a thin border, displaying a bitmap
 /**
     @class wxSplashScreen
 
     wxSplashScreen shows a window with a thin border, displaying a bitmap

-    describing your
-    application. Show it in application initialisation, and then either explicitly
-    destroy
+    describing your application.
+
+    Show it in application initialisation, and then either explicitly destroy

     it or let it time-out.
 
     Example usage:
 
     @code
     it or let it time-out.
 
     Example usage:
 
     @code

-    wxBitmap bitmap;
+      wxBitmap bitmap;

       if (bitmap.LoadFile("splash16.png", wxBITMAP_TYPE_PNG))
       {
           wxSplashScreen* splash = new wxSplashScreen(bitmap,
       if (bitmap.LoadFile("splash16.png", wxBITMAP_TYPE_PNG))
       {
           wxSplashScreen* splash = new wxSplashScreen(bitmap,


@@ -37,14 +44,15 @@ class wxSplashScreen : public wxFrame
 public:
     /**
         Construct the splash screen passing a bitmap, a style, a timeout, a window id,
 public:
     /**
         Construct the splash screen passing a bitmap, a style, a timeout, a window id,

-        optional position
-        and size, and a window style.
+        optional position and size, and a window style.
+

         @a splashStyle is a bitlist of some of the following:
         @a splashStyle is a bitlist of some of the following:

-         wxSPLASH_CENTRE_ON_PARENT
-         wxSPLASH_CENTRE_ON_SCREEN
-         wxSPLASH_NO_CENTRE
-         wxSPLASH_TIMEOUT
-         wxSPLASH_NO_TIMEOUT
+        - wxSPLASH_CENTRE_ON_PARENT
+        - wxSPLASH_CENTRE_ON_SCREEN
+        - wxSPLASH_NO_CENTRE
+        - wxSPLASH_TIMEOUT
+        - wxSPLASH_NO_TIMEOUT
+

         @a milliseconds is the timeout in milliseconds.
     */
     wxSplashScreen(const wxBitmap& bitmap, long splashStyle,
         @a milliseconds is the timeout in milliseconds.
     */
     wxSplashScreen(const wxBitmap& bitmap, long splashStyle,


@@ -58,11 +66,10 @@ public:
     /**
         Destroys the splash screen.
     */
     /**
         Destroys the splash screen.
     */

-    ~wxSplashScreen();
+    virtual ~wxSplashScreen();

 
     /**
 
     /**

-        Returns the splash style (see wxSplashScreen() for
-        details).
+        Returns the splash style (see wxSplashScreen() for details).

     */
     long GetSplashStyle() const;
 
     */
     long GetSplashStyle() const;