wxUSE_NEW_GRID is no longer used

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

diff --git a/include/wx/msw/window.h b/include/wx/msw/window.h
index 6e654f53f1a6c45f9d7146509c029697849d65e4..63cdaf66dd1a811b7e7aaa6ea4928c8049f4135a 100644 (file)
--- a/include/wx/msw/window.h
+++ b/include/wx/msw/window.h
@@ -6,7 +6,7 @@
 //              elimination of Default(), ...
 // Created:     01/02/97
 // RCS-ID:      $Id$
 //              elimination of Default(), ...
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
+// Copyright:   (c) Julian Smart

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -28,6 +28,13 @@
 // 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
 // ---------------------------------------------------------------------------


@@ -79,12 +86,11 @@ public:
     virtual bool Enable( bool enable = TRUE );
 
     virtual void SetFocus();
     virtual bool Enable( bool enable = TRUE );
 
     virtual void SetFocus();

+    virtual void SetFocusFromKbd();

 
     virtual bool Reparent(wxWindowBase *newParent);
 
     virtual void WarpPointer(int x, int y);
 
     virtual bool Reparent(wxWindowBase *newParent);
 
     virtual void WarpPointer(int x, int y);

-    virtual void CaptureMouse();
-    virtual void ReleaseMouse();

 
     virtual void Refresh( bool eraseBackground = TRUE,
                           const wxRect *rect = (const wxRect *) NULL );
 
     virtual void Refresh( bool eraseBackground = TRUE,
                           const wxRect *rect = (const wxRect *) NULL );


@@ -93,6 +99,7 @@ public:
     virtual void Freeze();
     virtual void Thaw();
 
     virtual void Freeze();
     virtual void Thaw();
 

+    virtual void SetWindowStyleFlag( long style );

     virtual bool SetCursor( const wxCursor &cursor );
     virtual bool SetFont( const wxFont &font );
 
     virtual bool SetCursor( const wxCursor &cursor );
     virtual bool SetFont( const wxFont &font );
 


@@ -118,8 +125,8 @@ public:
     virtual void ScrollWindow( int dx, int dy,
                                const wxRect* rect = (wxRect *) NULL );
 
     virtual void ScrollWindow( int dx, int dy,
                                const wxRect* rect = (wxRect *) NULL );
 

-    virtual void ScrollLines(int lines);
-    virtual void ScrollPages(int pages);
+    virtual bool ScrollLines(int lines);
+    virtual bool ScrollPages(int pages);

 
 #if wxUSE_DRAG_AND_DROP
     virtual void SetDropTarget( wxDropTarget *dropTarget );
 
 #if wxUSE_DRAG_AND_DROP
     virtual void SetDropTarget( wxDropTarget *dropTarget );


@@ -128,6 +135,12 @@ public:
     // Accept files for dragging
     virtual void DragAcceptFiles(bool accept);
 
     // Accept files for dragging
     virtual void DragAcceptFiles(bool accept);
 

+#if WXWIN_COMPATIBILITY_2_4
+    wxDEPRECATED( bool GetUseCtl3D() const );
+    wxDEPRECATED( bool GetTransparentBackground() const );
+    wxDEPRECATED( void SetTransparent(bool t = TRUE) );
+#endif // WXWIN_COMPATIBILITY_2_4
+

 #if WXWIN_COMPATIBILITY
     // Set/get scroll attributes
     virtual void SetScrollRange(int orient, int range, bool refresh = TRUE);
 #if WXWIN_COMPATIBILITY
     // Set/get scroll attributes
     virtual void SetScrollRange(int orient, int range, bool refresh = TRUE);


@@ -164,12 +177,11 @@ public:
     wxWindow* GetWindowChild(wxWindowID id);
 #endif // __WXUNIVERSAL__
 
     wxWindow* GetWindowChild(wxWindowID id);
 #endif // __WXUNIVERSAL__
 

-    // a MSW only function which sends a size event to the window using its
-    // current size - this has an effect of refreshing the window layout
-/*
-FUNCTION IS NOW A MEMBER OF wxFrame - gt
-    void SendSizeEvent();
-*/
+#if wxUSE_HOTKEY
+    // install and deinstall a system wide hotkey
+    virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode);
+    virtual bool UnregisterHotKey(int hotkeyId);
+#endif // wxUSE_HOTKEY

 
     // implementation from now on
     // --------------------------
 
     // implementation from now on
     // --------------------------


@@ -181,16 +193,10 @@ FUNCTION IS NOW A MEMBER OF wxFrame - gt
     void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
     virtual WXWidget GetHandle() const { return GetHWND(); }
 
     void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
     virtual WXWidget GetHandle() const { return GetHWND(); }
 

-    bool GetUseCtl3D() const { return m_useCtl3D; }
-    bool GetTransparentBackground() const { return m_backgroundTransparent; }
-    void SetTransparent(bool t = TRUE) { m_backgroundTransparent = t; }
-

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

-    void OnSetFocus(wxFocusEvent& event);

     void OnEraseBackground(wxEraseEvent& event);
     void OnEraseBackground(wxEraseEvent& event);

-    void OnIdle(wxIdleEvent& event);

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


@@ -198,10 +204,6 @@ public:
     // smaller
     virtual wxPoint GetClientAreaOrigin() const;
 
     // smaller
     virtual wxPoint GetClientAreaOrigin() const;
 

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

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


@@ -209,28 +211,54 @@ 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
+    //
+    // 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 *FindItem(long id) const;
     wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const;
 

-    // Make a Windows extended style from the given wxWindows window style
-    static WXDWORD MakeExtendedStyle(long style,
-                                     bool eliminateBorders = FALSE);
-    // Determine whether 3D effects are wanted
-    WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D) 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; };
 

-    // returns TRUE if the window has been created
-    bool MSWCreate(int id,
-                   wxWindow *parent,
-                   const wxChar *wclass,
-                   wxWindow *wx_win,
-                   const wxChar *title,
-                   int x, int y, int width, int height,
-                   WXDWORD style,
-                   const wxChar *dialog_template = NULL,
+    // translate wxWindows 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 ;
+
+    // get the MSW window flags corresponding to wxWindows 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); }
+
+    // translate wxWindows coords into Windows ones suitable to be passed to
+    // ::CreateWindow()
+    //
+    // returns TRUE if non default coords are returned, FALSE otherwise
+    bool MSWGetCreateWindowCoords(const wxPoint& pos,
+                                  const wxSize& size,
+                                  int& x, int& y,
+                                  int& w, int& h) const;
+
+    // get the HWND to be used as parent of this window with CreateWindow()
+    virtual WXHWND MSWGetParent() const;
+
+    // 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
+    bool MSWCreate(const wxChar *wclass,
+                   const wxChar *title = NULL,
+                   const wxPoint& pos = wxDefaultPosition,
+                   const wxSize& size = wxDefaultSize,
+                   WXDWORD style = 0,

                    WXDWORD exendedStyle = 0);
                    WXDWORD exendedStyle = 0);

+

     virtual bool MSWCommand(WXUINT param, WXWORD id);
 
 #if WXWIN_COMPATIBILITY
     virtual bool MSWCommand(WXUINT param, WXWORD id);
 
 #if WXWIN_COMPATIBILITY


@@ -302,6 +330,7 @@ public:
     bool HandleMinimize();
     bool HandleMaximize();
     bool HandleSize(int x, int y, WXUINT flag);
     bool HandleMinimize();
     bool HandleMaximize();
     bool HandleSize(int x, int y, WXUINT flag);

+    bool HandleSizing(wxRect& rect);

     bool HandleGetMinMaxInfo(void *mmInfo);
 
     bool HandleShow(bool show, int status);
     bool HandleGetMinMaxInfo(void *mmInfo);
 
     bool HandleShow(bool show, int status);


@@ -321,6 +350,8 @@ public:
     bool HandlePaletteChanged(WXHWND hWndPalChange);
     bool HandleQueryNewPalette();
     bool HandleSysColorChange();
     bool HandlePaletteChanged(WXHWND hWndPalChange);
     bool HandleQueryNewPalette();
     bool HandleSysColorChange();

+    bool HandleDisplayChange();
+    bool HandleCaptureChanged(WXHWND gainedCapture);

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


@@ -337,6 +368,12 @@ public:
     bool HandleChar(WXWPARAM wParam, WXLPARAM lParam, bool isASCII = FALSE);
     bool HandleKeyDown(WXWPARAM wParam, WXLPARAM lParam);
     bool HandleKeyUp(WXWPARAM wParam, WXLPARAM lParam);
     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 HandleHotKey(WXWPARAM wParam, WXLPARAM lParam);
+#endif
+#ifdef __WIN32__
+    int HandleMenuChar(int chAccel, WXLPARAM lParam);
+#endif

 
     bool HandleQueryDragIcon(WXHICON *hIcon);
 
 
     bool HandleQueryDragIcon(WXHICON *hIcon);
 


@@ -347,12 +384,21 @@ public:
 
     // Calls an appropriate default window procedure
     virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 
     // Calls an appropriate default window procedure
     virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);

+
+    // message processing helpers
+
+    // return FALSE if the message shouldn't be translated/preprocessed but
+    // dispatched normally
+    virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
+
+    // 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

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

-    virtual void MSWDestroyWindow();

 
 

-    // Detach "Window" menu from menu bar so it doesn't get deleted
-    void MSWDetachWindowMenu();
+    // 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
 
     // this function should return the brush to paint the window background
     // with or 0 for the default brush


@@ -377,6 +423,10 @@ public:
     // check if mouse is in the window
     bool IsMouseInWindow() const;
 
     // check if mouse is in the window
     bool IsMouseInWindow() const;
 

+    // virtual function for implementing internal idle
+    // behaviour
+    virtual void OnInternalIdle() ;
+

 protected:
     // the window handle
     WXHWND                m_hWnd;
 protected:
     // the window handle
     WXHWND                m_hWnd;


@@ -385,10 +435,8 @@ protected:
     WXFARPROC             m_oldWndProc;
 
     // additional (MSW specific) flags
     WXFARPROC             m_oldWndProc;
 
     // additional (MSW specific) flags

-    bool                  m_useCtl3D:1; // Using CTL3D for this control
-    bool                  m_backgroundTransparent:1;

     bool                  m_mouseInWindow:1;
     bool                  m_mouseInWindow:1;

-    bool                  m_doubleClickAllowed:1;
+    bool                  m_lastKeydownProcessed:1;

 
     // the size of one page for scrolling
     int                   m_xThumbSize;
 
     // the size of one page for scrolling
     int                   m_xThumbSize;


@@ -403,9 +451,6 @@ protected:
 
     WXHMENU               m_hMenu; // Menu, if any
 
 
     WXHMENU               m_hMenu; // Menu, if any
 

-    // the return value of WM_GETDLGCODE handler
-    long m_lDlgCode;
-

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


@@ -417,6 +462,9 @@ protected:
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
 
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
 

+    virtual void DoCaptureMouse();
+    virtual void DoReleaseMouse();
+

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


@@ -425,28 +473,51 @@ protected:
 
 #if wxUSE_TOOLTIPS
     virtual void DoSetToolTip( wxToolTip *tip );
 
 #if wxUSE_TOOLTIPS
     virtual void DoSetToolTip( wxToolTip *tip );

+
+    // process TTN_NEEDTEXT message properly (i.e. fixing the bugs in
+    // comctl32.dll in our code -- see the function body for more info)
+    bool HandleTooltipNotify(WXUINT code,
+                             WXLPARAM lParam,
+                             const wxString& ttip);

 #endif // wxUSE_TOOLTIPS
 
 #endif // wxUSE_TOOLTIPS
 

+    // the helper functions used by HandleChar/KeyXXX methods
+    wxKeyEvent CreateKeyEvent(wxEventType evType, int id,
+                              WXLPARAM lParam = 0, WXWPARAM wParam = 0) const;
+

 private:
     // common part of all ctors
     void Init();
 
     // the (non-virtual) handlers for the events
     bool HandleMove(int x, int y);
 private:
     // common part of all ctors
     void Init();
 
     // the (non-virtual) handlers for the events
     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);
 #endif // __WIN95__
 
     bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);
 
 #ifdef __WIN95__
     bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 #endif // __WIN95__
 

-    // the helper functions used by HandleChar/KeyXXX methods
-    wxKeyEvent CreateKeyEvent(wxEventType evType, int id, WXLPARAM lp) const;
+    // list of disabled children before last call to our Disable()
+    wxWindowList *m_childrenDisabled;

 
 

-    DECLARE_DYNAMIC_CLASS(wxWindowMSW);
-    DECLARE_NO_COPY_CLASS(wxWindowMSW);
+    DECLARE_DYNAMIC_CLASS(wxWindowMSW)
+    DECLARE_NO_COPY_CLASS(wxWindowMSW)

     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };
 

+// ----------------------------------------------------------------------------
+// inline functions
+// ----------------------------------------------------------------------------
+
+#if WXWIN_COMPATIBILITY_2_4
+
+inline bool wxWindowMSW::GetUseCtl3D() const { return false; }
+inline bool wxWindowMSW::GetTransparentBackground() const { return false; }
+inline void wxWindowMSW::SetTransparent(bool WXUNUSED(t)) { }
+
+#endif // WXWIN_COMPATIBILITY_2_4
+

 // ---------------------------------------------------------------------------
 // global functions
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // global functions
 // ---------------------------------------------------------------------------


@@ -455,5 +526,15 @@ private:
 WXDLLEXPORT int wxCharCodeMSWToWX(int keySym);
 WXDLLEXPORT int wxCharCodeWXToMSW(int id, bool *IsVirtual);
 
 WXDLLEXPORT int wxCharCodeMSWToWX(int keySym);
 WXDLLEXPORT int 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
+// the window even before CreateWindow() returns
+class wxWindowCreationHook
+{
+public:
+    wxWindowCreationHook(wxWindowMSW *winBeingCreated);
+    ~wxWindowCreationHook();
+};
+

 #endif
     // _WX_WINDOW_H_
 #endif
     // _WX_WINDOW_H_