X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a0e449ff41f55b4d82f108f72638f852c962da2d..7c11806499166993dffcbb99139d5b248a2c6c82:/include/wx/msw/window.h?ds=sidebyside diff --git a/include/wx/msw/window.h b/include/wx/msw/window.h index 25abce27c7..ef21be2ecf 100644 --- 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$ -// Copyright: (c) Julian Smart and Markus Holzem +// Copyright: (c) Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -17,7 +17,7 @@ // headers // --------------------------------------------------------------------------- -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "window.h" #endif @@ -32,12 +32,14 @@ // 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 }; +#endif // --------------------------------------------------------------------------- // wxWindow declaration for MSW @@ -75,24 +77,23 @@ public: 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 bool Reparent(wxWindowBase *newParent); virtual void WarpPointer(int x, int y); - virtual void CaptureMouse(); - virtual void ReleaseMouse(); - virtual void Refresh( bool eraseBackground = TRUE, + virtual void Refresh( bool eraseBackground = true, const wxRect *rect = (const wxRect *) NULL ); virtual void Update(); - virtual void Clear(); virtual void Freeze(); virtual void Thaw(); + virtual void SetWindowStyleFlag( long style ); virtual bool SetCursor( const wxCursor &cursor ); virtual bool SetFont( const wxFont &font ); @@ -110,14 +111,17 @@ public: #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 void ScrollWindow( int dx, int dy, const wxRect* rect = (wxRect *) NULL ); + virtual bool ScrollLines(int lines); + virtual bool ScrollPages(int pages); + #if wxUSE_DRAG_AND_DROP virtual void SetDropTarget( wxDropTarget *dropTarget ); #endif // wxUSE_DRAG_AND_DROP @@ -125,32 +129,11 @@ public: // Accept files for dragging virtual void DragAcceptFiles(bool accept); -#if WXWIN_COMPATIBILITY - // Set/get scroll attributes - virtual void SetScrollRange(int orient, int range, bool refresh = TRUE); - virtual void SetScrollPage(int orient, int page, bool refresh = TRUE); - virtual int OldGetScrollRange(int orient) const; - virtual int GetScrollPage(int orient) const; - - // event handlers - // Handle a control command - virtual void OnCommand(wxWindow& win, wxCommandEvent& event); - - // Override to define new behaviour for default action (e.g. double - // clicking on a listbox) - virtual void OnDefaultAction(wxControl * WXUNUSED(initiatingItem)) { } -#endif // WXWIN_COMPATIBILITY - -#if wxUSE_CARET && WXWIN_COMPATIBILITY - // caret manipulation (old MSW only functions, see wxCaret class for the - // new API) - void CreateCaret(int w, int h); - void CreateCaret(const wxBitmap *bitmap); - void DestroyCaret(); - void ShowCaret(bool show); - void SetCaretPos(int x, int y); - void GetCaretPos(int *x, int *y) const; -#endif // wxUSE_CARET +#if WXWIN_COMPATIBILITY_2_4 + wxDEPRECATED( bool GetUseCtl3D() const ); + wxDEPRECATED( bool GetTransparentBackground() const ); + wxDEPRECATED( void SetTransparent(bool t = true) ); +#endif // WXWIN_COMPATIBILITY_2_4 #ifndef __WXUNIVERSAL__ // Native resource loading (implemented in src/msw/nativdlg.cpp) @@ -161,44 +144,36 @@ public: 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 - // -------------------------- - - // simple accessors - // ---------------- + // window handle stuff + // ------------------- WXHWND GetHWND() const { return m_hWnd; } 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; } + void AssociateHandle(WXWidget handle); + void DissociateHandle(); + + + // implementation from now on + // ========================== // event handlers // -------------- - void OnSetFocus(wxFocusEvent& event); - void OnEraseBackground(wxEraseEvent& event); - void OnIdle(wxIdleEvent& 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 - // 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(); @@ -206,34 +181,55 @@ public: 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 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; - 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; }; - - // 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, + 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; }; + + // 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 ; + + // 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); } + + // translate wxWidgets 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); - virtual bool MSWCommand(WXUINT param, WXWORD id); -#if WXWIN_COMPATIBILITY - wxObject *GetChild(int number) const; - virtual void MSWDeviceToLogical(float *x, float *y) const; -#endif // WXWIN_COMPATIBILITY + virtual bool MSWCommand(WXUINT param, WXWORD id); #ifndef __WXUNIVERSAL__ // Create an appropriate wxWindow from a HWND @@ -259,13 +255,13 @@ public: 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: - // 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 @@ -299,25 +295,21 @@ public: 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 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 HandleSysColorChange(); + bool HandleDisplayChange(); + bool HandleCaptureChanged(WXHWND gainedCapture); bool HandleQueryEndSession(long logOff, bool *mayEnd); bool HandleEndSession(bool endSession, long logOff); @@ -331,39 +323,90 @@ public: 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 HandleHotKey(WXWPARAM wParam, WXLPARAM lParam); +#endif +#ifdef __WIN32__ + int HandleMenuChar(int chAccel, WXLPARAM lParam); +#endif bool HandleQueryDragIcon(WXHICON *hIcon); 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 - virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); + virtual WXLRESULT 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); + + // return true if the message was translated and shouldn't be dispatched 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 - virtual WXHBRUSH OnCtlColor(WXHDC hDC, - WXHWND hWnd, - WXUINT nCtlColor, - WXUINT message, - WXWPARAM wParam, - WXLPARAM lParam); - -#if WXWIN_COMPATIBILITY - void SetShowing(bool show) { (void)Show(show); } - bool IsUserEnabled() const { return IsEnabled(); } -#endif // WXWIN_COMPATIBILITY + 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); @@ -374,6 +417,13 @@ public: // 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() ; + protected: // the window handle WXHWND m_hWnd; @@ -382,10 +432,8 @@ protected: 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_doubleClickAllowed:1; + bool m_lastKeydownProcessed:1; // the size of one page for scrolling int m_xThumbSize; @@ -398,11 +446,6 @@ protected: int m_lastMouseEvent; #endif // wxUSE_MOUSEEVENT_HACK - 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; @@ -414,6 +457,12 @@ protected: int sizeFlags = wxSIZE_AUTO); virtual void DoSetClientSize(int width, int height); + 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 @@ -422,35 +471,97 @@ protected: #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 + // the helper functions used by HandleChar/KeyXXX methods + 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(); // 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__ - // 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; + + // 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_DYNAMIC_CLASS(wxWindowMSW) + DECLARE_NO_COPY_CLASS(wxWindowMSW) 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 // --------------------------------------------------------------------------- // 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 +// the window even before CreateWindow() returns +class wxWindowCreationHook +{ +public: + wxWindowCreationHook(wxWindowMSW *winBeingCreated); + ~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_