Add PrivData() field to wxPrintData since MSW's printer

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

diff --git a/include/wx/msw/window.h b/include/wx/msw/window.h
index 74f5ec8e5b3485bbc18f424237935816305d8654..ef21be2ecf777b70d39c18b9c8f1b77f1c62936a 100644 (file)
--- a/include/wx/msw/window.h
+++ b/include/wx/msw/window.h
@@ -28,23 +28,18 @@
 // a better solution should be found later...
 #define wxUSE_MOUSEEVENT_HACK 0
 
 // a better solution should be found later...
 #define wxUSE_MOUSEEVENT_HACK 0
 

-#include "wx/hash.h"
-
-// pseudo-template HWND <-> wxWindow hash table
-WX_DECLARE_HASH(wxWindow, wxWindowList, wxWinHashTable);
-
-extern wxWinHashTable *wxWinHandleHash;
-

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

-// FIXME does anybody use those? they're unused by wxWindows...
+#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


@@ -53,14 +48,18 @@ enum
 class WXDLLEXPORT wxWindowMSW : public wxWindowBase
 {
 public:
 class WXDLLEXPORT wxWindowMSW : public wxWindowBase
 {
 public:

-    wxWindowMSW();
+    wxWindowMSW() { Init(); }

 
     wxWindowMSW(wxWindow *parent,
                 wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
 
     wxWindowMSW(wxWindow *parent,
                 wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,

-                const wxString& name = wxPanelNameStr);
+                const wxString& name = wxPanelNameStr)
+    {
+        Init();
+        Create(parent, id, pos, size, style, name);
+    }

 
     virtual ~wxWindowMSW();
 
 
     virtual ~wxWindowMSW();
 


@@ -78,8 +77,8 @@ public:
     virtual void Raise();
     virtual void Lower();
 
     virtual void Raise();
     virtual void Lower();
 

-    virtual bool Show( bool show = TRUE );
-    virtual bool Enable( bool enable = TRUE );
+    virtual bool Show( bool show = true );
+    virtual bool Enable( bool enable = true );

 
     virtual void SetFocus();
     virtual void SetFocusFromKbd();
 
     virtual void SetFocus();
     virtual void SetFocusFromKbd();


@@ -88,7 +87,7 @@ public:
 
     virtual void WarpPointer(int x, int y);
 
 
     virtual void WarpPointer(int x, int y);
 

-    virtual void Refresh( bool eraseBackground = TRUE,
+    virtual void Refresh( bool eraseBackground = true,

                           const wxRect *rect = (const wxRect *) NULL );
     virtual void Update();
     virtual void Freeze();
                           const wxRect *rect = (const wxRect *) NULL );
     virtual void Update();
     virtual void Freeze();


@@ -112,8 +111,8 @@ public:
 #endif // wxUSE_MENUS_NATIVE
 
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
 #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 );
+                               int range, bool refresh = true );
+    virtual void SetScrollPos( int orient, int pos, bool refresh = true );

     virtual int GetScrollPos( int orient ) const;
     virtual int GetScrollThumb( int orient ) const;
     virtual int GetScrollRange( int orient ) const;
     virtual int GetScrollPos( int orient ) const;
     virtual int GetScrollThumb( int orient ) const;
     virtual int GetScrollRange( int orient ) const;


@@ -133,7 +132,7 @@ public:
 #if WXWIN_COMPATIBILITY_2_4
     wxDEPRECATED( bool GetUseCtl3D() const );
     wxDEPRECATED( bool GetTransparentBackground() const );
 #if WXWIN_COMPATIBILITY_2_4
     wxDEPRECATED( bool GetUseCtl3D() const );
     wxDEPRECATED( bool GetTransparentBackground() const );

-    wxDEPRECATED( void SetTransparent(bool t = TRUE) );
+    wxDEPRECATED( void SetTransparent(bool t = true) );

 #endif // WXWIN_COMPATIBILITY_2_4
 
 #ifndef __WXUNIVERSAL__
 #endif // WXWIN_COMPATIBILITY_2_4
 
 #ifndef __WXUNIVERSAL__


@@ -151,27 +150,30 @@ public:
     virtual bool UnregisterHotKey(int hotkeyId);
 #endif // wxUSE_HOTKEY
 
     virtual bool UnregisterHotKey(int hotkeyId);
 #endif // wxUSE_HOTKEY
 

-    // implementation from now on
-    // --------------------------
-
-    // simple accessors
-    // ----------------
+    // window handle stuff
+    // -------------------

 
     WXHWND GetHWND() const { return m_hWnd; }
     void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
     virtual WXWidget GetHandle() const { return GetHWND(); }
 
 
     WXHWND GetHWND() const { return m_hWnd; }
     void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
     virtual WXWidget GetHandle() const { return GetHWND(); }
 

+    void AssociateHandle(WXWidget handle);
+    void DissociateHandle();
+
+
+    // implementation from now on
+    // ==========================
+

     // event handlers
     // --------------
 
     // event handlers
     // --------------
 

-    void OnEraseBackground(wxEraseEvent& event);

     void OnPaint(wxPaintEvent& event);
     void OnPaint(wxPaintEvent& event);

+    void OnEraseBackground(wxEraseEvent& event);
+#ifdef __WXWINCE__
+    void OnInitDialog(wxInitDialogEvent& event);
+#endif

 
 public:
 
 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();


@@ -179,35 +181,35 @@ public:
     WXFARPROC MSWGetOldWndProc() const { return m_oldWndProc; }
     void MSWSetOldWndProc(WXFARPROC proc) { m_oldWndProc = proc; }
 
     WXFARPROC MSWGetOldWndProc() const { return m_oldWndProc; }
     void MSWSetOldWndProc(WXFARPROC proc) { m_oldWndProc = proc; }
 

-    // return TRUE if the window is of a standard (i.e. not wxWindows') class
+    // return true if the window is of a standard (i.e. not wxWidgets') class

     //
     // to understand why does it work, look at SubclassWin() code and comments
     bool IsOfStandardClass() const { return m_oldWndProc != NULL; }
 
     wxWindow *FindItem(long id) const;
     //
     // to understand why does it work, look at SubclassWin() code and comments
     bool IsOfStandardClass() const { return m_oldWndProc != NULL; }
 
     wxWindow *FindItem(long id) const;

-    wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const;
+    wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = false) const;

 
 

-    // MSW only: TRUE if this control is part of the main control
-    virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; };
+    // MSW only: true if this control is part of the main control
+    virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return false; };

 
 

-    // translate wxWindows style flags for this control into the Windows style
+    // translate wxWidgets style flags for this control into the Windows style

     // and optional extended style for the corresponding native control
     //
     // this is the function that should be overridden in the derived classes,
     // but you will mostly use MSWGetCreateWindowFlags() below
     virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle = NULL) const ;
 
     // and optional extended style for the corresponding native control
     //
     // this is the function that should be overridden in the derived classes,
     // but you will mostly use MSWGetCreateWindowFlags() below
     virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle = NULL) const ;
 

-    // get the MSW window flags corresponding to wxWindows ones
+    // get the MSW window flags corresponding to wxWidgets ones

     //
     // the functions returns the flags (WS_XXX) directly and puts the ext
     // (WS_EX_XXX) flags into the provided pointer if not NULL
     WXDWORD MSWGetCreateWindowFlags(WXDWORD *exflags = NULL) const
         { return MSWGetStyle(GetWindowStyle(), exflags); }
 
     //
     // the functions returns the flags (WS_XXX) directly and puts the ext
     // (WS_EX_XXX) flags into the provided pointer if not NULL
     WXDWORD MSWGetCreateWindowFlags(WXDWORD *exflags = NULL) const
         { return MSWGetStyle(GetWindowStyle(), exflags); }
 

-    // translate wxWindows coords into Windows ones suitable to be passed to
+    // translate wxWidgets coords into Windows ones suitable to be passed to

     // ::CreateWindow()
     //
     // ::CreateWindow()
     //

-    // returns TRUE if non default coords are returned, FALSE otherwise
+    // returns true if non default coords are returned, false otherwise

     bool MSWGetCreateWindowCoords(const wxPoint& pos,
                                   const wxSize& size,
                                   int& x, int& y,
     bool MSWGetCreateWindowCoords(const wxPoint& pos,
                                   const wxSize& size,
                                   int& x, int& y,


@@ -219,7 +221,7 @@ public:
     // creates the window of specified Windows class with given style, extended
     // style, title and geometry (default values
     //
     // creates the window of specified Windows class with given style, extended
     // style, title and geometry (default values
     //

-    // returns TRUE if the window has been created, FALSE if creation failed
+    // returns true if the window has been created, false if creation failed

     bool MSWCreate(const wxChar *wclass,
                    const wxChar *title = NULL,
                    const wxPoint& pos = wxDefaultPosition,
     bool MSWCreate(const wxChar *wclass,
                    const wxChar *title = NULL,
                    const wxPoint& pos = wxDefaultPosition,


@@ -253,13 +255,13 @@ public:
     void UnpackScroll(WXWPARAM wParam, WXLPARAM lParam,
                       WXWORD *code, WXWORD *pos, WXHWND *hwnd);
     void UnpackCtlColor(WXWPARAM wParam, WXLPARAM lParam,
     void UnpackScroll(WXWPARAM wParam, WXLPARAM lParam,
                       WXWORD *code, WXWORD *pos, WXHWND *hwnd);
     void UnpackCtlColor(WXWPARAM wParam, WXLPARAM lParam,

-                        WXWORD *nCtlColor, WXHDC *hdc, WXHWND *hwnd);
+                        WXHDC *hdc, WXHWND *hwnd);

     void UnpackMenuSelect(WXWPARAM wParam, WXLPARAM lParam,
                           WXWORD *item, WXWORD *flags, WXHMENU *hmenu);
 
     // ------------------------------------------------------------------------
     // internal handlers for MSW messages: all handlers return a boolean value:
     void UnpackMenuSelect(WXWPARAM wParam, WXLPARAM lParam,
                           WXWORD *item, WXWORD *flags, WXHMENU *hmenu);
 
     // ------------------------------------------------------------------------
     // internal handlers for MSW messages: all handlers return a boolean value:

-    // TRUE means that the handler processed the event and FALSE that it didn't
+    // true means that the handler processed the event and false that it didn't

     // ------------------------------------------------------------------------
 
     // there are several cases where we have virtual functions for Windows
     // ------------------------------------------------------------------------
 
     // there are several cases where we have virtual functions for Windows


@@ -300,15 +302,8 @@ public:
     bool HandleActivate(int flag, bool minimized, WXHWND activate);
 
     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
     bool HandleActivate(int flag, bool minimized, WXHWND activate);
 
     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);

-    bool HandleSysCommand(WXWPARAM wParam, WXLPARAM lParam);

 
 

-    bool HandleCtlColor(WXHBRUSH *hBrush,
-                        WXHDC hdc,
-                        WXHWND hWnd,
-                        WXUINT nCtlColor,
-                        WXUINT message,
-                        WXWPARAM wParam,
-                        WXLPARAM lParam);
+    bool HandleCtlColor(WXHBRUSH *hBrush, WXHDC hdc, WXHWND hWnd);

 
     bool HandlePaletteChanged(WXHWND hWndPalChange);
     bool HandleQueryNewPalette();
 
     bool HandlePaletteChanged(WXHWND hWndPalChange);
     bool HandleQueryNewPalette();


@@ -328,7 +323,7 @@ public:
     bool HandleMouseMove(int x, int y, WXUINT flags);
     bool HandleMouseWheel(WXWPARAM wParam, WXLPARAM lParam);
 
     bool HandleMouseMove(int x, int y, WXUINT flags);
     bool HandleMouseWheel(WXWPARAM wParam, WXLPARAM lParam);
 

-    bool HandleChar(WXWPARAM wParam, WXLPARAM lParam, bool isASCII = FALSE);
+    bool HandleChar(WXWPARAM wParam, WXLPARAM lParam, bool isASCII = false);

     bool HandleKeyDown(WXWPARAM wParam, WXLPARAM lParam);
     bool HandleKeyUp(WXWPARAM wParam, WXLPARAM lParam);
 #if wxUSE_ACCEL
     bool HandleKeyDown(WXWPARAM wParam, WXLPARAM lParam);
     bool HandleKeyUp(WXWPARAM wParam, WXLPARAM lParam);
 #if wxUSE_ACCEL


@@ -343,21 +338,21 @@ public:
     bool HandleSetCursor(WXHWND hWnd, short nHitTest, int mouseMsg);
 
     // Window procedure
     bool HandleSetCursor(WXHWND hWnd, short nHitTest, int mouseMsg);
 
     // Window procedure

-    virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);

 
     // Calls an appropriate default window procedure
 
     // Calls an appropriate default window procedure

-    virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+    virtual WXLRESULT MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);

 
     // message processing helpers
 
 
     // message processing helpers
 

-    // return FALSE if the message shouldn't be translated/preprocessed but
+    // return false if the message shouldn't be translated/preprocessed but

     // dispatched normally
     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
 
     // dispatched normally
     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
 

-    // return TRUE if the message was preprocessed and shouldn't be dispatched
+    // return true if the message was preprocessed and shouldn't be dispatched

     virtual bool MSWProcessMessage(WXMSG* pMsg);
 
     virtual bool MSWProcessMessage(WXMSG* pMsg);
 

-    // return TRUE if the message was translated and shouldn't be dispatched
+    // return true if the message was translated and shouldn't be dispatched

     virtual bool MSWTranslateMessage(WXMSG* pMsg);
 
     // called when the window is about to be destroyed
     virtual bool MSWTranslateMessage(WXMSG* pMsg);
 
     // called when the window is about to be destroyed


@@ -365,12 +360,53 @@ public:
 
     // this function should return the brush to paint the window background
     // with or 0 for the default brush
 
     // this function should return the brush to paint the window background
     // with or 0 for the default brush

-    virtual WXHBRUSH OnCtlColor(WXHDC hDC,
-                                WXHWND hWnd,
-                                WXUINT nCtlColor,
-                                WXUINT message,
-                                WXWPARAM wParam,
-                                WXLPARAM lParam);
+    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
+    //
+    // 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)
+    {
+        return MSWGetSolidBgBrushForChild(child);
+    }
+
+    // return the background colour of this window under the given child
+    // (possible grand child)
+    //
+    // 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 the background brush to use for this window by quering the parent
+    // windows via their MSWGetBgBrushForChild() recursively
+    WXHBRUSH MSWGetBgBrush(WXHDC hDC);
+
+    // overriding this method gives the parent window the opportunity to
+    // process WM_PRINTCLIENT for its children: this is currently used by
+    // wxNotebook to draw themed background for them
+    //
+    // return true if the message was processed or false to use default logic
+    // for it (currently this means handling it just as WM_PAINT i.e. render
+    // the control into the provided DC)
+    virtual bool MSWPrintChild(wxWindow *win, WXWPARAM wParam, WXLPARAM lParam);
+

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


@@ -381,6 +417,9 @@ 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 void OnInternalIdle() ;
     // virtual function for implementing internal idle
     // behaviour
     virtual void OnInternalIdle() ;


@@ -407,8 +446,6 @@ protected:
     int                   m_lastMouseEvent;
 #endif // wxUSE_MOUSEEVENT_HACK
 
     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;


@@ -423,6 +460,9 @@ protected:
     virtual void DoCaptureMouse();
     virtual void DoReleaseMouse();
 
     virtual void DoCaptureMouse();
     virtual void DoReleaseMouse();
 

+    // has the window been frozen by Freeze()?
+    bool IsFrozen() const { return m_frozenness > 0; }
+

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


@@ -443,6 +483,11 @@ 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
+    bool DoEraseBackground(wxDC& dc);
+

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


@@ -459,6 +504,13 @@ private:
     // 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;
 

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

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


@@ -481,8 +533,8 @@ inline void wxWindowMSW::SetTransparent(bool WXUNUSED(t)) { }
 // ---------------------------------------------------------------------------
 
 // kbd code translation
 // ---------------------------------------------------------------------------
 
 // kbd code translation

-WXDLLEXPORT int wxCharCodeMSWToWX(int keySym);
-WXDLLEXPORT int wxCharCodeWXToMSW(int id, bool *IsVirtual);
+WXDLLEXPORT int wxCharCodeMSWToWX(int keySym, WXLPARAM lParam = 0);
+WXDLLEXPORT WXWORD wxCharCodeWXToMSW(int id, bool *IsVirtual);

 
 // window creation helper class: before creating a new HWND, instantiate an
 // object of this class on stack - this allows to process the messages sent to
 
 // window creation helper class: before creating a new HWND, instantiate an
 // object of this class on stack - this allows to process the messages sent to


@@ -494,5 +546,22 @@ public:
     ~wxWindowCreationHook();
 };
 
     ~wxWindowCreationHook();
 };
 

+// ----------------------------------------------------------------------------
+// global objects
+// ----------------------------------------------------------------------------
+
+// notice that this hash must be defined after wxWindow declaration as it
+// needs to "see" its dtor and not just forward declaration
+#include "wx/hash.h"
+
+// pseudo-template HWND <-> wxWindow hash table
+#if WXWIN_COMPATIBILITY_2_4
+WX_DECLARE_HASH(wxWindow, wxWindowList, wxWinHashTable);
+#else
+WX_DECLARE_HASH(wxWindowMSW, wxWindowList, wxWinHashTable);
+#endif
+
+extern wxWinHashTable *wxWinHandleHash;
+

 #endif
     // _WX_WINDOW_H_
 #endif
     // _WX_WINDOW_H_