Reworked Frame class

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

diff --git a/include/wx/msw/window.h b/include/wx/msw/window.h
index 7d2e8bd7a3967ae1e377fd830cb41a7f392965f0..20f6cbb2aa05d4203f0e11ea3189a0da19aeb811 100644 (file)
--- a/include/wx/msw/window.h
+++ b/include/wx/msw/window.h
@@ -20,14 +20,7 @@
     #pragma interface "window.h"
 #endif
 
     #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
+// #include "wx/msw/winundef.h"

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


@@ -56,10 +49,9 @@ enum
 // ---------------------------------------------------------------------------
 // wxWindow declaration for MSW
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // wxWindow declaration for MSW
 // ---------------------------------------------------------------------------

+

 class WXDLLEXPORT wxWindow : public wxWindowBase
 {
 class WXDLLEXPORT wxWindow : public wxWindowBase
 {

-    DECLARE_DYNAMIC_CLASS(wxWindow);
-

 public:
     wxWindow() { Init(); }
 
 public:
     wxWindow() { Init(); }
 


@@ -84,6 +76,9 @@ public:
                 const wxString& name = wxPanelNameStr);
 
     // implement base class pure virtuals
                 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 void Raise();
     virtual void Lower();
 


@@ -114,14 +109,7 @@ public:
                                const wxFont *theFont = (const wxFont *) NULL)
                                const;
 
                                const wxFont *theFont = (const wxFont *) NULL)
                                const;
 

-    virtual void ClientToScreen( int *x, int *y ) const;
-    virtual void ScreenToClient( int *x, int *y ) const;
-    wxPoint ClientToScreen(const wxPoint& pt) const
-        { int x = pt.x; int y = pt.y; ClientToScreen(& x, & y); return wxPoint(x, y); }
-    wxPoint ScreenToClient(const wxPoint& pt) const
-        { int x = pt.x; int y = pt.y; ScreenToClient(& x, & y); return wxPoint(x, y); }
-
-    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 );
 
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
                                int range, bool refresh = TRUE );


@@ -145,30 +133,33 @@ public:
     virtual void SetScrollPage(int orient, int page, bool refresh = TRUE);
     virtual int OldGetScrollRange(int orient) const;
     virtual int GetScrollPage(int orient) const;
     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)
         // 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);
 
     // 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
     // --------------------------
 
     // implementation from now on
     // --------------------------


@@ -186,14 +177,11 @@ public:
 
     // event handlers
     // --------------
 
     // event handlers
     // --------------

+
+    void OnSetFocus(wxFocusEvent& event);

     void OnEraseBackground(wxEraseEvent& event);
     void OnIdle(wxIdleEvent& event);
 
     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; }
-

 public:
     // For implementation purposes - sometimes decorations make the client area
     // smaller
 public:
     // For implementation purposes - sometimes decorations make the client area
     // smaller


@@ -206,38 +194,38 @@ public:
     // Windows subclassing
     void SubclassWin(WXHWND hWnd);
     void UnsubclassWin();
     // 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; }
 
 
     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
 
     // 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
     // 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; };
 
 
     // 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,
     // returns TRUE if the window has been created
     bool MSWCreate(int id,
                    wxWindow *parent,

-                   const char *wclass,
+                   const wxChar *wclass,

                    wxWindow *wx_win,
                    wxWindow *wx_win,

-                   const char *title,
+                   const wxChar *title,

                    int x, int y, int width, int height,
                    WXDWORD style,
                    int x, int y, int width, int height,
                    WXDWORD style,

-                   const char *dialog_template = NULL,
+                   const wxChar *dialog_template = NULL,

                    WXDWORD exendedStyle = 0);
                    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);
 
     // Create an appropriate wxWindow from a HWND
     virtual wxWindow* CreateWindowFromHWND(wxWindow* parent, WXHWND hWnd);


@@ -248,65 +236,97 @@ public:
     // Setup background and foreground colours correctly
     virtual void SetupColours();
 
     // Setup background and foreground colours correctly
     virtual void SetupColours();
 

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

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

 
 

-    virtual bool MSWOnQueryDragIcon(WXHICON *hIcon);
-    virtual bool MSWOnWindowPosChanging(void *lpPos);
-
-    // both horizontal and vertical
+    // scroll event (both horizontal and vertical)

     virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
                              WXWORD pos, WXHWND control);
 
     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__
 
 #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 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);
 
     // Window procedure
     virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);


@@ -354,12 +374,6 @@ protected:
     bool                  m_doubleClickAllowed:1;
     bool                  m_winCaptured: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 size of one page for scrolling
     int                   m_xThumbSize;
     int                   m_yThumbSize;


@@ -373,9 +387,12 @@ protected:
 
     WXHMENU               m_hMenu; // Menu, if any
 
 
     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
 
     // 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;
     virtual void DoGetPosition( int *x, int *y ) const;
     virtual void DoGetSize( int *width, int *height ) const;
     virtual void DoGetClientSize( int *width, int *height ) const;


@@ -384,6 +401,12 @@ protected:
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
 
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
 

+    // 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
 #if wxUSE_TOOLTIPS
     virtual void DoSetToolTip( wxToolTip *tip );
 #endif // wxUSE_TOOLTIPS


@@ -400,6 +423,10 @@ private:
     bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 #endif // __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;
+
+    DECLARE_DYNAMIC_CLASS(wxWindow);

     DECLARE_NO_COPY_CLASS(wxWindow);
     DECLARE_EVENT_TABLE()
 };
     DECLARE_NO_COPY_CLASS(wxWindow);
     DECLARE_EVENT_TABLE()
 };