update from James Bishop

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

diff --git a/include/wx/toplevel.h b/include/wx/toplevel.h
index 9eb6f10f0c1426893224433f33288600031d75a5..bfbe0ac8e46320381d191642bd0e967ce2a6ff9c 100644 (file)
--- a/include/wx/toplevel.h
+++ b/include/wx/toplevel.h
@@ -7,26 +7,26 @@
 // 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
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TOPLEVEL_BASE_H_
 #define _WX_TOPLEVEL_BASE_H_
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TOPLEVEL_BASE_H_
 #define _WX_TOPLEVEL_BASE_H_
 

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

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

-#ifdef __GNUG__
-    #pragma interface "toplevelbase.h"
-#endif
-

 #include "wx/window.h"
 #include "wx/window.h"

-#include "wx/icon.h"
+#include "wx/iconbndl.h"

 
 // the default names for various classs
 
 // 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
 


@@ -47,22 +98,17 @@ enum
     wxFULLSCREEN_NOSTATUSBAR = 0x0004,
     wxFULLSCREEN_NOBORDER    = 0x0008,
     wxFULLSCREEN_NOCAPTION   = 0x0010,
     wxFULLSCREEN_NOSTATUSBAR = 0x0004,
     wxFULLSCREEN_NOBORDER    = 0x0008,
     wxFULLSCREEN_NOCAPTION   = 0x0010,

-    
-    wxFULLSCREEN_ALL         = wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR | 
-                               wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER | 
+
+    wxFULLSCREEN_ALL         = wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR |
+                               wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER |

                                wxFULLSCREEN_NOCAPTION
 };
 
                                wxFULLSCREEN_NOCAPTION
 };
 

-// Flags for interactive frame manipulation functions (only in wxUniversal):
+// Styles for RequestUserAttention

 enum
 {
 enum
 {

-    wxINTERACTIVE_MOVE           = 0x00000001,
-    wxINTERACTIVE_RESIZE         = 0x00000002,
-    wxINTERACTIVE_RESIZE_S       = 0x00000010,
-    wxINTERACTIVE_RESIZE_N       = 0x00000020,
-    wxINTERACTIVE_RESIZE_W       = 0x00000040,
-    wxINTERACTIVE_RESIZE_E       = 0x00000080,
-    wxINTERACTIVE_WAIT_FOR_INPUT = 0x10000000
+    wxUSER_ATTENTION_INFO = 1,
+    wxUSER_ATTENTION_ERROR = 2

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -74,39 +120,42 @@ class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow
 public:
     // construction
     wxTopLevelWindowBase();
 public:
     // construction
     wxTopLevelWindowBase();

-
-#ifdef __DARWIN__
-    virtual ~wxTopLevelWindowBase() {}
-#endif
+    virtual ~wxTopLevelWindowBase();

 
     // 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

-    const wxIcon& GetIcon() const { return m_icon; }
+    const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); }
+
+    // get the frame icons
+    const wxIconBundle& GetIcons() const { return m_icons; }

 
     // set the frame icon
 
     // set the frame icon

-    virtual void SetIcon(const wxIcon& icon) { m_icon = icon; }
+    virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); }
+
+    // set the frame icons
+    virtual void SetIcons(const wxIconBundle& icons ) { m_icons = icons; }

 
     // 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;
 
     /*


@@ -117,65 +166,112 @@ public:
     virtual wxString GetTitle() const = 0;
      */
 
     virtual wxString GetTitle() const = 0;
      */
 

-    // old functions, use the new ones instead!
-#if WXWIN_COMPATIBILITY_2
-    bool Iconized() const { return IsIconized(); }
-#endif // WXWIN_COMPATIBILITY_2
+    // Set the shape of the window to the given region.
+    // Returns true if the platform supports this feature (and the
+    // operation is successful.)
+    virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return false; }

 
 

-    
-#ifdef __WXUNIVERSAL__
-    // move/resize the frame interactively, i.e. let the user do it
-    virtual void InteractiveMove(int flags = wxINTERACTIVE_MOVE);
-#endif
+    // 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();
 
     // 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 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
     void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
 
 
     // this should go away, but for now it's called from docview.cpp,
     // so should be there for all platforms
     void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
 

+    // do the window-specific processing after processing the update event
+    virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
+

 protected:
     // the frame client to screen translation should take account of the
     // toolbar which may shift the origin of the client area
     virtual void DoClientToScreen(int *x, int *y) const;
     virtual void DoScreenToClient(int *x, int *y) const;
 
 protected:
     // the frame client to screen translation should take account of the
     // toolbar which may shift the origin of the client area
     virtual void DoClientToScreen(int *x, int *y) const;
     virtual void DoScreenToClient(int *x, int *y) const;
 

-    // send the iconize event, return TRUE if processed
-    bool SendIconizeEvent(bool iconized = TRUE);
-
-    // the frame icon
-    wxIcon m_icon;
-

     // test whether this window makes part of the frame
     // (menubar, toolbar and statusbar are excluded from automatic layout)
     // 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; }
+    virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const
+        { 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);
+
+    // 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;

 
 

+    DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase)

     DECLARE_EVENT_TABLE()
 };
 
 
 // include the real class declaration
     DECLARE_EVENT_TABLE()
 };
 
 
 // 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/gtk/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowGTK
     #include "wx/msw/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMSW
 #elif defined(__WXGTK__)
     #include "wx/gtk/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowGTK

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

 #elif defined(__WXMGL__)
     #include "wx/mgl/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMGL
 #elif defined(__WXMAC__)
     #include "wx/mac/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMac
 #elif defined(__WXMGL__)
     #include "wx/mgl/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMGL
 #elif defined(__WXMAC__)
     #include "wx/mac/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMac

+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/toplevel.h"
+    #define wxTopLevelWindowNative wxTopLevelWindowCocoa
+#elif defined(__WXPM__)
+    #include "wx/os2/toplevel.h"
+    #define wxTopLevelWindowNative wxTopLevelWindowOS2
+#elif defined(__WXMOTIF__)
+    #include "wx/motif/toplevel.h"
+    #define wxTopLevelWindowNative wxTopLevelWindowMotif

 #endif
 
 #ifdef __WXUNIVERSAL__
 #endif
 
 #ifdef __WXUNIVERSAL__


@@ -188,7 +284,7 @@ protected:
             // construction
             wxTopLevelWindow() { Init(); }
             wxTopLevelWindow(wxWindow *parent,
             // construction
             wxTopLevelWindow() { Init(); }
             wxTopLevelWindow(wxWindow *parent,

-                       wxWindowID id,
+                       wxWindowID winid,

                        const wxString& title,
                        const wxPoint& pos = wxDefaultPosition,
                        const wxSize& size = wxDefaultSize,
                        const wxString& title,
                        const wxPoint& pos = wxDefaultPosition,
                        const wxSize& size = wxDefaultSize,


@@ -196,10 +292,10 @@ protected:
                        const wxString& name = wxFrameNameStr)
             {
                 Init();
                        const wxString& name = wxFrameNameStr)
             {
                 Init();

-                Create(parent, id, title, pos, size, style, name);
+                Create(parent, winid, title, pos, size, style, name);

             }
 
             }
 

-            DECLARE_DYNAMIC_CLASS(wxTopLevelWindow)
+            DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow)

         };
     #endif // wxTopLevelWindowNative
 #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
         };
     #endif // wxTopLevelWindowNative
 #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__