]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/window.h
EXPORTED an array to quiet the DLL compilation
[wxWidgets.git] / include / wx / msw / window.h
index f84926536db085f2d2ec25d23e50280e2323734b..1ae0efd35c37552e0cb0f62d4daf3dad859f0de2 100644 (file)
     #pragma interface "window.h"
 #endif
 
-// windows.h #defines the following identifiers which are also used in wxWin
-#ifdef GetCharWidth
-    #undef GetCharWidth
-#endif
+// #include "wx/msw/winundef.h"
 
-#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
+#define wxUSE_MOUSEEVENT_HACK 0
 
 // ---------------------------------------------------------------------------
 // forward declarations
@@ -49,6 +49,7 @@ enum
 // ---------------------------------------------------------------------------
 // wxWindow declaration for MSW
 // ---------------------------------------------------------------------------
+
 class WXDLLEXPORT wxWindow : public wxWindowBase
 {
     DECLARE_DYNAMIC_CLASS(wxWindow);
@@ -77,6 +78,9 @@ public:
                 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();
 
@@ -107,10 +111,7 @@ public:
                                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 );
+    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
                                int range, bool refresh = TRUE );
@@ -134,30 +135,33 @@ public:
     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
 
     // 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);
 
     // implementation from now on
     // --------------------------
@@ -176,17 +180,8 @@ public:
     // event handlers
     // --------------
     void OnEraseBackground(wxEraseEvent& event);
-    void OnKeyDown(wxKeyEvent& event);
-    void OnKeyUp(wxKeyEvent& event);
-    void OnPaint(wxPaintEvent& event);
-    void OnChar(wxKeyEvent& 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; }
-
 public:
     // For implementation purposes - sometimes decorations make the client area
     // smaller
@@ -199,33 +194,38 @@ public:
     // Windows subclassing
     void SubclassWin(WXHWND hWnd);
     void UnsubclassWin();
-    virtual long Default();
-    virtual bool MSWCommand(WXUINT param, WXWORD id);
 
-    // returns TRUE if the event was processed
-    virtual bool MSWNotify(WXWPARAM wParam, WXLPARAM lParam, WXLPARAM *result);
+    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
+    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 = TRUE);
     // 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 ;
-
-    void 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,
-            WXDWORD exendedStyle = 0);
+    // 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,
+                   WXDWORD exendedStyle = 0);
+    virtual bool MSWCommand(WXUINT param, WXWORD id);
 
-    // Actually defined in wx_canvs.cc since requires wxCanvas declaration
-    virtual void MSWDeviceToLogical(float *x, float *y) const ;
+#if WXWIN_COMPATIBILITY
+    wxObject *GetChild(int number) const;
+    virtual void MSWDeviceToLogical(float *x, float *y) const;
+#endif // WXWIN_COMPATIBILITY
 
     // Create an appropriate wxWindow from a HWND
     virtual wxWindow* CreateWindowFromHWND(wxWindow* parent, WXHWND hWnd);
@@ -236,74 +236,97 @@ public:
     // Setup background and foreground colours correctly
     virtual void SetupColours();
 
-    // Saves the last message information before calling base version
-    virtual bool ProcessEvent(wxEvent& event);
-
-    // Handlers
-    virtual void MSWOnCreate(WXLPCREATESTRUCT cs);
-    virtual bool MSWOnPaint();
-    virtual WXHICON MSWOnQueryDragIcon() { return 0; }
-    virtual void MSWOnSize(int x, int y, WXUINT flag);
-    virtual void MSWOnWindowPosChanging(void *lpPos);
-    virtual void MSWOnHScroll(WXWORD nSBCode, WXWORD pos, WXHWND control);
-    virtual void MSWOnVScroll(WXWORD nSBCode, WXWORD pos, WXHWND control);
-    virtual bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
-    virtual long MSWOnSysCommand(WXWPARAM wParam, WXLPARAM lParam);
-    virtual long MSWOnNotify(WXWPARAM wParam, WXLPARAM lParam);
-    virtual WXHBRUSH MSWOnCtlColor(WXHDC dc, WXHWND pWnd, WXUINT nCtlColor,
-            WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
-    virtual bool MSWOnColorChange(WXHWND hWnd, WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
-    virtual long MSWOnPaletteChanged(WXHWND hWndPalChange);
-    virtual long MSWOnQueryNewPalette();
-    virtual bool MSWOnEraseBkgnd(WXHDC pDC);
-    virtual void MSWOnMenuHighlight(WXWORD item, WXWORD flags, WXHMENU sysmenu);
-    virtual void MSWOnInitMenuPopup(WXHMENU menu, int pos, bool isSystem);
-    virtual bool MSWOnClose();
-    // Return TRUE to end session, FALSE to veto end session.
-    virtual bool MSWOnQueryEndSession(long logOff);
-    virtual bool MSWOnEndSession(bool endSession, long logOff);
-    virtual bool MSWOnDestroy();
-    virtual bool MSWOnSetFocus(WXHWND wnd);
-    virtual bool MSWOnKillFocus(WXHWND wnd);
-    virtual void MSWOnDropFiles(WXWPARAM wParam);
-    virtual bool MSWOnInitDialog(WXHWND hWndFocus);
-    virtual void MSWOnShow(bool show, int status);
-
-    // TODO: rationalise these functions into 1 or 2 which take the
-    // event type as argument.
-    virtual void MSWOnLButtonDown(int x, int y, WXUINT flags);
-    virtual void MSWOnLButtonUp(int x, int y, WXUINT flags);
-    virtual void MSWOnLButtonDClick(int x, int y, WXUINT flags);
-
-    virtual void MSWOnMButtonDown(int x, int y, WXUINT flags);
-    virtual void MSWOnMButtonUp(int x, int y, WXUINT flags);
-    virtual void MSWOnMButtonDClick(int x, int y, WXUINT flags);
-
-    virtual void MSWOnRButtonDown(int x, int y, WXUINT flags);
-    virtual void MSWOnRButtonUp(int x, int y, WXUINT flags);
-    virtual void MSWOnRButtonDClick(int x, int y, WXUINT flags);
-
-    virtual void MSWOnMouseMove(int x, int y, WXUINT flags);
-    virtual void MSWOnMouseEnter(int x, int y, WXUINT flags);
-    virtual void MSWOnMouseLeave(int x, int y, WXUINT flags);
-
-    // These return TRUE if an event handler was found, FALSE otherwise (not processed)
-    virtual bool MSWOnChar(WXWORD wParam, WXLPARAM lParam, bool isASCII = FALSE);
-    virtual bool MSWOnKeyDown(WXWORD wParam, WXLPARAM lParam);
-    virtual bool MSWOnKeyUp(WXWORD wParam, WXLPARAM lParam);
-
-    virtual bool MSWOnActivate(int flag, bool minimized, WXHWND activate);
-    virtual long MSWOnMDIActivate(long flag, WXHWND activate, WXHWND deactivate);
-
+    // ------------------------------------------------------------------------
+    // 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
+    // ------------------------------------------------------------------------
+
+    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);
+
+    // ------------------------------------------------------------------------
+    // 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
+    // ------------------------------------------------------------------------
+
+    // 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.
+
+    // scroll event (both horizontal and vertical)
+    virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
+                             WXWORD pos, WXHWND control);
+
+    // child control notifications
+#ifdef __WIN95__
+    virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
+#endif // __WIN95__
+
+    // owner-drawn controls need to process these messages
     virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item);
     virtual bool MSWOnMeasureItem(int id, WXMEASUREITEMSTRUCT *item);
 
-    virtual void MSWOnJoyDown(int joystick, int x, int y, WXUINT flags);
-    virtual void MSWOnJoyUp(int joystick, int x, int y, WXUINT flags);
-    virtual void MSWOnJoyMove(int joystick, int x, int y, WXUINT flags);
-    virtual void MSWOnJoyZMove(int joystick, int z, WXUINT flags);
+    // the rest are not virtual
+    bool HandleCreate(WXLPCREATESTRUCT cs, bool *mayCreate);
+    bool HandleInitDialog(WXHWND hWndFocus);
+    bool HandleDestroy();
+
+    bool HandlePaint();
+    bool HandleEraseBkgnd(WXHDC pDC);
+
+    bool HandleMinimize();
+    bool HandleMaximize();
+    bool HandleSize(int x, int y, WXUINT flag);
+    bool HandleGetMinMaxInfo(void *mmInfo);
 
-    virtual long MSWGetDlgCode();
+    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 HandlePaletteChanged(WXHWND hWndPalChange);
+    bool HandleQueryNewPalette();
+    bool HandleSysColorChange();
+
+    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 HandleChar(WXWORD wParam, WXLPARAM lParam, bool isASCII = FALSE);
+    bool HandleKeyDown(WXWORD wParam, WXLPARAM lParam);
+    bool HandleKeyUp(WXWORD 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);
@@ -317,12 +340,14 @@ public:
     // Detach "Window" menu from menu bar so it doesn't get deleted
     void MSWDetachWindowMenu();
 
-    inline WXFARPROC MSWGetOldWndProc() const;
-    inline void MSWSetOldWndProc(WXFARPROC proc);
-
-    // Define for each class of dialog and control
-    virtual WXHBRUSH OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
-            WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
+    // 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); }
@@ -332,13 +357,8 @@ public:
     // Responds to colour changes: passes event on to children.
     void OnSysColourChanged(wxSysColourChangedEvent& event);
 
-    // remember the parameters of the last message
-    void PushLastMessage(WXUINT msg, WXWPARAM wParam, WXLPARAM lParam)
-    {
-        m_lastMsg = msg;
-        m_lastWParam = wParam;
-        m_lastLParam = lParam;
-    }
+    // initialize various fields of wxMouseEvent (common part of MSWOnMouseXXX)
+    void InitMouseEvent(wxMouseEvent& event, int x, int y, WXUINT flags);
 
 protected:
     // the window handle
@@ -349,37 +369,30 @@ protected:
 
     // 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;
-
     // the size of one page for scrolling
     int                   m_xThumbSize;
     int                   m_yThumbSize;
 
-    // the coordinates of the last mouse event and the typoe of it
+#if wxUSE_MOUSEEVENT_HACK
+    // the coordinates of the last mouse event and the type of it
     long                  m_lastMouseX,
                           m_lastMouseY;
     int                   m_lastMouseEvent;
-
-    // the parameters of the last message used in Default()
-    WXUINT                m_lastMsg;
-    WXWPARAM              m_lastWParam;
-    WXLPARAM              m_lastLParam;
+#endif // wxUSE_MOUSEEVENT_HACK
 
     WXHMENU               m_hMenu; // Menu, if any
 
-    wxButton             *m_btnDefault;
+    // 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;
     virtual void DoGetPosition( int *x, int *y ) const;
     virtual void DoGetSize( int *width, int *height ) const;
     virtual void DoGetClientSize( int *width, int *height ) const;
@@ -388,6 +401,16 @@ protected:
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
 
+    // get the size which best suits the window: e.g., for a static text it
+    // will be the width and height of the text
+    virtual wxSize DoGetBestSize();
+
+    // 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
@@ -396,6 +419,15 @@ private:
     // common part of all ctors
     void Init();
 
+    // the (non-virtual) handlers for the events
+    bool HandleMove(int x, int y);
+    bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);
+
+#ifdef __WIN95__
+    bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
+#endif // __WIN95__
+
+    DECLARE_NO_COPY_CLASS(wxWindow);
     DECLARE_EVENT_TABLE()
 };