made wxList methods return compatibility_iterator instead of Node * to further reduce...

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

diff --git a/include/wx/toplevel.h b/include/wx/toplevel.h
index a193d5edd4a307bbf394df983f5a4d962828ffe2..bace093741a10b2527b15c4602a509bcda0fbb13 100644 (file)
--- a/include/wx/toplevel.h
+++ b/include/wx/toplevel.h
@@ -14,10 +14,6 @@
 #ifndef _WX_TOPLEVEL_BASE_H_
 #define _WX_TOPLEVEL_BASE_H_
 
 #ifndef _WX_TOPLEVEL_BASE_H_
 #define _WX_TOPLEVEL_BASE_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "toplevelbase.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------


@@ -25,8 +21,8 @@
 #include "wx/window.h"
 #include "wx/iconbndl.h"
 
 #include "wx/window.h"
 #include "wx/iconbndl.h"
 

-// the default names for various classs
-WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
+// the default names for various classes
+extern WXDLLEXPORT_DATA(const wxChar) wxFrameNameStr[];

 
 class WXDLLEXPORT wxTopLevelWindowBase;
 
 
 class WXDLLEXPORT wxTopLevelWindowBase;
 


@@ -66,13 +62,13 @@ class WXDLLEXPORT wxTopLevelWindowBase;
 // "close" but round instead of squared and just hides the applications
 // instead of closing it) in the title bar
 #if defined(__WXWINCE__)
 // "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)
+    #if defined(__SMARTPHONE__)
+        #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE)

     #elif defined(__WINCE_STANDARDSDK__)
     #elif defined(__WINCE_STANDARDSDK__)

-               #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE|wxCLOSE_BOX)
-       #else
-               #define wxDEFAULT_FRAME_STYLE (0)
-       #endif
+        #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE|wxCLOSE_BOX)
+    #else
+        #define wxDEFAULT_FRAME_STYLE (wxNO_BORDER)
+    #endif

 #else // !__WXWINCE__
     #define wxDEFAULT_FRAME_STYLE \
             (wxSYSTEM_MENU | \
 #else // !__WXWINCE__
     #define wxDEFAULT_FRAME_STYLE \
             (wxSYSTEM_MENU | \


@@ -125,19 +121,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


@@ -155,38 +151,51 @@ 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;
 

-    /*
-       for now we already have them in wxWindow, but this is wrong: these
-       methods really only make sense for wxTopLevelWindow!
-
+    // the title of the top level window: the text which the
+    // window shows usually at the top of the frame/dialog in dedicated bar

     virtual void SetTitle(const wxString& title) = 0;
     virtual wxString GetTitle() const = 0;
     virtual void SetTitle(const wxString& title) = 0;
     virtual wxString GetTitle() const = 0;

-     */

 
     // 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);
 
 
     // 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__
+
+    // centre the window on screen: this is just a shortcut
+    void CentreOnScreen(int dir = wxBOTH) { DoCentre(dir | wxCENTRE_ON_SCREEN); }
+    void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); }
+

 
     // 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;
 
     // event handlers
     void OnCloseWindow(wxCloseEvent& event);
     virtual wxSize GetMaxSize() const;
 
     // 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


@@ -201,24 +210,38 @@ protected:
     virtual void DoClientToScreen(int *x, int *y) const;
     virtual void DoScreenToClient(int *x, int *y) const;
 
     virtual void DoClientToScreen(int *x, int *y) const;
     virtual void DoScreenToClient(int *x, int *y) const;
 

+    // add support for wxCENTRE_ON_SCREEN
+    virtual void DoCentre(int dir);
+
+    // no need to do client to screen translation to get our position in screen
+    // coordinates: this is already the case
+    virtual void DoGetScreenPosition(int *x, int *y) const
+    {
+        DoGetPosition(x, y);
+    }
+

     // 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();
 
     // 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;
 
     // the frame icon
     wxIconBundle m_icons;


@@ -229,12 +252,18 @@ 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
     #include "wx/msw/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMSW

-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)

     #include "wx/gtk/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowGTK
     #include "wx/gtk/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowGTK

+#elif defined(__WXGTK__)
+    #include "wx/gtk1/toplevel.h"
+    #define wxTopLevelWindowNative wxTopLevelWindowGTK

 #elif defined(__WXX11__)
     #include "wx/x11/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowX11
 #elif defined(__WXX11__)
     #include "wx/x11/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowX11