*** empty log message ***

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

diff --git a/include/wx/toplevel.h b/include/wx/toplevel.h
index 35de68a0a272574c5786b552c414f1713596e6e8..e2201ae8fd7fbe302d58101ef5b8b5b8280915b1 100644 (file)
--- a/include/wx/toplevel.h
+++ b/include/wx/toplevel.h
@@ -8,7 +8,7 @@
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 //                       Vaclav Slavik <vaclav@wxwidgets.org>
-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TOPLEVEL_BASE_H_
@@ -65,12 +65,14 @@ class WXDLLEXPORT wxTopLevelWindowBase;
 // "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
-#ifdef __WXWINCE__
-       #ifdef __SMARTPHONE__
-               #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE)
-       #else
-               #define wxDEFAULT_FRAME_STYLE (0)
-       #endif
+#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 | \
@@ -102,6 +104,13 @@ enum
                                wxFULLSCREEN_NOCAPTION
 };
 
+// Styles for RequestUserAttention
+enum
+{
+    wxUSER_ATTENTION_INFO = 1,
+    wxUSER_ATTENTION_ERROR = 2
+};
+
 // ----------------------------------------------------------------------------
 // wxTopLevelWindow: a top level (as opposed to child) window
 // ----------------------------------------------------------------------------
@@ -116,19 +125,19 @@ public:
     // 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;
 
-    // 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;
 
-    // return TRUE if the frame is iconized
+    // return true if the frame is iconized
     virtual bool IsIconized() const = 0;
 
     // get the frame icon
@@ -146,7 +155,7 @@ public:
     // 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;
 
     /*
@@ -158,21 +167,34 @@ public:
      */
 
     // 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.)
-    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); }
+
+#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();
-    virtual bool IsTopLevel() const { return TRUE; }
+    virtual bool IsTopLevel() const { return true; }
     virtual wxSize GetMaxSize() const;
 
     // event handlers
     void OnCloseWindow(wxCloseEvent& event);
-    void OnSize(wxSizeEvent& event);
+    void OnSize(wxSizeEvent& WXUNUSED(event)) { DoLayout(); }
 
     // this should go away, but for now it's called from docview.cpp,
     // so should be there for all platforms
@@ -190,21 +212,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
-        { 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;
 
-    // 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 == -1 ? GetDefaultSize().x : w; }
-    static int HeightDefault(int h) { return h == -1 ? GetDefaultSize().y : h; }
+    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;
@@ -215,7 +241,10 @@ protected:
 
 
 // include the real class declaration
-#if defined(__WXMSW__)
+#if defined(__PALMOS__)
+    #include "wx/palmos/toplevel.h"
+    #define wxTopLevelWindowNative wxTopLevelWindowPalm
+#elif defined(__WXMSW__)
     #include "wx/msw/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMSW
 #elif defined(__WXGTK__)