helper class for implementing composite controls under MSW

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

diff --git a/include/wx/msw/window.h b/include/wx/msw/window.h
index 9c19488f92bbafa88795fc39babf5b379272f829..27041df751ee591750a71bf589c37c78e64c0409 100644 (file)
--- a/include/wx/msw/window.h
+++ b/include/wx/msw/window.h
@@ -32,7 +32,7 @@
 // constants
 // ---------------------------------------------------------------------------
 
 // constants
 // ---------------------------------------------------------------------------
 

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

 enum
 {
     wxKEY_SHIFT = 1,
 enum
 {
     wxKEY_SHIFT = 1,


@@ -75,8 +75,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();


@@ -85,7 +85,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();


@@ -109,8 +109,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;


@@ -130,7 +130,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__


@@ -148,21 +148,28 @@ 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:
     // For implementation purposes - sometimes decorations make the client area
 
 public:
     // For implementation purposes - sometimes decorations make the client area


@@ -176,35 +183,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,


@@ -216,7 +223,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,


@@ -250,13 +257,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


@@ -298,13 +305,7 @@ public:
 
     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
 
 
     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
 

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


@@ -324,7 +325,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


@@ -346,14 +347,14 @@ public:
 
     // 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


@@ -361,12 +362,7 @@ 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);

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


@@ -419,6 +415,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


@@ -481,7 +480,7 @@ inline void wxWindowMSW::SetTransparent(bool WXUNUSED(t)) { }
 
 // kbd code translation
 WXDLLEXPORT int wxCharCodeMSWToWX(int keySym, WXLPARAM lParam = 0);
 
 // kbd code translation
 WXDLLEXPORT int wxCharCodeMSWToWX(int keySym, WXLPARAM lParam = 0);

-WXDLLEXPORT int wxCharCodeWXToMSW(int id, bool *IsVirtual);
+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


@@ -502,7 +501,11 @@ public:
 #include "wx/hash.h"
 
 // pseudo-template HWND <-> wxWindow hash table
 #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);
 WX_DECLARE_HASH(wxWindowMSW, wxWindowList, wxWinHashTable);

+#endif

 
 extern wxWinHashTable *wxWinHandleHash;
 
 
 extern wxWinHashTable *wxWinHandleHash;