Not all implementations of wxMDIChildFrame derive from wxFrame

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

diff --git a/include/wx/window.h b/include/wx/window.h
index 247786e0900fd928f3179d776d0294bfb616fd32..06b9ad44d464664cad1b5a0223ea99acc2d4ab28 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -48,9 +48,9 @@
 // compiled in - it should only be used when building real wxFoo
 #ifdef __WXUNIVERSAL__
     #define wxUSE_MENUS_NATIVE 0
 // compiled in - it should only be used when building real wxFoo
 #ifdef __WXUNIVERSAL__
     #define wxUSE_MENUS_NATIVE 0

-#else // __WXMSW__
+#else // !__WXUNIVERSAL__

     #define wxUSE_MENUS_NATIVE wxUSE_MENUS
     #define wxUSE_MENUS_NATIVE wxUSE_MENUS

-#endif // __WXUNIVERSAL__/__WXMSW__
+#endif // __WXUNIVERSAL__/!__WXUNIVERSAL__

 
 // ----------------------------------------------------------------------------
 // forward declarations
 
 // ----------------------------------------------------------------------------
 // forward declarations


@@ -102,6 +102,10 @@ enum wxWindowVariant
     wxWINDOW_VARIANT_MAX
 };
 
     wxWINDOW_VARIANT_MAX
 };
 

+#if wxUSE_SYSTEM_OPTIONS
+    #define wxWINDOW_DEFAULT_VARIANT wxT("window-default-variant")
+#endif
+

 // ----------------------------------------------------------------------------
 // (pseudo)template list classes
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // (pseudo)template list classes
 // ----------------------------------------------------------------------------


@@ -112,7 +116,7 @@ WX_DECLARE_LIST_3(wxWindow, wxWindowBase, wxWindowList, wxWindowListNode, class
 // global variables
 // ----------------------------------------------------------------------------
 
 // global variables
 // ----------------------------------------------------------------------------
 

-WXDLLEXPORT_DATA(extern wxWindowList) wxTopLevelWindows;
+extern WXDLLEXPORT_DATA(wxWindowList) wxTopLevelWindows;

 
 // ----------------------------------------------------------------------------
 // wxWindowBase is the base class for all GUI controls/widgets, this is the public
 
 // ----------------------------------------------------------------------------
 // wxWindowBase is the base class for all GUI controls/widgets, this is the public


@@ -193,7 +197,7 @@ public:
 
 
         // window id uniquely identifies the window among its siblings unless
 
 
         // window id uniquely identifies the window among its siblings unless

-        // it is -1 which means "don't care"
+        // it is wxID_ANY which means "don't care"

     void SetId( wxWindowID winid ) { m_windowId = winid; }
     wxWindowID GetId() const { return m_windowId; }
 
     void SetId( wxWindowID winid ) { m_windowId = winid; }
     wxWindowID GetId() const { return m_windowId; }
 


@@ -216,7 +220,7 @@ public:
         {  DoSetSize(x, y, width, height, sizeFlags); }
 
     void SetSize( int width, int height )
         {  DoSetSize(x, y, width, height, sizeFlags); }
 
     void SetSize( int width, int height )

-        { DoSetSize( -1, -1, width, height, wxSIZE_USE_EXISTING ); }
+        { DoSetSize( wxDefaultCoord, wxDefaultCoord, width, height, wxSIZE_USE_EXISTING ); }

 
     void SetSize( const wxSize& size )
         { SetSize( size.x, size.y); }
 
     void SetSize( const wxSize& size )
         { SetSize( size.x, size.y); }


@@ -225,7 +229,7 @@ public:
         { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); }
 
     void Move(int x, int y, int flags = wxSIZE_USE_EXISTING)
         { DoSetSize(rect.x, rect.y, rect.width, rect.height, sizeFlags); }
 
     void Move(int x, int y, int flags = wxSIZE_USE_EXISTING)

-        { DoSetSize(x, y, -1, -1, flags); }
+        { DoSetSize(x, y, wxDefaultCoord, wxDefaultCoord, flags); }

 
     void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING)
         { Move(pt.x, pt.y, flags); }
 
     void Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING)
         { Move(pt.x, pt.y, flags); }


@@ -313,10 +317,10 @@ public:
 
         // reset the cached best size value so it will be recalculated the
         // next time it is needed.
 
         // reset the cached best size value so it will be recalculated the
         // next time it is needed.

-    void InvalidateBestSize() { m_bestSizeCache = wxDefaultSize; }
+    void InvalidateBestSize();

     void CacheBestSize(const wxSize& size) const
         { wxConstCast(this, wxWindowBase)->m_bestSizeCache = size; }
     void CacheBestSize(const wxSize& size) const
         { wxConstCast(this, wxWindowBase)->m_bestSizeCache = size; }

-    
+

         // There are times (and windows) where 'Best' size and 'Min' size
         // are vastly out of sync.  This should be remedied somehow, but in
         // the meantime, this method will return the larger of BestSize
         // There are times (and windows) where 'Best' size and 'Min' size
         // are vastly out of sync.  This should be remedied somehow, but in
         // the meantime, this method will return the larger of BestSize


@@ -332,7 +336,7 @@ public:
         // minimum size, giving priority to the min size components, and
         // returns the results.
     wxSize GetBestFittingSize() const;
         // minimum size, giving priority to the min size components, and
         // returns the results.
     wxSize GetBestFittingSize() const;

-    
+

         // A 'Smart' SetSize that will fill in default size values with 'best'
         // size.  Sets the minsize to what was passed in.
     void SetBestFittingSize(const wxSize& size=wxDefaultSize);
         // A 'Smart' SetSize that will fill in default size values with 'best'
         // size.  Sets the minsize to what was passed in.
     void SetBestFittingSize(const wxSize& size=wxDefaultSize);


@@ -359,19 +363,27 @@ public:
 
         // set min/max size of the window
     virtual void SetSizeHints( int minW, int minH,
 
         // set min/max size of the window
     virtual void SetSizeHints( int minW, int minH,

-                               int maxW = -1, int maxH = -1,
-                               int incW = -1, int incH = -1 );
+                               int maxW = wxDefaultCoord, int maxH = wxDefaultCoord,
+                               int incW = wxDefaultCoord, int incH = wxDefaultCoord )
+    {
+        DoSetSizeHints(minW, minH, maxW, maxH, incW, incH);
+    }
+

     void SetSizeHints( const wxSize& minSize,
                        const wxSize& maxSize=wxDefaultSize,
                        const wxSize& incSize=wxDefaultSize)
     {
     void SetSizeHints( const wxSize& minSize,
                        const wxSize& maxSize=wxDefaultSize,
                        const wxSize& incSize=wxDefaultSize)
     {

-        SetSizeHints(minSize.x, minSize.y,
-                     maxSize.x, maxSize.y,
-                     incSize.x, incSize.y);
+        DoSetSizeHints(minSize.x, minSize.y,
+                       maxSize.x, maxSize.y,
+                       incSize.x, incSize.y);

     }
 
     }
 

+    virtual void DoSetSizeHints(int minW, int minH,
+                                int maxW = wxDefaultCoord, int maxH = wxDefaultCoord,
+                               int incW = wxDefaultCoord, int incH = wxDefaultCoord );
+

     virtual void SetVirtualSizeHints( int minW, int minH,
     virtual void SetVirtualSizeHints( int minW, int minH,

-                                      int maxW = -1, int maxH = -1 );
+                                      int maxW = wxDefaultCoord, int maxH = wxDefaultCoord );

     void SetVirtualSizeHints( const wxSize& minSize,
                               const wxSize& maxSize=wxDefaultSize)
     {
     void SetVirtualSizeHints( const wxSize& minSize,
                               const wxSize& maxSize=wxDefaultSize)
     {


@@ -389,7 +401,7 @@ public:
 
     void SetMinSize(const wxSize& minSize) { SetSizeHints(minSize); }
     void SetMaxSize(const wxSize& maxSize) { SetSizeHints(GetMinSize(), maxSize); }
 
     void SetMinSize(const wxSize& minSize) { SetSizeHints(minSize); }
     void SetMaxSize(const wxSize& maxSize) { SetSizeHints(GetMinSize(), maxSize); }

-    
+

         // Methods for accessing the virtual size of a window.  For most
         // windows this is just the client area of the window, but for
         // some like scrolled windows it is more or less independent of
         // Methods for accessing the virtual size of a window.  For most
         // windows this is just the client area of the window, but for
         // some like scrolled windows it is more or less independent of


@@ -412,10 +424,10 @@ public:
 
         // Override these methods for windows that have a virtual size
         // independent of their client size.  eg. the virtual area of a
 
         // Override these methods for windows that have a virtual size
         // independent of their client size.  eg. the virtual area of a

-        // wxScrolledWindow.  Default is to alias VirtualSize to ClientSize.
+        // wxScrolledWindow.

 
     virtual void DoSetVirtualSize( int x, int y );
 
     virtual void DoSetVirtualSize( int x, int y );

-    virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
+    virtual wxSize DoGetVirtualSize() const;

 
         // Return the largest of ClientSize and BestSize (as determined
         // by a sizer, interior children, or other means)
 
         // Return the largest of ClientSize and BestSize (as determined
         // by a sizer, interior children, or other means)


@@ -440,8 +452,8 @@ public:
     virtual bool Enable( bool enable = true );
     bool Disable() { return Enable(false); }
 
     virtual bool Enable( bool enable = true );
     bool Disable() { return Enable(false); }
 

-    bool IsShown() const { return m_isShown; }
-    bool IsEnabled() const { return m_isEnabled; }
+    virtual bool IsShown() const { return m_isShown; }
+    virtual bool IsEnabled() const { return m_isEnabled; }

 
         // get/set window style (setting style won't update the window and so
         // is only useful for internal usage)
 
         // get/set window style (setting style won't update the window and so
         // is only useful for internal usage)


@@ -472,7 +484,7 @@ public:
 
         // Returns true if this class should have the background colour
         // changed to match the parent window's theme.  For example when a
 
         // Returns true if this class should have the background colour
         // changed to match the parent window's theme.  For example when a

-        // page is added to a notebook it and it's children may need to have
+        // page is added to a notebook it and its children may need to have

         // the colours adjusted depending on the current theme settings, but
         // not all windows/controls can do this without looking wrong.
     virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg))
         // the colours adjusted depending on the current theme settings, but
         // not all windows/controls can do this without looking wrong.
     virtual void ApplyParentThemeBackground(const wxColour& WXUNUSED(bg))


@@ -489,7 +501,9 @@ public:
     virtual void SetFocusFromKbd() { SetFocus(); }
 
         // return the window which currently has the focus or NULL
     virtual void SetFocusFromKbd() { SetFocus(); }
 
         // return the window which currently has the focus or NULL

-    static wxWindow *FindFocus() /* = 0: implement in derived classes */;
+    static wxWindow *FindFocus();
+
+    static wxWindow *DoFindFocus() /* = 0: implement in derived classes */;

 
         // can this window have focus?
     virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }
 
         // can this window have focus?
     virtual bool AcceptsFocus() const { return IsShown() && IsEnabled(); }


@@ -556,8 +570,8 @@ public:
 
         // find window among the descendants of this one either by id or by
         // name (return NULL if not found)
 
         // find window among the descendants of this one either by id or by
         // name (return NULL if not found)

-    wxWindow *FindWindow( long winid );
-    wxWindow *FindWindow( const wxString& name );
+    wxWindow *FindWindow(long winid) const;
+    wxWindow *FindWindow(const wxString& name) const;

 
         // Find a window among any window (all return NULL if not found)
     static wxWindow *FindWindowById( long winid, const wxWindow *parent = NULL );
 
         // Find a window among any window (all return NULL if not found)
     static wxWindow *FindWindowById( long winid, const wxWindow *parent = NULL );


@@ -678,7 +692,10 @@ public:
                           const wxRect *rect = (const wxRect *) NULL ) = 0;
 
         // a less awkward wrapper for Refresh
                           const wxRect *rect = (const wxRect *) NULL ) = 0;
 
         // a less awkward wrapper for Refresh

-    void RefreshRect(const wxRect& rect) { Refresh(true, &rect); }
+    void RefreshRect(const wxRect& rect, bool eraseBackground = true)
+    {
+        Refresh(eraseBackground, &rect);
+    }

 
         // repaint all invalid areas of the window immediately
     virtual void Update() { }
 
         // repaint all invalid areas of the window immediately
     virtual void Update() { }


@@ -742,6 +759,21 @@ public:
             m_inheritBgCol = false;
     }
     wxColour GetBackgroundColour() const;
             m_inheritBgCol = false;
     }
     wxColour GetBackgroundColour() const;

+    bool InheritsBackgroundColour() const
+    {
+        return m_inheritBgCol;
+    }
+    bool UseBgCol() const
+    {
+        return m_hasBgCol;
+    }
+
+    // if the window shouldn't inherit its colour from the parent, override
+    // this function to return true
+    //
+    // this is currently only used by wxMSW and wxUniv but should be useful for
+    // the other ports too
+    virtual bool ProvidesBackground() const { return false; }

 
     virtual bool SetForegroundColour(const wxColour& colour);
     void SetOwnForegroundColour(const wxColour& colour)
 
     virtual bool SetForegroundColour(const wxColour& colour);
     void SetOwnForegroundColour(const wxColour& colour)


@@ -751,6 +783,16 @@ public:
     }
     wxColour GetForegroundColour() const;
 
     }
     wxColour GetForegroundColour() const;
 

+        // Set/get the background style.
+        // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
+    virtual bool SetBackgroundStyle(wxBackgroundStyle style) { m_backgroundStyle = style; return true; }
+    virtual wxBackgroundStyle GetBackgroundStyle() const { return m_backgroundStyle; }
+
+        // returns true if the control has "transparent" areas such as a
+        // wxStaticText and wxCheckBox and the background should be adapted
+        // from a parent window
+    virtual bool HasTransparentBackground() { return false; }
+

         // set/retrieve the font for the window (SetFont() returns true if the
         // font really changed)
     virtual bool SetFont(const wxFont& font) = 0;
         // set/retrieve the font for the window (SetFont() returns true if the
         // font really changed)
     virtual bool SetFont(const wxFont& font) = 0;


@@ -906,6 +948,10 @@ public:
         // get the associated tooltip or NULL if none
     wxToolTip* GetToolTip() const { return m_tooltip; }
     wxString GetToolTipText() const ;
         // get the associated tooltip or NULL if none
     wxToolTip* GetToolTip() const { return m_tooltip; }
     wxString GetToolTipText() const ;

+#else
+        // make it much easier to compile apps in an environment
+        // that doesn't support tooltips, such as PocketPC
+    inline void SetToolTip( const wxString & WXUNUSED(tip) ) {}

 #endif // wxUSE_TOOLTIPS
 
     // drag and drop
 #endif // wxUSE_TOOLTIPS
 
     // drag and drop


@@ -1005,6 +1051,10 @@ public:
         // is only used for wxWin itself or for user code which wants to call
         // platform-specific APIs
     virtual WXWidget GetHandle() const = 0;
         // is only used for wxWin itself or for user code which wants to call
         // platform-specific APIs
     virtual WXWidget GetHandle() const = 0;

+        // associate the window with a new native handle
+    virtual void AssociateHandle(WXWidget WXUNUSED(handle)) { }
+        // dissociate the current native handle from the window
+    virtual void DissociateHandle() { }

 
 #if wxUSE_PALETTE
         // Store the palette used by DCs in wxWindow so that the dcs can share
 
 #if wxUSE_PALETTE
         // Store the palette used by DCs in wxWindow so that the dcs can share


@@ -1055,8 +1105,14 @@ protected:
     // Send the wxWindowDestroyEvent
     void SendDestroyEvent();
 
     // Send the wxWindowDestroyEvent
     void SendDestroyEvent();
 

+    // returns the main window of composite control; this is the window
+    // that FindFocus returns if the focus is in one of composite control's
+    // windows
+    virtual wxWindow *GetMainWindowOfCompositeControl()
+        { return (wxWindow*)this; }
+

     // the window id - a number which uniquely identifies a window among
     // the window id - a number which uniquely identifies a window among

-    // its siblings unless it is -1
+    // its siblings unless it is wxID_ANY

     wxWindowID           m_windowId;
 
     // the parent window of this window (or NULL) and the list of the children
     wxWindowID           m_windowId;
 
     // the parent window of this window (or NULL) and the list of the children


@@ -1065,7 +1121,7 @@ protected:
     wxWindowList         m_children;
 
     // the minimal allowed size for the window (no minimal size if variable(s)
     wxWindowList         m_children;
 
     // the minimal allowed size for the window (no minimal size if variable(s)

-    // contain(s) -1)
+    // contain(s) wxDefaultCoord)

     int                  m_minWidth,
                          m_minHeight,
                          m_maxWidth,
     int                  m_minWidth,
                          m_minHeight,
                          m_maxWidth,


@@ -1135,7 +1191,7 @@ protected:
     bool                 m_hasBgCol:1;
     bool                 m_hasFgCol:1;
     bool                 m_hasFont:1;
     bool                 m_hasBgCol:1;
     bool                 m_hasFgCol:1;
     bool                 m_hasFont:1;

-    
+

     // and should it be inherited by children?
     bool                 m_inheritBgCol:1;
     bool                 m_inheritFgCol:1;
     // and should it be inherited by children?
     bool                 m_inheritBgCol:1;
     bool                 m_inheritFgCol:1;


@@ -1146,7 +1202,7 @@ protected:
                          m_exStyle;
     wxString             m_windowName;
     bool                 m_themeEnabled;
                          m_exStyle;
     wxString             m_windowName;
     bool                 m_themeEnabled;

-
+    wxBackgroundStyle    m_backgroundStyle;

 #if wxUSE_PALETTE
     wxPalette            m_palette;
     bool                 m_hasCustomPalette;
 #if wxUSE_PALETTE
     wxPalette            m_palette;
     bool                 m_hasCustomPalette;


@@ -1172,8 +1228,8 @@ protected:
 
     // Get the default size for the new window if no explicit size given. TLWs
     // have their own default size so this is just for non top-level windows.
 
     // Get the default size for the new window if no explicit size given. TLWs
     // have their own default size so this is just for non top-level windows.

-    static int WidthDefault(int w) { return w == -1 ? 20 : w; }
-    static int HeightDefault(int h) { return h == -1 ? 20 : h; }
+    static int WidthDefault(int w) { return w == wxDefaultCoord ? 20 : w; }
+    static int HeightDefault(int h) { return h == wxDefaultCoord ? 20 : h; }

 
 
     // Used to save the results of DoGetBestSize so it doesn't need to be
 
 
     // Used to save the results of DoGetBestSize so it doesn't need to be


@@ -1183,9 +1239,9 @@ protected:
     // keep the old name for compatibility, at least until all the internal
     // usages of it are changed to SetBestFittingSize
     void SetBestSize(const wxSize& size) { SetBestFittingSize(size); }
     // keep the old name for compatibility, at least until all the internal
     // usages of it are changed to SetBestFittingSize
     void SetBestSize(const wxSize& size) { SetBestFittingSize(size); }

-        
+

     // set the initial window size if none is given (i.e. at least one of the
     // set the initial window size if none is given (i.e. at least one of the

-    // components of the size passed to ctor/Create() is -1)
+    // components of the size passed to ctor/Create() is wxDefaultCoord)

     //
     // normally just calls SetBestSize() for controls, but can be overridden
     // not to do it for the controls which have to do some additional
     //
     // normally just calls SetBestSize() for controls, but can be overridden
     // not to do it for the controls which have to do some additional


@@ -1193,7 +1249,7 @@ protected:
     // can be accurately calculated
     virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) {}
 
     // can be accurately calculated
     virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) {}
 

-    
+

 
     // more pure virtual functions
     // ---------------------------
 
     // more pure virtual functions
     // ---------------------------


@@ -1277,7 +1333,14 @@ private:
 // ----------------------------------------------------------------------------
 
 // include the declaration of the platform-specific class
 // ----------------------------------------------------------------------------
 
 // include the declaration of the platform-specific class

-#if defined(__WXMSW__)
+#if defined(__WXPALMOS__)
+    #ifdef __WXUNIVERSAL__
+        #define wxWindowNative wxWindowPalm
+    #else // !wxUniv
+        #define wxWindowPalm wxWindow
+    #endif // wxUniv/!wxUniv
+    #include "wx/palmos/window.h"
+#elif defined(__WXMSW__)

     #ifdef __WXUNIVERSAL__
         #define wxWindowNative wxWindowMSW
     #else // !wxUniv
     #ifdef __WXUNIVERSAL__
         #define wxWindowNative wxWindowMSW
     #else // !wxUniv


@@ -1356,13 +1419,13 @@ inline wxWindow *wxWindowBase::GetGrandParent() const
 
 // Find the wxWindow at the current mouse position, also returning the mouse
 // position.
 
 // Find the wxWindow at the current mouse position, also returning the mouse
 // position.

-WXDLLEXPORT extern wxWindow* wxFindWindowAtPointer(wxPoint& pt);
+extern WXDLLEXPORT wxWindow* wxFindWindowAtPointer(wxPoint& pt);

 
 // Get the current mouse position.
 
 // Get the current mouse position.

-WXDLLEXPORT extern wxPoint wxGetMousePosition();
+extern WXDLLEXPORT wxPoint wxGetMousePosition();

 
 // get the currently active window of this application or NULL
 
 // get the currently active window of this application or NULL

-WXDLLEXPORT extern wxWindow *wxGetActiveWindow();
+extern WXDLLEXPORT wxWindow *wxGetActiveWindow();

 
 // get the (first) top level parent window
 WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win);
 
 // get the (first) top level parent window
 WXDLLEXPORT wxWindow* wxGetTopLevelParent(wxWindow *win);


@@ -1379,7 +1442,7 @@ class WXDLLEXPORT wxWindowAccessible: public wxAccessible
 {
 public:
     wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); }
 {
 public:
     wxWindowAccessible(wxWindow* win): wxAccessible(win) { if (win) win->SetAccessible(this); }

-    virtual ~wxWindowAccessible() {};
+    virtual ~wxWindowAccessible() {}

 
 // Overridables
 
 
 // Overridables