update from James Bishop

[wxWidgets.git] / include / wx / toplevel.h

diff --git a/include/wx/toplevel.h b/include/wx/toplevel.h
index db7ce019671b32e399ed713429d5725ab9b6f92d..bfbe0ac8e46320381d191642bd0e967ce2a6ff9c 100644 (file)
--- a/include/wx/toplevel.h
+++ b/include/wx/toplevel.h
@@ -7,7 +7,7 @@
 // Created:     06.08.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     06.08.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-//                       Vaclav Slavik <vaclav@wxwindows.org>
+//                       Vaclav Slavik <vaclav@wxwidgets.org>

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 


@@ -26,7 +26,7 @@
 #include "wx/iconbndl.h"
 
 // the default names for various classs
 #include "wx/iconbndl.h"
 
 // the default names for various classs

-WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
+extern WXDLLEXPORT_DATA(const wxChar*) wxFrameNameStr;

 
 class WXDLLEXPORT wxTopLevelWindowBase;
 
 
 class WXDLLEXPORT wxTopLevelWindowBase;
 


@@ -34,6 +34,57 @@ class WXDLLEXPORT wxTopLevelWindowBase;
 // constants
 // ----------------------------------------------------------------------------
 
 // constants
 // ----------------------------------------------------------------------------
 

+// style common to both wxFrame and wxDialog
+#define wxSTAY_ON_TOP           0x8000
+#define wxICONIZE               0x4000
+#define wxMINIMIZE              wxICONIZE
+#define wxMAXIMIZE              0x2000
+#define wxCLOSE_BOX             0x1000
+
+#define wxSYSTEM_MENU           0x0800
+#define wxMINIMIZE_BOX          0x0400
+#define wxMAXIMIZE_BOX          0x0200
+#define wxTINY_CAPTION_HORIZ    0x0100
+#define wxTINY_CAPTION_VERT     0x0080
+#define wxRESIZE_BORDER         0x0040
+
+// deprecated versions defined for compatibility reasons
+#define wxRESIZE_BOX            wxMAXIMIZE_BOX
+#define wxTHICK_FRAME           wxRESIZE_BORDER
+
+// obsolete styles, unused any more
+#define wxDIALOG_MODAL          0
+#define wxDIALOG_MODELESS       0
+#define wxNO_3D                 0
+#define wxUSER_COLOURS          0
+
+// default style
+//
+// under Windows CE (at least when compiling with eVC 4) we should create
+// top level windows without any styles at all for them to appear
+// "correctly", i.e. as full screen windows with a "hide" button (same as
+// "close" but round instead of squared and just hides the applications
+// instead of closing it) in the title bar
+#if defined(__WXWINCE__)
+    #if defined(__SMARTPHONE__)
+        #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE)
+    #elif defined(__WINCE_STANDARDSDK__)
+        #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE|wxCLOSE_BOX)
+    #else
+        #define wxDEFAULT_FRAME_STYLE (0)
+    #endif
+#else // !__WXWINCE__
+    #define wxDEFAULT_FRAME_STYLE \
+            (wxSYSTEM_MENU | \
+             wxRESIZE_BORDER | \
+             wxMINIMIZE_BOX | \
+             wxMAXIMIZE_BOX | \
+             wxCLOSE_BOX | \
+             wxCAPTION | \
+             wxCLIP_CHILDREN)
+#endif
+
+

 // Dialogs are created in a special way
 #define wxTOPLEVEL_EX_DIALOG        0x00000008
 
 // Dialogs are created in a special way
 #define wxTOPLEVEL_EX_DIALOG        0x00000008
 


@@ -53,6 +104,13 @@ enum
                                wxFULLSCREEN_NOCAPTION
 };
 
                                wxFULLSCREEN_NOCAPTION
 };
 

+// Styles for RequestUserAttention
+enum
+{
+    wxUSER_ATTENTION_INFO = 1,
+    wxUSER_ATTENTION_ERROR = 2
+};
+

 // ----------------------------------------------------------------------------
 // wxTopLevelWindow: a top level (as opposed to child) window
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxTopLevelWindow: a top level (as opposed to child) window
 // ----------------------------------------------------------------------------


@@ -67,19 +125,19 @@ public:
     // top level wnd state
     // --------------------
 
     // top level wnd state
     // --------------------
 

-    // maximize = TRUE => maximize, otherwise - restore
-    virtual void Maximize(bool maximize = TRUE) = 0;
+    // maximize = true => maximize, otherwise - restore
+    virtual void Maximize(bool maximize = true) = 0;

 
     // undo Maximize() or Iconize()
     virtual void Restore() = 0;
 
 
     // undo Maximize() or Iconize()
     virtual void Restore() = 0;
 

-    // iconize = TRUE => iconize, otherwise - restore
-    virtual void Iconize(bool iconize = TRUE) = 0;
+    // iconize = true => iconize, otherwise - restore
+    virtual void Iconize(bool iconize = true) = 0;

 
 

-    // return TRUE if the frame is maximized
+    // return true if the frame is maximized

     virtual bool IsMaximized() const = 0;
 
     virtual bool IsMaximized() const = 0;
 

-    // return TRUE if the frame is iconized
+    // return true if the frame is iconized

     virtual bool IsIconized() const = 0;
 
     // get the frame icon
     virtual bool IsIconized() const = 0;
 
     // get the frame icon


@@ -97,7 +155,7 @@ public:
     // maximize the window to cover entire screen
     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
 
     // maximize the window to cover entire screen
     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
 

-    // return TRUE if the frame is in fullscreen mode
+    // return true if the frame is in fullscreen mode

     virtual bool IsFullScreen() const = 0;
 
     /*
     virtual bool IsFullScreen() const = 0;
 
     /*


@@ -109,26 +167,38 @@ public:
      */
 
     // Set the shape of the window to the given region.
      */
 
     // Set the shape of the window to the given region.

-    // Returns TRUE if the platform supports this feature (and the
+    // Returns true if the platform supports this feature (and the

     // operation is successful.)
     // operation is successful.)

-    virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return FALSE; }
+    virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return false; }
+
+    // Attracts the users attention to this window if the application is
+    // inactive (should be called when a background event occurs)
+    virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
+
+    // Is this the active frame (highlighted in the taskbar)?
+    virtual bool IsActive()
+        { return (wxGetTopLevelParent(FindFocus()) == this); }

 
 

-    // old functions, use the new ones instead!
-#if WXWIN_COMPATIBILITY_2
-    bool Iconized() const { return IsIconized(); }
-#endif // WXWIN_COMPATIBILITY_2
+#if defined(__SMARTPHONE__)
+    virtual void SetLeftMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
+    virtual void SetRightMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
+#endif // __SMARTPHONE__

 
     // implementation only from now on
     // -------------------------------
 
     // override some base class virtuals
     virtual bool Destroy();
 
     // implementation only from now on
     // -------------------------------
 
     // override some base class virtuals
     virtual bool Destroy();

-    virtual bool IsTopLevel() const { return TRUE; }
+    virtual bool IsTopLevel() const { return true; }

     virtual wxSize GetMaxSize() const;
     virtual wxSize GetMaxSize() const;

+    virtual bool ProvidesBackground() const { return true; }

 
     // event handlers
     void OnCloseWindow(wxCloseEvent& event);
 
     // event handlers
     void OnCloseWindow(wxCloseEvent& event);

-    void OnSize(wxSizeEvent& event);
+    void OnSize(wxSizeEvent& WXUNUSED(event)) { DoLayout(); }
+
+    // Get rect to be used to center top-level children
+    virtual void GetRectForTopLevelChildren(int *x, int *y, int *w, int *h);

 
     // this should go away, but for now it's called from docview.cpp,
     // so should be there for all platforms
 
     // this should go away, but for now it's called from docview.cpp,
     // so should be there for all platforms


@@ -146,14 +216,25 @@ protected:
     // test whether this window makes part of the frame
     // (menubar, toolbar and statusbar are excluded from automatic layout)
     virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const
     // test whether this window makes part of the frame
     // (menubar, toolbar and statusbar are excluded from automatic layout)
     virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const

-        { return FALSE; }
+        { return false; }

 
     // check if we should exit the program after deleting this top level
     // window (this is used in common dtor and wxMSW code)
     bool IsLastBeforeExit() const;
 
 
     // check if we should exit the program after deleting this top level
     // window (this is used in common dtor and wxMSW code)
     bool IsLastBeforeExit() const;
 

-    // send the iconize event, return TRUE if processed
-    bool SendIconizeEvent(bool iconized = TRUE);
+    // send the iconize event, return true if processed
+    bool SendIconizeEvent(bool iconized = true);
+
+    // do TLW-specific layout: we resize our unique child to fill the entire
+    // client area
+    void DoLayout();
+
+    // Get the default size for the new window if no explicit size given. If
+    // there are better default sizes then these can be changed, just as long
+    // as they are not too small for TLWs (and not larger than screen).
+    static wxSize GetDefaultSize();
+    static int WidthDefault(int w) { return w == wxDefaultCoord ? GetDefaultSize().x : w; }
+    static int HeightDefault(int h) { return h == wxDefaultCoord ? GetDefaultSize().y : h; }

 
     // the frame icon
     wxIconBundle m_icons;
 
     // the frame icon
     wxIconBundle m_icons;


@@ -164,7 +245,10 @@ protected:
 
 
 // include the real class declaration
 
 
 // include the real class declaration

-#if defined(__WXMSW__)
+#if defined(__WXPALMOS__)
+    #include "wx/palmos/toplevel.h"
+    #define wxTopLevelWindowNative wxTopLevelWindowPalm
+#elif defined(__WXMSW__)

     #include "wx/msw/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMSW
 #elif defined(__WXGTK__)
     #include "wx/msw/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMSW
 #elif defined(__WXGTK__)