Added (and documented) GetTraceMasks so userspace can probe the currently

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

diff --git a/include/wx/window.h b/include/wx/window.h
index 1e4736b97b7e6fbb2ab20aaf0de5658b01ec2b57..59a9769b1b5fe65d4d3e0ad0b006d380ff0c9c7e 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -2,7 +2,7 @@
 // Name:        wx/window.h
 // Purpose:     wxWindowBase class - the interface of wxWindow
 // Author:      Vadim Zeitlin
 // Name:        wx/window.h
 // Purpose:     wxWindowBase class - the interface of wxWindow
 // Author:      Vadim Zeitlin

-// Modified by:
+// Modified by: Ron Lee

 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWindows team
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWindows team


@@ -12,7 +12,7 @@
 #ifndef _WX_WINDOW_H_BASE_
 #define _WX_WINDOW_H_BASE_
 
 #ifndef _WX_WINDOW_H_BASE_
 #define _WX_WINDOW_H_BASE_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)

     #pragma interface "windowbase.h"
 #endif
 
     #pragma interface "windowbase.h"
 #endif
 


@@ -33,8 +33,8 @@
 #include "wx/validate.h"        // for wxDefaultValidator (always include it)
 
 #if wxUSE_PALETTE
 #include "wx/validate.h"        // for wxDefaultValidator (always include it)
 
 #if wxUSE_PALETTE

-       #include "wx/dcclient.h"
-       #include "wx/palette.h"
+    #include "wx/dcclient.h"
+    #include "wx/palette.h"

 #endif // wxUSE_PALETTE
 
 #if wxUSE_ACCEL
 #endif // wxUSE_PALETTE
 
 #if wxUSE_ACCEL


@@ -293,11 +293,44 @@ public:
                                int maxW = -1, int maxH = -1,
                                int incW = -1, int incH = -1 );
 
                                int maxW = -1, int maxH = -1,
                                int incW = -1, int incH = -1 );
 

-    int GetMinWidth() const { return m_minWidth; }
-    int GetMinHeight() const { return m_minHeight; }
+    virtual void SetVirtualSizeHints( int minW, int minH,
+                                      int maxW = -1, int maxH = -1 );
+
+    virtual int GetMinWidth() const { return m_minWidth; }
+    virtual int GetMinHeight() const { return m_minHeight; }

     int GetMaxWidth() const { return m_maxWidth; }
     int GetMaxHeight() const { return m_maxHeight; }
 
     int GetMaxWidth() const { return m_maxWidth; }
     int GetMaxHeight() const { return m_maxHeight; }
 

+        // Override this method to control the values given to Sizers etc.
+    virtual wxSize GetMaxSize() const { return wxSize( m_maxWidth, m_maxHeight ); }
+
+        // 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
+        // the screen window size.  You may override the DoXXXVirtual
+        // methods below for classes where that is is the case.
+
+    void SetVirtualSize( const wxSize &size ) { DoSetVirtualSize( size.x, size.y ); }
+    void SetVirtualSize( int x, int y ) { DoSetVirtualSize( x, y ); }
+
+    wxSize GetVirtualSize() const { return DoGetVirtualSize(); }
+    void GetVirtualSize( int *x, int *y ) const
+    {
+        wxSize s( DoGetVirtualSize() );
+
+        if( x )
+            *x = s.GetWidth();
+        if( y )
+            *y = s.GetHeight();
+    }
+
+        // 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.
+
+    virtual void DoSetVirtualSize( int x, int y );
+    virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
+

     // window state
     // ------------
 
     // window state
     // ------------
 


@@ -327,7 +360,7 @@ public:
 
         // extra style: the less often used style bits which can't be set with
         // SetWindowStyleFlag()
 
         // extra style: the less often used style bits which can't be set with
         // SetWindowStyleFlag()

-    void SetExtraStyle(long exStyle) { m_exStyle = exStyle; }
+    virtual void SetExtraStyle(long exStyle) { m_exStyle = exStyle; }

     long GetExtraStyle() const { return m_exStyle; }
 
         // make the window modal (all other windows unresponsive)
     long GetExtraStyle() const { return m_exStyle; }
 
         // make the window modal (all other windows unresponsive)


@@ -342,6 +375,9 @@ public:
         // set focus to this window
     virtual void SetFocus() = 0;
 
         // set focus to this window
     virtual void SetFocus() = 0;
 

+        // set focus to this window as the result of a keyboard action
+    virtual void SetFocusFromKbd() { SetFocus(); }
+

         // return the window which currently has the focus or NULL
     static wxWindow *FindFocus() /* = 0: implement in derived classes */;
 
         // return the window which currently has the focus or NULL
     static wxWindow *FindFocus() /* = 0: implement in derived classes */;
 


@@ -364,6 +400,9 @@ public:
     virtual wxWindow *SetDefaultItem(wxWindow * WXUNUSED(child))
         { return NULL; }
 
     virtual wxWindow *SetDefaultItem(wxWindow * WXUNUSED(child))
         { return NULL; }
 

+        // set this child as temporary default
+    virtual void SetTmpDefaultItem(wxWindow * WXUNUSED(win)) { }
+

     // parent/children relations
     // -------------------------
 
     // parent/children relations
     // -------------------------
 


@@ -384,14 +423,24 @@ public:
         // was changed, FALSE otherwise (error or newParent == oldParent)
     virtual bool Reparent( wxWindowBase *newParent );
 
         // was changed, FALSE otherwise (error or newParent == oldParent)
     virtual bool Reparent( wxWindowBase *newParent );
 

+        // implementation mostly
+    virtual void AddChild( wxWindowBase *child );
+    virtual void RemoveChild( wxWindowBase *child );
+
+    // looking for windows
+    // -------------------
+

         // find window among the descendants of this one either by id or by
         // name (return NULL if not found)
     wxWindow *FindWindow( long id );
     wxWindow *FindWindow( const wxString& name );
 
         // find window among the descendants of this one either by id or by
         // name (return NULL if not found)
     wxWindow *FindWindow( long id );
     wxWindow *FindWindow( const wxString& name );
 

-        // implementation mostly
-    virtual void AddChild( wxWindowBase *child );
-    virtual void RemoveChild( wxWindowBase *child );
+        // Find a window among any window (all return NULL if not found)
+    static wxWindow *FindWindowById( long id, const wxWindow *parent = NULL );
+    static wxWindow *FindWindowByName( const wxString& name,
+                                       const wxWindow *parent = NULL );
+    static wxWindow *FindWindowByLabel( const wxString& label,
+                                        const wxWindow *parent = NULL );

 
     // event handler stuff
     // -------------------
 
     // event handler stuff
     // -------------------


@@ -702,15 +751,6 @@ public:
     void SetConstraints( wxLayoutConstraints *constraints );
     wxLayoutConstraints *GetConstraints() const { return m_constraints; }
 
     void SetConstraints( wxLayoutConstraints *constraints );
     wxLayoutConstraints *GetConstraints() const { return m_constraints; }
 

-        // when using constraints, it makes sense to update children positions
-        // automatically whenever the window is resized - this is done if
-        // autoLayout is on
-    void SetAutoLayout( bool autoLayout ) { m_autoLayout = autoLayout; }
-    bool GetAutoLayout() const { return m_autoLayout; }
-
-        // do layout the window and its children
-    virtual bool Layout();
-

         // implementation only
     void UnsetConstraints(wxLayoutConstraints *c);
     wxWindowList *GetConstraintsInvolvedIn() const
         // implementation only
     void UnsetConstraints(wxLayoutConstraints *c);
     wxWindowList *GetConstraintsInvolvedIn() const


@@ -733,11 +773,26 @@ public:
     virtual void GetClientSizeConstraint(int *w, int *h) const ;
     virtual void GetPositionConstraint(int *x, int *y) const ;
 
     virtual void GetClientSizeConstraint(int *w, int *h) const ;
     virtual void GetPositionConstraint(int *x, int *y) const ;
 

+#endif // wxUSE_CONSTRAINTS
+
+        // when using constraints or sizers, it makes sense to update
+        // children positions automatically whenever the window is resized
+        // - this is done if autoLayout is on
+    void SetAutoLayout( bool autoLayout ) { m_autoLayout = autoLayout; }
+    bool GetAutoLayout() const { return m_autoLayout; }
+
+        // lay out the window and its children
+    virtual bool Layout();
+

         // sizers
         // sizers

-        // TODO: what are they and how do they work??
-    void SetSizer( wxSizer *sizer );
+    void SetSizer(wxSizer *sizer, bool deleteOld = TRUE );
+    void SetSizerAndFit( wxSizer *sizer, bool deleteOld = TRUE );
+

     wxSizer *GetSizer() const { return m_windowSizer; }
     wxSizer *GetSizer() const { return m_windowSizer; }

-#endif // wxUSE_CONSTRAINTS
+
+    // Track if this window is a member of a sizer
+    void SetContainingSizer(wxSizer* sizer) { m_containingSizer = sizer; }
+    wxSizer *GetContainingSizer() const { return m_containingSizer; }

 
     // backward compatibility
     // ----------------------
 
     // backward compatibility
     // ----------------------


@@ -770,18 +825,24 @@ public:
         // Store the palette used by DCs in wxWindow so that the dcs can share
         // a palette. And we can respond to palette messages.
     wxPalette GetPalette() const { return m_palette; }
         // Store the palette used by DCs in wxWindow so that the dcs can share
         // a palette. And we can respond to palette messages.
     wxPalette GetPalette() const { return m_palette; }

+

         // When palette is changed tell the DC to set the system palette to the
         // new one.
         // When palette is changed tell the DC to set the system palette to the
         // new one.

-    void SetPalette(wxPalette &pal) {
-                       m_custompalette=true;
-                       m_palette=pal;
-            wxWindowDC d((wxWindow *) this);
-                       d.SetPalette(pal);
-                       }
-    bool HasCustomPalette() { return m_custompalette; }
+    void SetPalette(const wxPalette& pal);
+
+        // return true if we have a specific palette
+    bool HasCustomPalette() const { return m_hasCustomPalette; }
+
+        // return the first parent window with a custom palette or NULL
+    wxWindow *GetAncestorWithCustomPalette() const;

 #endif // wxUSE_PALETTE
 
 protected:
 #endif // wxUSE_PALETTE
 
 protected:

+#if wxUSE_CONSTRAINTS
+    // satisfy the constraints for the windows but don't set the window sizes
+    void SatisfyConstraints();
+#endif // wxUSE_CONSTRAINTS
+

     // the window id - a number which uniquely identifies a window among
     // its siblings unless it is -1
     wxWindowID           m_windowId;
     // the window id - a number which uniquely identifies a window among
     // its siblings unless it is -1
     wxWindowID           m_windowId;


@@ -793,7 +854,10 @@ protected:
 
     // the minimal allowed size for the window (no minimal size if variable(s)
     // contain(s) -1)
 
     // the minimal allowed size for the window (no minimal size if variable(s)
     // contain(s) -1)

-    int                  m_minWidth, m_minHeight, m_maxWidth, m_maxHeight;
+    int                  m_minWidth,
+                         m_minHeight,
+                         m_maxWidth,
+                         m_maxHeight;

 
     // event handler for this window: usually is just 'this' but may be
     // changed with SetEventHandler()
 
     // event handler for this window: usually is just 'this' but may be
     // changed with SetEventHandler()


@@ -838,15 +902,16 @@ protected:
 
     // constraints this window is involved in
     wxWindowList        *m_constraintsInvolvedIn;
 
     // constraints this window is involved in
     wxWindowList        *m_constraintsInvolvedIn;

+#endif // wxUSE_CONSTRAINTS

 
 

-    // top level and the parent sizers
-    // TODO what's this and how does it work?)
+    // this window's sizer

     wxSizer             *m_windowSizer;
     wxSizer             *m_windowSizer;

-    wxWindowBase        *m_sizerParent;
+
+    // The sizer this window is a member of, if any
+    wxSizer             *m_containingSizer;

 
     // Layout() window automatically when its size changes?
     bool                 m_autoLayout:1;
 
     // Layout() window automatically when its size changes?
     bool                 m_autoLayout:1;

-#endif // wxUSE_CONSTRAINTS

 
     // window state
     bool                 m_isShown:1;
 
     // window state
     bool                 m_isShown:1;


@@ -864,12 +929,18 @@ protected:
     wxString             m_windowName;
     bool                 m_themeEnabled;
 
     wxString             m_windowName;
     bool                 m_themeEnabled;
 

-#ifdef wxUSE_PALETTE
+#if wxUSE_PALETTE

     wxPalette            m_palette;
     wxPalette            m_palette;

-    bool                 m_custompalette;
-#endif
+    bool                 m_hasCustomPalette;
+#endif // wxUSE_PALETTE

 
 

-protected:
+    // Virtual size (scrolling)
+    wxSize                m_virtualSize;
+
+    int                   m_minVirtualWidth;    // VirtualSizeHints
+    int                   m_minVirtualHeight;
+    int                   m_maxVirtualWidth;
+    int                   m_maxVirtualHeight;

 
     // common part of all ctors: it is not virtual because it is called from
     // ctor
 
     // common part of all ctors: it is not virtual because it is called from
     // ctor


@@ -959,12 +1030,8 @@ protected:
 
     // Makes an adjustment to the window position (for example, a frame that has
     // a toolbar that it manages itself).
 
     // Makes an adjustment to the window position (for example, a frame that has
     // a toolbar that it manages itself).

-    virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags);
+    virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags) const;

 
 

-#ifdef __WXPM__
-    // extra OS/2 layout processing
-    virtual void OS2Layout(int width, int height) { };
-#endif

 
 private:
 
 
 private:
 


@@ -1070,8 +1137,12 @@ WXDLLEXPORT extern wxPoint wxGetMousePosition();
 // get the currently active window of this application or NULL
 WXDLLEXPORT extern wxWindow *wxGetActiveWindow();
 
 // get the currently active window of this application or NULL
 WXDLLEXPORT extern wxWindow *wxGetActiveWindow();
 

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

 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
 inline int NewControlId() { return wxWindowBase::NewControlId(); }
 
 #endif
     // _WX_WINDOW_H_BASE_
 // deprecated (doesn't start with 'wx' prefix), use wxWindow::NewControlId()
 inline int NewControlId() { return wxWindowBase::NewControlId(); }
 
 #endif
     // _WX_WINDOW_H_BASE_

+