mac paths updated

[wxWidgets.git] / interface / splash.h

diff --git a/interface/splash.h b/interface/splash.h
index 7a9bfb2ec4cf0af553f58c56105a19584f824859..ae408f6bb0c8fd157202bb257fb42bdeccf0510a 100644 (file)
--- a/interface/splash.h
+++ b/interface/splash.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        splash.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        splash.h

-// Purpose:     documentation for wxSplashScreen class
+// Purpose:     interface of wxSplashScreen

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,15 +9,15 @@
 /**
     @class wxSplashScreen
     @wxheader{splash.h}
 /**
     @class wxSplashScreen
     @wxheader{splash.h}

-    
+

     wxSplashScreen shows a window with a thin border, displaying a bitmap
     describing your
     application. Show it in application initialisation, and then either explicitly
     destroy
     it or let it time-out.
     wxSplashScreen shows a window with a thin border, displaying a bitmap
     describing your
     application. Show it in application initialisation, and then either explicitly
     destroy
     it or let it time-out.

-    
+

     Example usage:
     Example usage:

-    
+

     @code
     wxBitmap bitmap;
       if (bitmap.LoadFile("splash16.png", wxBITMAP_TYPE_PNG))
     @code
     wxBitmap bitmap;
       if (bitmap.LoadFile("splash16.png", wxBITMAP_TYPE_PNG))


@@ -29,7 +29,7 @@
       }
       wxYield();
     @endcode
       }
       wxYield();
     @endcode

-    
+

     @library{wxadv}
     @category{managedwnd}
 */
     @library{wxadv}
     @category{managedwnd}
 */


@@ -40,16 +40,13 @@ public:
         Construct the splash screen passing a bitmap, a style, a timeout, a window id,
         optional position
         and size, and a window style.
         Construct the splash screen passing a bitmap, a style, a timeout, a window id,
         optional position
         and size, and a window style.

-        
-        @e 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

-        
-        @e milliseconds is the timeout in milliseconds.
+        @a milliseconds is the timeout in milliseconds.

     */
     wxSplashScreen(const wxBitmap& bitmap, long splashStyle,
                    int milliseconds,
     */
     wxSplashScreen(const wxBitmap& bitmap, long splashStyle,
                    int milliseconds,


@@ -68,17 +65,17 @@ public:
         Returns the splash style (see wxSplashScreen() for
         details).
     */
         Returns the splash style (see wxSplashScreen() for
         details).
     */

-    long GetSplashStyle();
+    long GetSplashStyle() const;

 
     /**
         Returns the window used to display the bitmap.
     */
 
     /**
         Returns the window used to display the bitmap.
     */

-    wxSplashScreenWindow* GetSplashWindow();
+    wxSplashScreenWindow* GetSplashWindow() const;

 
     /**
         Returns the timeout in milliseconds.
     */
 
     /**
         Returns the timeout in milliseconds.
     */

-    int GetTimeout();
+    int GetTimeout() const;

 
     /**
         Reimplement this event handler if you want to set an application variable on
 
     /**
         Reimplement this event handler if you want to set an application variable on


@@ -86,3 +83,4 @@ public:
     */
     void OnCloseWindow(wxCloseEvent& event);
 };
     */
     void OnCloseWindow(wxCloseEvent& event);
 };

+