/////////////////////////////////////////////////////////////////////////////
-// Name: window.h
+// Name: wx/msw/window.h
// Purpose: wxWindow class
// Author: Julian Smart
-// Modified by:
+// Modified by: Vadim Zeitlin on 13.05.99: complete refont of message handling,
+// elimination of Default(), ...
// Created: 01/02/97
// RCS-ID: $Id$
// Copyright: (c) Julian Smart and Markus Holzem
#pragma interface "window.h"
#endif
-// windows.h #defines the following identifiers which are also used in wxWin
-#ifdef GetCharWidth
- #undef GetCharWidth
-#endif
-
-#ifdef FindWindow
- #undef FindWindow
-#endif
-
-// VZ: apparently some version of Windows send extra mouse move messages after
-// a mouse click. My tests under NT 4.0 and 95 didn't show it so I'm
-// tempted to think that it was just an effect of a poor mouse and so the
-// code to work around this is currently disabled - just define this as 1
-// to reenable it
+// [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
-// ---------------------------------------------------------------------------
-// forward declarations
-// ---------------------------------------------------------------------------
+#include "wx/hash.h"
-class WXDLLEXPORT wxButton;
+// pseudo-template HWND <-> wxWindow hash table
+WX_DECLARE_HASH(wxWindow, wxWindowList, wxWinHashTable);
+
+extern wxWinHashTable *wxWinHandleHash;
// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------
// wxWindow declaration for MSW
// ---------------------------------------------------------------------------
-class WXDLLEXPORT wxWindow : public wxWindowBase
-{
- DECLARE_DYNAMIC_CLASS(wxWindow);
+class WXDLLEXPORT wxWindowMSW : public wxWindowBase
+{
public:
- wxWindow() { Init(); }
-
- wxWindow(wxWindow *parent,
- wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = 0,
- const wxString& name = wxPanelNameStr)
+ wxWindowMSW() { Init(); }
+
+ wxWindowMSW(wxWindow *parent,
+ wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = wxPanelNameStr)
{
Init();
Create(parent, id, pos, size, style, name);
}
- virtual ~wxWindow();
+ virtual ~wxWindowMSW();
bool Create(wxWindow *parent,
wxWindowID id,
const wxString& name = wxPanelNameStr);
// implement base class pure virtuals
+ virtual void SetTitle( const wxString& title);
+ virtual wxString GetTitle() const;
+
virtual void Raise();
virtual void Lower();
virtual bool Enable( bool enable = TRUE );
virtual void SetFocus();
+ virtual void SetFocusFromKbd();
- virtual bool Reparent( wxWindow *newParent );
+ 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 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 );
const wxFont *theFont = (const wxFont *) NULL)
const;
- virtual void ClientToScreen( int *x, int *y ) const;
- virtual void ScreenToClient( int *x, int *y ) const;
-
- virtual bool PopupMenu( wxMenu *menu, int x, int y );
+#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 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
virtual void SetScrollPage(int orient, int page, bool refresh = TRUE);
virtual int OldGetScrollRange(int orient) const;
virtual int GetScrollPage(int orient) const;
-#endif // WXWIN_COMPATIBILITY
- // caret manipulation (MSW only)
- virtual void CreateCaret(int w, int h);
- virtual void CreateCaret(const wxBitmap *bitmap);
- virtual void DestroyCaret();
- virtual void ShowCaret(bool show);
- virtual void SetCaretPos(int x, int y);
- virtual void GetCaretPos(int *x, int *y) const;
-
- // event handlers (FIXME: shouldn't they be inside WXWIN_COMPATIBILITY?)
+ // 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 *initiatingItem);
+ 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
+
+#ifndef __WXUNIVERSAL__
// Native resource loading (implemented in src/msw/nativdlg.cpp)
// FIXME: should they really be all virtual?
virtual bool LoadNativeDialog(wxWindow* parent, wxWindowID& id);
virtual bool LoadNativeDialog(wxWindow* parent, const wxString& name);
- virtual wxWindow* GetWindowChild1(wxWindowID id);
- virtual wxWindow* GetWindowChild(wxWindowID id);
+ wxWindow* GetWindowChild1(wxWindowID id);
+ wxWindow* GetWindowChild(wxWindowID id);
+#endif // __WXUNIVERSAL__
// implementation from now on
// --------------------------
// event handlers
// --------------
+
void OnEraseBackground(wxEraseEvent& event);
void OnIdle(wxIdleEvent& event);
-
- // a window may have a default button
- // TODO move into wxPanel and/or wxFrame
- wxButton *GetDefaultItem() const { return m_btnDefault; }
- void SetDefaultItem(wxButton *btn) { m_btnDefault = btn; }
+ void OnPaint(wxPaintEvent& event);
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();
- virtual bool MSWCommand(WXUINT param, WXWORD id);
WXFARPROC MSWGetOldWndProc() const { return m_oldWndProc; }
void MSWSetOldWndProc(WXFARPROC proc) { m_oldWndProc = proc; }
- virtual wxWindow *FindItem(int id) const;
- virtual wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const ;
- virtual void PreDelete(WXHDC dc); // Allows system cleanup
+ // 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;
// Make a Windows extended style from the given wxWindows window style
- virtual WXDWORD MakeExtendedStyle(long style, bool eliminateBorders = TRUE);
+ static WXDWORD MakeExtendedStyle(long style,
+ bool eliminateBorders = FALSE);
+
// Determine whether 3D effects are wanted
- virtual WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D);
+ 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; };
- wxObject *GetChild(int number) const ;
-
- // returns TRUE if the window has been created
- bool MSWCreate(int id,
- wxWindow *parent,
- const char *wclass,
- wxWindow *wx_win,
- const char *title,
- int x, int y, int width, int height,
- WXDWORD style,
- const char *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);
- // Actually defined in wx_canvs.cc since requires wxCanvas declaration
- virtual void MSWDeviceToLogical(float *x, float *y) const ;
+ 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
+#ifndef __WXUNIVERSAL__
// Create an appropriate wxWindow from a HWND
virtual wxWindow* CreateWindowFromHWND(wxWindow* parent, WXHWND hWnd);
// Make sure the window style reflects the HWND style (roughly)
virtual void AdoptAttributesFromHWND();
+#endif // __WXUNIVERSAL__
// Setup background and foreground colours correctly
virtual void SetupColours();
// ------------------------------------------------------------------------
- // internal handlers for MSW messages: all handlers return a boolen value:
- // TRUE means that the handler processed the event and FALSE that it didn't
+ // helpers for message handlers: these perform the same function as the
+ // message crackers from <windowsx.h> - they unpack WPARAM and LPARAM into
+ // the correct parameters
// ------------------------------------------------------------------------
- // TODO: all this should go away, overriding MSWWindowProc() is enough to
- // implement this functionality
- virtual bool MSWOnCreate(WXLPCREATESTRUCT cs, bool *mayCreate);
- virtual bool MSWOnPaint();
- virtual bool MSWOnEraseBkgnd(WXHDC pDC);
- virtual bool MSWOnSize(int x, int y, WXUINT flag);
+ void UnpackCommand(WXWPARAM wParam, WXLPARAM lParam,
+ WXWORD *id, WXHWND *hwnd, WXWORD *cmd);
+ void UnpackActivate(WXWPARAM wParam, WXLPARAM lParam,
+ WXWORD *state, WXWORD *minimized, WXHWND *hwnd);
+ void UnpackScroll(WXWPARAM wParam, WXLPARAM lParam,
+ WXWORD *code, WXWORD *pos, WXHWND *hwnd);
+ void UnpackCtlColor(WXWPARAM wParam, WXLPARAM lParam,
+ WXWORD *nCtlColor, WXHDC *hdc, WXHWND *hwnd);
+ void UnpackMenuSelect(WXWPARAM wParam, WXLPARAM lParam,
+ WXWORD *item, WXWORD *flags, WXHMENU *hmenu);
- virtual bool MSWOnQueryDragIcon(WXHICON *hIcon);
- virtual bool MSWOnWindowPosChanging(void *lpPos);
+ // ------------------------------------------------------------------------
+ // 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
+ // ------------------------------------------------------------------------
+
+ // there are several cases where we have virtual functions for Windows
+ // message processing: this is because these messages often require to be
+ // processed in a different manner in the derived classes. For all other
+ // messages, however, we do *not* have corresponding MSWOnXXX() function
+ // and if the derived class wants to process them, it should override
+ // MSWWindowProc() directly.
- // both horizontal and vertical
+ // scroll event (both horizontal and vertical)
virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
WXWORD pos, WXHWND control);
- virtual bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
- virtual bool MSWOnSysCommand(WXWPARAM wParam, WXLPARAM lParam);
-
+ // child control notifications
#ifdef __WIN95__
virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
#endif // __WIN95__
- virtual bool MSWOnCtlColor(WXHBRUSH *hBrush,
- WXHDC hdc,
- WXHWND hWnd,
- WXUINT nCtlColor,
- WXUINT message,
- WXWPARAM wParam,
- WXLPARAM lParam);
+ // owner-drawn controls need to process these messages
+ virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item);
+ virtual bool MSWOnMeasureItem(int id, WXMEASUREITEMSTRUCT *item);
- virtual bool MSWOnPaletteChanged(WXHWND hWndPalChange);
- virtual bool MSWOnQueryNewPalette();
+ // the rest are not virtual
+ bool HandleCreate(WXLPCREATESTRUCT cs, bool *mayCreate);
+ bool HandleInitDialog(WXHWND hWndFocus);
+ bool HandleDestroy();
- virtual bool MSWOnQueryEndSession(long logOff, bool *mayEnd);
- virtual bool MSWOnEndSession(bool endSession, long logOff);
+ bool HandlePaint();
+ bool HandleEraseBkgnd(WXHDC pDC);
- virtual bool MSWOnDestroy();
- virtual bool MSWOnSetFocus(WXHWND wnd);
- virtual bool MSWOnKillFocus(WXHWND wnd);
- virtual bool MSWOnDropFiles(WXWPARAM wParam);
- virtual bool MSWOnInitDialog(WXHWND hWndFocus);
- virtual bool MSWOnShow(bool show, int status);
+ bool HandleMinimize();
+ bool HandleMaximize();
+ bool HandleSize(int x, int y, WXUINT flag);
+ bool HandleGetMinMaxInfo(void *mmInfo);
- virtual bool MSWOnMouseEvent(WXUINT msg, int x, int y, WXUINT flags);
- virtual bool MSWOnMouseMove(int x, int y, WXUINT flags);
+ bool HandleShow(bool show, int status);
+ bool HandleActivate(int flag, bool minimized, WXHWND activate);
- virtual bool MSWOnChar(WXWORD wParam, WXLPARAM lParam, bool isASCII = FALSE);
- virtual bool MSWOnKeyDown(WXWORD wParam, WXLPARAM lParam);
- virtual bool MSWOnKeyUp(WXWORD wParam, WXLPARAM lParam);
+ bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
+ bool HandleSysCommand(WXWPARAM wParam, WXLPARAM lParam);
- virtual bool MSWOnActivate(int flag, bool minimized, WXHWND activate);
- virtual bool MSWOnMDIActivate(long flag, WXHWND activate, WXHWND deactivate);
+ bool HandleCtlColor(WXHBRUSH *hBrush,
+ WXHDC hdc,
+ WXHWND hWnd,
+ WXUINT nCtlColor,
+ WXUINT message,
+ WXWPARAM wParam,
+ WXLPARAM lParam);
- virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item);
- virtual bool MSWOnMeasureItem(int id, WXMEASUREITEMSTRUCT *item);
+ 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 HandleSetFocus(WXHWND wnd);
+ bool HandleKillFocus(WXHWND wnd);
+
+ bool HandleDropFiles(WXWPARAM wParam);
+
+ bool HandleMouseEvent(WXUINT msg, int x, int y, WXUINT flags);
+ bool HandleMouseMove(int x, int y, WXUINT flags);
+ bool HandleMouseWheel(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);
+
+ bool HandleQueryDragIcon(WXHICON *hIcon);
+
+ bool HandleSetCursor(WXHWND hWnd, short nHitTest, int mouseMsg);
// Window procedure
virtual long MSWWindowProc(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);
+
+ // 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
// initialize various fields of wxMouseEvent (common part of MSWOnMouseXXX)
void InitMouseEvent(wxMouseEvent& event, int x, int y, WXUINT flags);
+ // check if mouse is in the window
+ bool IsMouseInWindow() const;
+
protected:
// the window handle
WXHWND m_hWnd;
// additional (MSW specific) flags
bool m_useCtl3D:1; // Using CTL3D for this control
- bool m_inOnSize:1; // Protection against OnSize reentry
bool m_backgroundTransparent:1;
bool m_mouseInWindow:1;
- bool m_doubleClickAllowed:1;
- bool m_winCaptured:1;
-
- // Caret data
- bool m_caretEnabled:1;
- bool m_caretShown:1;
- int m_caretWidth;
- int m_caretHeight;
+ bool m_lastKeydownProcessed:1;
// the size of one page for scrolling
int m_xThumbSize;
WXHMENU m_hMenu; // Menu, if any
- wxButton *m_btnDefault;
-
// implement the base class pure virtuals
+ virtual void DoClientToScreen( int *x, int *y ) const;
+ virtual void DoScreenToClient( int *x, int *y ) const;
virtual void DoGetPosition( int *x, int *y ) const;
virtual void DoGetSize( int *width, int *height ) const;
virtual void DoGetClientSize( int *width, int *height ) const;
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
+ // themselves inside the given rectangle
+ virtual void DoMoveWindow(int x, int y, int width, int height);
+
#if wxUSE_TOOLTIPS
virtual void DoSetToolTip( wxToolTip *tip );
#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();
bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
#endif // __WIN95__
- DECLARE_NO_COPY_CLASS(wxWindow);
+ DECLARE_DYNAMIC_CLASS(wxWindowMSW)
+ DECLARE_NO_COPY_CLASS(wxWindowMSW)
DECLARE_EVENT_TABLE()
};
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_