]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/mac/window.h
applied Otto Wyss' patch to extend wxHelpController::KeywordSearch with mode argument...
[wxWidgets.git] / include / wx / mac / window.h
index ba8b50315f183f1d4ba1b95b9a4821e1e8345d5f..807e261863b40595d0588e07a177bce262fe4015 100644 (file)
@@ -1,72 +1,66 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        window.h
-// Purpose:     wxWindow class
-// Author:      AUTHOR
+// Purpose:     wxWindowMac class
+// Author:      Stefan Csomor
 // Modified by:
-// Created:     ??/??/98
+// Created:     1998-01-01
 // RCS-ID:      $Id$
-// Copyright:   (c) AUTHOR
-// Licence:    wxWindows licence
+// Copyright:   (c) Stefan Csomor
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_WINDOW_H_
 #define _WX_WINDOW_H_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "window.h"
 #endif
 
+#include "wx/brush.h"
+
 // ---------------------------------------------------------------------------
 // forward declarations
 // ---------------------------------------------------------------------------
 
 class WXDLLEXPORT wxButton;
 class WXDLLEXPORT wxScrollBar;
+class WXDLLEXPORT wxTopLevelWindowMac;
 
 // ---------------------------------------------------------------------------
 // constants
 // ---------------------------------------------------------------------------
 
-// FIXME does anybody use those? they're unused by wxWindows...
-enum
-{
-    wxKEY_SHIFT = 1,
-    wxKEY_CTRL  = 2
-};
-
-class WXDLLEXPORT wxWindow: public wxWindowBase
+class WXDLLEXPORT wxWindowMac: public wxWindowBase
 {
-  DECLARE_DYNAMIC_CLASS(wxWindow);
-
-  friend class wxDC;
-  friend class wxPaintDC;
-
+    DECLARE_DYNAMIC_CLASS(wxWindowMac)
+        
+    friend class wxDC;
+    friend class wxPaintDC;
+    
 public:
-       typedef struct MacWindowData
-       {
-                       SInt16                                                          m_macWindowBackgroundTheme ;
-                       WindowRef                                                       m_macWindow ;
-                       ControlHandle                                   m_macRootControl ;
-                       wxWindow*                                                       m_macFocus ;
-       } MacWindowData ;
-       
-       
-    wxWindow() { Init(); }
-
-    wxWindow(wxWindow *parent,
-             wxWindowID id,
-             const wxPoint& pos = wxDefaultPosition,
-             const wxSize& size = wxDefaultSize,
-             long style = 0,
-             const wxString& name = wxPanelNameStr)
+    
+    wxWindowMac()
+        : m_macBackgroundBrush()
+        , m_macVisibleRegion()
+        , m_x(0), m_y(0), m_width(0), m_height(0)
+        , m_hScrollBar(NULL), m_vScrollBar(NULL)
+        , m_label(wxEmptyString)
+        { Init(); }
+
+    wxWindowMac(wxWindowMac *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 ~wxWindowMac();
 
-    bool Create(wxWindow *parent,
+    bool Create(wxWindowMac *parent,
                 wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
@@ -86,18 +80,14 @@ public:
 
     virtual void SetFocus();
 
-
     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 Clear();
 
     virtual bool SetCursor( const wxCursor &cursor );
-    virtual bool SetFont( const wxFont &font );
-
+    virtual bool SetFont(const wxFont& font)
+           { return wxWindowBase::SetFont(font); }
     virtual int GetCharHeight() const;
     virtual int GetCharWidth() const;
     virtual void GetTextExtent(const wxString& string,
@@ -125,75 +115,51 @@ 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
-
     // Native resource loading (implemented in src/msw/nativdlg.cpp)
     // FIXME: should they really be all virtual?
-    wxWindow* GetWindowChild1(wxWindowID id);
-    wxWindow* GetWindowChild(wxWindowID id);
+    wxWindowMac* GetWindowChild1(wxWindowID id);
+    wxWindowMac* GetWindowChild(wxWindowID id);
 
     // implementation from now on
     // --------------------------
 
-       void MacClientToRootWindow( int *x , int *y ) const ;
-       void MacRootWindowToClient( int *x , int *y ) const ;
-
+    void MacClientToRootWindow( int *x , int *y ) const ;
+    void MacRootWindowToClient( int *x , int *y ) const ;
+    void MacWindowToRootWindow( int *x , int *y ) const ;
+    void MacRootWindowToWindow( int *x , int *y ) const ;
+    
+    virtual wxString MacGetToolTipString( wxPoint &where ) ;
 
     // simple accessors
     // ----------------
 
 //    WXHWND GetHWND() const { return m_hWnd; }
 //    void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
-       virtual WXWidget GetHandle() const { return (WXWidget) NULL ; }
+    virtual WXWidget GetHandle() const { return (WXWidget) NULL ; }
 
-    bool GetUseCtl3D() const { return m_useCtl3D; }
     bool GetTransparentBackground() const { return m_backgroundTransparent; }
     void SetTransparent(bool t = TRUE) { m_backgroundTransparent = t; }
 
     // event handlers
     // --------------
+    void OnSetFocus(wxFocusEvent& event) ;
+    void OnNcPaint(wxNcPaintEvent& event);
     void OnEraseBackground(wxEraseEvent& event);
-    void OnIdle(wxIdleEvent& event);
+    void OnMouseEvent( wxMouseEvent &event ) ;
+
     void MacOnScroll(wxScrollEvent&event ) ;
     
     bool AcceptsFocus() const ;
 
 public:
+    void OnInternalIdle();
+
     // 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);
-
-    wxWindow *FindItem(long id) const;
-    wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const;
+    wxWindowMac *FindItem(long id) const;
+    wxWindowMac *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const;
 
     // Make a Windows extended style from the given wxWindows window style
     static WXDWORD MakeExtendedStyle(long style,
@@ -204,90 +170,68 @@ public:
     // MSW only: TRUE if this control is part of the main control
     virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; };
 
- #if WXWIN_COMPATIBILITY
-    wxObject *GetChild(int number) const;
-    virtual void MSWDeviceToLogical(float *x, float *y) const;
-#endif // WXWIN_COMPATIBILITY
-
     // Setup background and foreground colours correctly
     virtual void SetupColours();
 
-
-#if WXWIN_COMPATIBILITY
-    void SetShowing(bool show) { (void)Show(show); }
-    bool IsUserEnabled() const { return IsEnabled(); }
-#endif // WXWIN_COMPATIBILITY
-
-    // Responds to colour changes: passes event on to children.
-    void OnSysColourChanged(wxSysColourChangedEvent& event);
-
-public :
-       static bool                                                     MacGetWindowFromPoint( const wxPoint &point , wxWindow** outWin ) ;
-       virtual void                                            MacActivate( EventRecord *ev , bool inIsActivating ) ;
-       virtual void                                            MacUpdate( EventRecord *ev ) ;
-       virtual void                                            MacUpdateImmediately() ;
-       virtual void                                            MacRedraw( RgnHandle updatergn , long time) ;
-       virtual void                                            MacMouseDown( EventRecord *ev , short windowPart ) ;
-       virtual void                                            MacMouseUp( EventRecord *ev , short windowPart ) ;
-       virtual void                                            MacMouseMoved( EventRecord *ev , short windowPart ) ;
-       virtual void                                            MacKeyDown( EventRecord *ev ) ;
-       virtual bool                                            MacCanFocus() const { return true ; }
-
-       virtual void                                            MacFireMouseEvent( EventRecord *ev ) ;
-       virtual bool                                            MacDispatchMouseEvent(wxMouseEvent& event ) ;
-       virtual void                                            MacEraseBackground( Rect *rect ) ;
-       virtual void                                            MacPaint( wxPaintEvent &event ) ;
-       WindowRef                                                               GetMacRootWindow() const  ;
-
-       virtual ControlHandle   MacGetContainerForEmbedding() ;
-       virtual void                                            MacSuperChangedPosition() ;
-       virtual void                                            MacSuperShown( bool show ) ;
-
-       bool                                                                            MacSetupFocusPort() ;
-       bool                                                                            MacSetupDrawingPort() ;
-       bool                                                                            MacSetupFocusClientPort() ;
-       bool                                                                            MacSetupDrawingClientPort() ;
-       
-       virtual bool                                            MacSetPortFocusParams( const Point & localOrigin, const Rect & clipRect, WindowRef window , wxWindow* rootwin )  ;
-       virtual bool                                            MacSetPortDrawingParams( const Point & localOrigin, const Rect & clipRect, WindowRef window , wxWindow* rootwin )  ;
-
-       virtual void                                            MacGetPortParams(Point* localOrigin, Rect* clipRect, WindowRef *window , wxWindow** rootwin ) ;
-       virtual void                                            MacGetPortClientParams(Point* localOrigin, Rect* clipRect, WindowRef *window  , wxWindow** rootwin) ;
-       MacWindowData*                                          MacGetWindowData() { return m_macWindowData ; }
-       static WindowRef                                        MacGetWindowInUpdate() { return s_macWindowInUpdate ; }
-       bool                                                            MacIsWindowScrollbar( const wxScrollBar* sb ) { return (m_hScrollBar == sb || m_vScrollBar == sb) ; }
-       static wxWindow*                                        s_lastMouseWindow ;
+public:
+    static bool          MacGetWindowFromPoint( const wxPoint &point , wxWindowMac** outWin ) ;
+    virtual bool         MacGetWindowFromPointSub( const wxPoint &point , wxWindowMac** outWin ) ;
+    virtual void         MacRedraw( WXHRGN updatergn , long time , bool erase) ;
+    virtual bool         MacCanFocus() const { return true ; }
+    
+    virtual bool         MacDispatchMouseEvent(wxMouseEvent& event ) ;
+    // this should not be overriden in classes above wxWindowMac because it is called from its destructor via DeleteChildren
+    virtual void         RemoveChild( wxWindowBase *child );
+    virtual void         MacPaintBorders( int left , int top ) ;
+    WXWindow             MacGetRootWindow() const  ;
+    wxTopLevelWindowMac* MacGetTopLevelWindow() const ;
+    
+    virtual WXWidget     MacGetContainerForEmbedding() ;
+    
+    virtual long         MacGetLeftBorderSize() const ;
+    virtual long         MacGetRightBorderSize() const ;
+    virtual long         MacGetTopBorderSize() const ;
+    virtual long         MacGetBottomBorderSize() const ;
+    
+    static long          MacRemoveBordersFromStyle( long style ) ;
+    virtual void         MacSuperChangedPosition() ;
+    // the absolute coordinates of this item within the toplevel window may have changed
+    virtual void         MacUpdateDimensions() {}
+    // the absolute coortinates of this window's root have changed
+    virtual void         MacTopLevelWindowChangedPosition() ;
+    virtual void         MacSuperShown( bool show ) ;
+    virtual void         MacSuperEnabled( bool enable ) ;
+    bool                 MacIsReallyShown() const ;
+    virtual void         Update() ;
+    // for compatibility
+    void                 MacUpdateImmediately() { Update() ; }
+    virtual bool         MacSetupCursor( const wxPoint& pt ) ;
+        
+//    virtual bool         MacSetPortDrawingParams( const Point & localOrigin, const Rect & clipRect, WindowRef window , wxWindowMac* rootwin )  ;
+//    virtual void         MacGetPortParams(Point* localOrigin, Rect* clipRect, WindowRef *window , wxWindowMac** rootwin ) ;
+//    virtual void         MacGetPortClientParams(Point* localOrigin, Rect* clipRect, WindowRef *window  , wxWindowMac** rootwin) ;
+    const wxBrush&       MacGetBackgroundBrush() ;
+    const wxRegion&      MacGetVisibleRegion( bool respectChildrenAndSiblings = true ) ;
+    bool                 MacIsWindowScrollbar( const wxScrollBar* sb )
+        { return (m_hScrollBar == sb || m_vScrollBar == sb) ; }
+    static wxWindowMac*  s_lastMouseWindow ;
 private:
-       virtual bool                                            MacGetWindowFromPointSub( const wxPoint &point , wxWindow** outWin ) ;
 protected:
+    wxBrush              m_macBackgroundBrush ;
+    wxRegion             m_macVisibleRegion ;
+    int                  m_x ;
+    int                  m_y ;
+    int                  m_width ;
+    int                  m_height ;
+    
+    wxScrollBar*         m_hScrollBar ;
+    wxScrollBar*         m_vScrollBar ;
+    wxString             m_label ;
+    
+    void                 MacCreateScrollBars( long style ) ;
+    void                 MacRepositionScrollBars() ;
 
-       MacWindowData*                          m_macWindowData ;
-       static WindowRef                        s_macWindowInUpdate ;
-
-       int                                                                     m_x ;
-       int                                                                     m_y ;   
-       int                                                                     m_width ;
-       int                                                                     m_height ;
-
-       wxScrollBar*                                    m_hScrollBar ;
-       wxScrollBar*                                    m_vScrollBar ;
-       wxString                                                m_label ;
-
-       void                                                                    MacCreateScrollBars( long style ) ;
-       void                                                                    MacRepositionScrollBars() ;
-
-    // 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_winCaptured:1;
-
-    // the size of one page for scrolling
-    int                   m_xThumbSize;
-    int                   m_yThumbSize;
-
-//    WXHMENU               m_hMenu; // Menu, if any
+    bool                 m_backgroundTransparent ;
 
     // implement the base class pure virtuals
     virtual void DoClientToScreen( int *x, int *y ) const;
@@ -300,6 +244,9 @@ protected:
                            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
@@ -314,69 +261,9 @@ private:
     // common part of all ctors
     void Init();
 
-    DECLARE_NO_COPY_CLASS(wxWindow);
+    DECLARE_NO_COPY_CLASS(wxWindowMac)
     DECLARE_EVENT_TABLE()
 };
 
-// associate mac windows with wx counterparts
-
-wxWindow* wxFindWinFromMacWindow( WindowRef inWindow ) ;
-void wxAssociateWinWithMacWindow(WindowRef inWindow, wxWindow *win) ;
-void wxRemoveMacWindowAssociation(wxWindow *win) ;
-
-class wxMacFocusHelper
-{
-public :
-       wxMacFocusHelper( wxWindow * theWindow ) ;
-       ~wxMacFocusHelper() ;
-       bool Ok() { return m_ok ; }
-
-private :
-       GrafPtr         m_formerPort ;
-       GrafPtr         m_currentPort ;
-       bool                    m_ok ;
-} ;
-
-class wxMacDrawingHelper
-{
-public :
-       wxMacDrawingHelper( wxWindow * theWindow ) ;
-       ~wxMacDrawingHelper() ;
-       bool Ok() { return m_ok ; }
-
-private :
-       GrafPtr         m_formerPort ;
-       GrafPtr         m_currentPort ;
-       PenState        m_savedPenState ;
-       bool                    m_ok ;
-} ;
-
-class wxMacFocusClientHelper
-{
-public :
-       wxMacFocusClientHelper( wxWindow * theWindow ) ;
-       ~wxMacFocusClientHelper() ;
-       bool Ok() { return m_ok ; }
-
-private :
-       GrafPtr         m_formerPort ;
-       GrafPtr         m_currentPort ;
-       bool                    m_ok ;
-} ;
-
-class wxMacDrawingClientHelper
-{
-public :
-       wxMacDrawingClientHelper( wxWindow * theWindow ) ;
-       ~wxMacDrawingClientHelper() ;
-       bool Ok() { return m_ok ; }
-
-private :
-       GrafPtr         m_formerPort ;
-       GrafPtr         m_currentPort ;
-       PenState        m_savedPenState ;
-       bool                    m_ok ;
-} ;
-
 #endif
     // _WX_WINDOW_H_