Committed Jaako's renderer patch

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

diff --git a/include/wx/msw/window.h b/include/wx/msw/window.h
index d445002683f33cdd222494a3acf56d0e84254f42..01232d1ac9a8d2c9b1e9db3932137082365d61cb 100644 (file)
--- a/include/wx/msw/window.h
+++ b/include/wx/msw/window.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/msw/window.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/msw/window.h

-// Purpose:     wxWindow class
+// Purpose:     wxWindowMSW class

 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin on 13.05.99: complete refont of message handling,
 //              elimination of Default(), ...
 // Author:      Julian Smart
 // Modified by: Vadim Zeitlin on 13.05.99: complete refont of message handling,
 //              elimination of Default(), ...


@@ -13,31 +13,18 @@
 #ifndef _WX_WINDOW_H_
 #define _WX_WINDOW_H_
 
 #ifndef _WX_WINDOW_H_
 #define _WX_WINDOW_H_
 

-// ---------------------------------------------------------------------------
-// headers
-// ---------------------------------------------------------------------------
-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "window.h"
-#endif
-
-// [at least] some version of Windows send extra mouse move messages after
-// a mouse click or a key press - to temporarily fix this problem, set the
-// define below to 1
-//
-// a better solution should be found later...
-#define wxUSE_MOUSEEVENT_HACK 0
-

 // ---------------------------------------------------------------------------
 // constants
 // ---------------------------------------------------------------------------
 
 // ---------------------------------------------------------------------------
 // constants
 // ---------------------------------------------------------------------------
 

-// FIXME does anybody use those? they're unused by wxWidgets...
+#if WXWIN_COMPATIBILITY_2_4
+// they're unused by wxWidgets...

 enum
 {
     wxKEY_SHIFT = 1,
     wxKEY_CTRL  = 2
 };
 enum
 {
     wxKEY_SHIFT = 1,
     wxKEY_CTRL  = 2
 };

+#endif

 
 // ---------------------------------------------------------------------------
 // wxWindow declaration for MSW
 
 // ---------------------------------------------------------------------------
 // wxWindow declaration for MSW


@@ -45,6 +32,12 @@ enum
 
 class WXDLLEXPORT wxWindowMSW : public wxWindowBase
 {
 
 class WXDLLEXPORT wxWindowMSW : public wxWindowBase
 {

+    friend class wxSpinCtrl;
+    friend class wxSlider;
+    friend class wxRadioBox;
+#if defined __VISUALC__ && __VISUALC__ <= 1200
+    friend class wxWindowMSW;
+#endif

 public:
     wxWindowMSW() { Init(); }
 
 public:
     wxWindowMSW() { Init(); }
 


@@ -69,8 +62,8 @@ public:
                 const wxString& name = wxPanelNameStr);
 
     // implement base class pure virtuals
                 const wxString& name = wxPanelNameStr);
 
     // implement base class pure virtuals

-    virtual void SetTitle( const wxString& title);
-    virtual wxString GetTitle() const;
+    virtual void SetLabel(const wxString& label);
+    virtual wxString GetLabel() const;

 
     virtual void Raise();
     virtual void Lower();
 
     virtual void Raise();
     virtual void Lower();


@@ -104,10 +97,6 @@ public:
                                const wxFont *theFont = (const wxFont *) NULL)
                                const;
 
                                const wxFont *theFont = (const wxFont *) NULL)
                                const;
 

-#if wxUSE_MENUS_NATIVE
-    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
-#endif // wxUSE_MENUS_NATIVE
-

     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
                                int range, bool refresh = true );
     virtual void SetScrollPos( int orient, int pos, bool refresh = true );
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
                                int range, bool refresh = true );
     virtual void SetScrollPos( int orient, int pos, bool refresh = true );


@@ -148,6 +137,11 @@ public:
     virtual bool UnregisterHotKey(int hotkeyId);
 #endif // wxUSE_HOTKEY
 
     virtual bool UnregisterHotKey(int hotkeyId);
 #endif // wxUSE_HOTKEY
 

+#ifdef __POCKETPC__
+    bool IsContextMenuEnabled() const { return m_contextMenuEnabled; }
+    void EnableContextMenu(bool enable = true) { m_contextMenuEnabled = enable; }
+#endif
+

     // window handle stuff
     // -------------------
 
     // window handle stuff
     // -------------------
 


@@ -158,6 +152,9 @@ public:
     void AssociateHandle(WXWidget handle);
     void DissociateHandle();
 
     void AssociateHandle(WXWidget handle);
     void DissociateHandle();
 

+    // does this window have deferred position and/or size?
+    bool IsSizeDeferred() const;
+

 
     // implementation from now on
     // ==========================
 
     // implementation from now on
     // ==========================


@@ -172,10 +169,6 @@ public:
 #endif
 
 public:
 #endif
 
 public:

-    // For implementation purposes - sometimes decorations make the client area
-    // smaller
-    virtual wxPoint GetClientAreaOrigin() const;
-

     // Windows subclassing
     void SubclassWin(WXHWND hWnd);
     void UnsubclassWin();
     // Windows subclassing
     void SubclassWin(WXHWND hWnd);
     void UnsubclassWin();


@@ -278,9 +271,7 @@ public:
                              WXWORD pos, WXHWND control);
 
     // child control notifications
                              WXWORD pos, WXHWND control);
 
     // child control notifications

-#ifdef __WIN95__

     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);

-#endif // __WIN95__

 
     // owner-drawn controls need to process these messages
     virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item);
 
     // owner-drawn controls need to process these messages
     virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item);


@@ -292,7 +283,8 @@ public:
     bool HandleDestroy();
 
     bool HandlePaint();
     bool HandleDestroy();
 
     bool HandlePaint();

-    bool HandleEraseBkgnd(WXHDC pDC);
+    bool HandlePrintClient(WXHDC hDC);
+    bool HandleEraseBkgnd(WXHDC hDC);

 
     bool HandleMinimize();
     bool HandleMaximize();
 
     bool HandleMinimize();
     bool HandleMaximize();


@@ -312,6 +304,7 @@ public:
     bool HandleSysColorChange();
     bool HandleDisplayChange();
     bool HandleCaptureChanged(WXHWND gainedCapture);
     bool HandleSysColorChange();
     bool HandleDisplayChange();
     bool HandleCaptureChanged(WXHWND gainedCapture);

+    virtual bool HandleSettingChange(WXWPARAM wParam, WXLPARAM lParam);

 
     bool HandleQueryEndSession(long logOff, bool *mayEnd);
     bool HandleEndSession(bool endSession, long logOff);
 
     bool HandleQueryEndSession(long logOff, bool *mayEnd);
     bool HandleEndSession(bool endSession, long logOff);


@@ -360,48 +353,40 @@ public:
     // called when the window is about to be destroyed
     virtual void MSWDestroyWindow();
 
     // called when the window is about to be destroyed
     virtual void MSWDestroyWindow();
 

-    // this function should return the brush to paint the window background
-    // with or 0 for the default brush
-    virtual WXHBRUSH MSWControlColor(WXHDC hDC);

 
     // this function should return the brush to paint the children controls
     // background or 0 if this window doesn't impose any particular background
     // on its children
     //
 
     // this function should return the brush to paint the children controls
     // background or 0 if this window doesn't impose any particular background
     // on its children
     //

-    // the base class version uses MSWGetBgColourForChild() and returns a solid
-    // brush if we have a non default background colour or 0 otherwise
-    virtual WXHBRUSH MSWGetBgBrushForChild(WXHDC WXUNUSED(hDC), wxWindow *child)
+    // the base class version returns a solid brush if we have a non default
+    // background colour or 0 otherwise
+    virtual WXHBRUSH MSWGetBgBrushForChild(WXHDC hDC, WXHWND hWnd);
+
+    // return the background brush to use for painting the given window by
+    // quering the parent windows via their MSWGetBgBrushForChild() recursively
+    //
+    // hWndToPaint is normally NULL meaning this window itself, but it can also
+    // be a child of this window which is used by the static box and could be
+    // potentially useful for other transparent controls
+    WXHBRUSH MSWGetBgBrush(WXHDC hDC, WXHWND hWndToPaint = NULL);
+
+    // gives the parent the possibility to draw its children background, e.g.
+    // this is used by wxNotebook to do it using DrawThemeBackground()
+    //
+    // return true if background was drawn, false otherwise
+    virtual bool MSWPrintChild(WXHDC WXUNUSED(hDC), wxWindow * WXUNUSED(child))

     {
     {

-        return MSWGetSolidBgBrushForChild(child);
+        return false;

     }
 
     }
 

-    // return the background colour of this window under the given child
-    // (possible grand child)
+    // some controls (e.g. wxListBox) need to set the return value themselves

     //
     //

-    // this is a hack as if the background is themed, there is no single colour
-    // representing it, but sometimes we can't use the pattern brush returned
-    // by MSWGetBgBrushForChild() anyhow and then this function is used as
-    // fallback
-    //
-    // the base class version returns bg colour if it had been explicitely set
-    // or wxNullColour otherwise
-    virtual wxColour MSWGetBgColourForChild(wxWindow *child);
-
-    // convenience function: returns a solid brush of the colour returned by
-    // MSWGetBgColourForChild() or 0
-    WXHBRUSH MSWGetSolidBgBrushForChild(wxWindow *child);
-
-    // normally just calls MSWGetBgBrushForChild() on the parent window but may
-    // be overridden if the default background brush is not suitable for some
-    // reason (e.g. wxStaticBox uses MSWGetSolidBgBrushForChild() instead)
-    virtual WXHBRUSH MSWGetBgBrushForSelf(wxWindow *parent, WXHDC hDC)
+    // return true to let parent handle it if we don't, false otherwise
+    virtual bool MSWShouldPropagatePrintChild()

     {
     {

-        return parent->MSWGetBgBrushForChild(hDC, this);
+        return true;

     }
 
     }
 

-    // return the background brush to use for this window by quering the parent
-    // windows via their MSWGetBgBrushForChild() recursively
-    WXHBRUSH MSWGetBgBrush(WXHDC hDC);

 
     // Responds to colour changes: passes event on to children.
     void OnSysColourChanged(wxSysColourChangedEvent& event);
 
     // Responds to colour changes: passes event on to children.
     void OnSysColourChanged(wxSysColourChangedEvent& event);


@@ -412,11 +397,19 @@ public:
     // check if mouse is in the window
     bool IsMouseInWindow() const;
 
     // check if mouse is in the window
     bool IsMouseInWindow() const;
 

+    // synthesize a wxEVT_LEAVE_WINDOW event and set m_mouseInWindow to false
+    void GenerateMouseLeave();
+

     // virtual function for implementing internal idle
     // behaviour
     // virtual function for implementing internal idle
     // behaviour

-    virtual void OnInternalIdle() ;
+    virtual void OnInternalIdle();

 
 protected:
 
 protected:

+
+#if wxUSE_MENUS_NATIVE
+    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
+#endif // wxUSE_MENUS_NATIVE
+

     // the window handle
     WXHWND                m_hWnd;
 
     // the window handle
     WXHWND                m_hWnd;
 


@@ -431,15 +424,6 @@ protected:
     int                   m_xThumbSize;
     int                   m_yThumbSize;
 
     int                   m_xThumbSize;
     int                   m_yThumbSize;
 

-#if wxUSE_MOUSEEVENT_HACK
-    // the coordinates of the last mouse event and the type of it
-    long                  m_lastMouseX,
-                          m_lastMouseY;
-    int                   m_lastMouseEvent;
-#endif // wxUSE_MOUSEEVENT_HACK
-
-    WXHMENU               m_hMenu; // Menu, if any
-

     // implement the base class pure virtuals
     virtual void DoClientToScreen( int *x, int *y ) const;
     virtual void DoScreenToClient( int *x, int *y ) const;
     // implement the base class pure virtuals
     virtual void DoClientToScreen( int *x, int *y ) const;
     virtual void DoScreenToClient( int *x, int *y ) const;


@@ -457,6 +441,14 @@ protected:
     // has the window been frozen by Freeze()?
     bool IsFrozen() const { return m_frozenness > 0; }
 
     // has the window been frozen by Freeze()?
     bool IsFrozen() const { return m_frozenness > 0; }
 

+    // this simply moves/resizes the given HWND which is supposed to be our
+    // sibling (this is useful for controls which are composite at MSW level
+    // and for which DoMoveWindow() is not enough)
+    //
+    // returns true if the window move was deferred, false if it was moved
+    // immediately (no error return)
+    bool DoMoveSibling(WXHWND hwnd, int x, int y, int width, int height);
+

     // move the window to the specified location and resize it: this is called
     // from both DoSetSize() and DoSetClientSize() and would usually just call
     // ::MoveWindow() except for composite controls which will want to arrange
     // move the window to the specified location and resize it: this is called
     // from both DoSetSize() and DoSetClientSize() and would usually just call
     // ::MoveWindow() except for composite controls which will want to arrange


@@ -477,6 +469,19 @@ protected:
     wxKeyEvent CreateKeyEvent(wxEventType evType, int id,
                               WXLPARAM lParam = 0, WXWPARAM wParam = 0) const;
 
     wxKeyEvent CreateKeyEvent(wxEventType evType, int id,
                               WXLPARAM lParam = 0, WXWPARAM wParam = 0) const;
 

+
+    // default OnEraseBackground() implementation, return true if we did erase
+    // the background, false otherwise (i.e. the system should erase it)
+    bool DoEraseBackground(WXHDC hDC);
+
+    // generate WM_CHANGEUISTATE if it's needed for the OS we're running under
+    //
+    // action should be one of the UIS_XXX constants
+    // state should be one or more of the UISF_XXX constants
+    // if action == UIS_INITIALIZE then it doesn't seem to matter what we use
+    // for state as the system will decide for us what needs to be set
+    void MSWUpdateUIState(int action, int state = 0);
+

 private:
     // common part of all ctors
     void Init();
 private:
     // common part of all ctors
     void Init();


@@ -485,10 +490,7 @@ private:
     bool HandleMove(int x, int y);
     bool HandleMoving(wxRect& rect);
     bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);
     bool HandleMove(int x, int y);
     bool HandleMoving(wxRect& rect);
     bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);

-
-#ifdef __WIN95__

     bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
     bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);

-#endif // __WIN95__

 
     // list of disabled children before last call to our Disable()
     wxWindowList *m_childrenDisabled;
 
     // list of disabled children before last call to our Disable()
     wxWindowList *m_childrenDisabled;


@@ -496,6 +498,19 @@ private:
     // number of calls to Freeze() minus number of calls to Thaw()
     unsigned int m_frozenness;
 
     // number of calls to Freeze() minus number of calls to Thaw()
     unsigned int m_frozenness;
 

+    // current defer window position operation handle (may be NULL)
+    WXHANDLE m_hDWP;
+
+    // When deferred positioning is done these hold the pending changes, and
+    // are used for the default values if another size/pos changes is done on
+    // this window before the group of deferred changes is completed.
+    wxPoint     m_pendingPosition;
+    wxSize      m_pendingSize;
+
+#ifdef __POCKETPC__
+    bool        m_contextMenuEnabled;
+#endif
+

     DECLARE_DYNAMIC_CLASS(wxWindowMSW)
     DECLARE_NO_COPY_CLASS(wxWindowMSW)
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxWindowMSW)
     DECLARE_NO_COPY_CLASS(wxWindowMSW)
     DECLARE_EVENT_TABLE()


@@ -548,5 +563,4 @@ WX_DECLARE_HASH(wxWindowMSW, wxWindowList, wxWinHashTable);
 
 extern wxWinHashTable *wxWinHandleHash;
 
 
 extern wxWinHashTable *wxWinHandleHash;
 

-#endif
-    // _WX_WINDOW_H_
+#endif // _WX_WINDOW_H_