Basic support for tooltips under OS X Cocoa.

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

diff --git a/include/wx/osx/window.h b/include/wx/osx/window.h
index 1137022d2163b2d409e3c9aa1619e5560c23c989..bdf48d8f74778af2baba84040fb1c0b421934cd2 100644 (file)
--- a/include/wx/osx/window.h
+++ b/include/wx/osx/window.h
@@ -17,10 +17,17 @@
 
 class WXDLLIMPEXP_FWD_CORE wxButton;
 class WXDLLIMPEXP_FWD_CORE wxScrollBar;
+class WXDLLIMPEXP_FWD_CORE wxPanel;
 class WXDLLIMPEXP_FWD_CORE wxNonOwnedWindow;
 
-class WXDLLIMPEXP_FWD_CORE wxMacControl ;
-class WXDLLIMPEXP_FWD_CORE wxWidgetImpl ;
+#if wxOSX_USE_CARBON
+    class WXDLLIMPEXP_FWD_CORE wxMacControl ;
+    typedef wxMacControl wxOSXWidgetImpl;
+#elif wxOSX_USE_COCOA_OR_IPHONE
+    class WXDLLIMPEXP_FWD_CORE wxWidgetImpl ;
+    typedef wxWidgetImpl wxOSXWidgetImpl;
+#endif
+
 
 class WXDLLIMPEXP_CORE wxWindowMac: public wxWindowBase
 {
@@ -56,6 +63,16 @@ public:
     virtual void Lower();
 
     virtual bool Show( bool show = true );
+    virtual bool ShowWithEffect(wxShowEffect effect,
+                                unsigned timeout = 0)
+    {
+        return OSXShowWithEffect(true, effect, timeout);
+    }
+    virtual bool HideWithEffect(wxShowEffect effect,
+                                unsigned timeout = 0)
+    {
+        return OSXShowWithEffect(false, effect, timeout);
+    }
 
     virtual bool IsShownOnScreen() const;
 
@@ -76,20 +93,6 @@ public:
 
     virtual int GetCharHeight() const;
     virtual int GetCharWidth() const;
-    virtual void GetTextExtent( const wxString& string,
-                               int *x, int *y,
-                               int *descent = NULL,
-                               int *externalLeading = NULL,
-                               const wxFont *theFont = NULL )
-                               const;
-protected:
-    virtual void DoEnable( bool enable );
-#if wxUSE_MENUS
-    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
-#endif
-
-    virtual void DoFreeze();
-    virtual void DoThaw();
 
 public:
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
@@ -138,9 +141,7 @@ public:
 
     // event handlers
     // --------------
-    void OnPaint( wxPaintEvent& event );
-    void OnNcPaint( wxNcPaintEvent& event );
-    void OnEraseBackground(wxEraseEvent& event );
+
     void OnMouseEvent( wxMouseEvent &event );
 
     void MacOnScroll( wxScrollEvent&event );
@@ -163,11 +164,12 @@ public:
     wxWindowMac *FindItemByHWND(WXHWND hWnd, bool controlOnly = false) const;
 
     virtual void        TriggerScrollEvent( wxEventType scrollEvent ) ;
-    virtual bool        MacDoRedraw( void* updatergn , long time ) ;
-
     // this should not be overriden in classes above wxWindowMac
     // because it is called from its destructor via DeleteChildren
     virtual void        RemoveChild( wxWindowBase *child );
+
+    virtual bool        MacDoRedraw( long time ) ;
+    virtual void        MacPaintChildrenBorders();
     virtual void        MacPaintBorders( int left , int top ) ;
     void                MacPaintGrowBox();
 
@@ -197,7 +199,10 @@ public:
     bool                MacIsReallyEnabled() ;
     bool                MacIsReallyHilited() ;
 
+#if WXWIN_COMPATIBILITY_2_8
     bool                MacIsUserPane() { return m_macIsUserPane; }
+#endif
+    bool                MacIsUserPane() const { return m_macIsUserPane; }
 
     virtual bool        MacSetupCursor( const wxPoint& pt ) ;
 
@@ -240,29 +245,31 @@ public:
                                            int& w, int& h , bool adjustForOrigin ) const ;
 
     // the 'true' OS level control for this wxWindow
-#if wxOSX_USE_CARBON
-    wxMacControl*       GetPeer() const { return m_peer ; }
-#else
-    wxWidgetImpl*       GetPeer() const { return m_peer ; }
-#endif
- 
+    wxOSXWidgetImpl*       GetPeer() const { return m_peer ; }
+
+#if wxOSX_USE_COCOA_OR_IPHONE
+    // the NSView or NSWindow of this window: can be used for both child and
+    // non-owned windows
+    //
+    // this is useful for a few Cocoa function which can work with either views
+    // or windows indiscriminately, e.g. for setting NSViewAnimationTargetKey
+    virtual void *OSXGetViewOrWindow() const { return GetHandle(); }
+#endif // Cocoa
+
     void *              MacGetCGContextRef() { return m_cgContextRef ; }
     void                MacSetCGContextRef(void * cg) { m_cgContextRef = cg ; }
 
     // osx specific event handling common for all osx-ports
-    
+
     virtual bool        OSXHandleClicked( double timestampsec );
     virtual bool        OSXHandleKeyEvent( wxKeyEvent& event );
 protected:
     // For controls like radio buttons which are genuinely composite
     wxList              m_subControls;
 
-#if wxOSX_USE_CARBON
     // the peer object, allowing for cleaner API support
-    wxMacControl *       m_peer ;
-#else
-    wxWidgetImpl *       m_peer ;
-#endif
+    wxOSXWidgetImpl *   m_peer ;
+
     void *              m_cgContextRef ;
 
     // cache the clipped rectangles within the window hierarchy
@@ -288,6 +295,7 @@ protected:
     wxScrollBar*        m_vScrollBar ;
     bool                m_hScrollBarAlwaysShown;
     bool                m_vScrollBarAlwaysShown;
+    wxPanel*            m_growBox ;
     wxString            m_label ;
 
     // set to true if we do a sharp clip at the content area of this window
@@ -303,6 +311,20 @@ protected:
     void                MacUpdateControlFont() ;
 
     // implement the base class pure virtuals
+    virtual void DoGetTextExtent(const wxString& string,
+                                 int *x, int *y,
+                                 int *descent = NULL,
+                                 int *externalLeading = NULL,
+                                 const wxFont *theFont = NULL ) const;
+
+    virtual void DoEnable( bool enable );
+#if wxUSE_MENUS
+    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
+#endif
+
+    virtual void DoFreeze();
+    virtual void DoThaw();
+
     virtual wxSize DoGetBestSize() const;
     virtual wxSize DoGetSizeFromClientSize( const wxSize & size ) const;
     virtual void DoClientToScreen( int *x, int *y ) const;
@@ -329,6 +351,11 @@ protected:
     virtual void DoSetToolTip( wxToolTip *tip );
 #endif
 
+    // common part of Show/HideWithEffect()
+    virtual bool OSXShowWithEffect(bool show,
+                                   wxShowEffect effect,
+                                   unsigned timeout);
+
 private:
     // common part of all ctors
     void Init();
@@ -337,8 +364,7 @@ private:
     // AlwaysShowScrollbars()
     void DoUpdateScrollbarVisibility();
 
-
-    DECLARE_NO_COPY_CLASS(wxWindowMac)
+    wxDECLARE_NO_COPY_CLASS(wxWindowMac);
     DECLARE_EVENT_TABLE()
 };