include/wx/cocoa/window.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/cocoa/window.h
   3 // Purpose:     wxWindowCocoa
   4 // Author:      David Elliott
   5 // Modified by:
   6 // Created:     2002/12/26
   7 // RCS-ID:      $Id:
   8 // Copyright:   (c) 2002 David Elliott
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef __WX_COCOA_WINDOW_H__
  13 #define __WX_COCOA_WINDOW_H__
  14
  15 #include "wx/cocoa/NSView.h"
  16
  17 #ifdef __OBJC__
  18     #import <Foundation/NSGeometry.h>
  19 #endif //def __OBJC__
  20
  21 class wxWindowCocoaHider;
  22 class wxWindowCocoaScroller;
  23
  24 // ========================================================================
  25 // wxWindowCocoa
  26 // ========================================================================
  27 class WXDLLEXPORT wxWindowCocoa: public wxWindowBase, protected wxCocoaNSView
  28 {
  29     DECLARE_DYNAMIC_CLASS(wxWindowCocoa)
  30     DECLARE_NO_COPY_CLASS(wxWindowCocoa)
  31     DECLARE_EVENT_TABLE()
  32     friend wxWindow *wxWindowBase::GetCapture();
  33     friend class wxWindowCocoaScroller;
  34 // ------------------------------------------------------------------------
  35 // initialization
  36 // ------------------------------------------------------------------------
  37 public:
  38     wxWindowCocoa() { Init(); }
  39     inline wxWindowCocoa(wxWindow *parent, wxWindowID winid,
  40             const wxPoint& pos = wxDefaultPosition,
  41             const wxSize& size = wxDefaultSize,
  42             long style = 0,
  43             const wxString& name = wxPanelNameStr)
  44     {
  45         Init();
  46         Create(parent, winid, pos, size, style, name);
  47     }
  48
  49     virtual ~wxWindowCocoa();
  50
  51     bool Create(wxWindow *parent, wxWindowID winid,
  52             const wxPoint& pos = wxDefaultPosition,
  53             const wxSize& size = wxDefaultSize,
  54             long style = 0,
  55             const wxString& name = wxPanelNameStr);
  56 protected:
  57     void Init();
  58 // ------------------------------------------------------------------------
  59 // Cocoa specifics
  60 // ------------------------------------------------------------------------
  61 public:
  62     // Returns the content NSView (where children are added, drawing performed)
  63     inline WX_NSView GetNSView() { return m_cocoaNSView; }
  64     // Returns the NSView suitable for use as a subview
  65     WX_NSView GetNSViewForSuperview() const;
  66     // Returns the NSView that may be hidden/is being hidden
  67     WX_NSView GetNSViewForHiding() const;
  68     // Returns the NSView for non-client drawing
  69     virtual WX_NSView GetNonClientNSView() { return GetNSViewForSuperview(); }
  70     // Add/remove children
  71     void CocoaAddChild(wxWindowCocoa *child);
  72     void CocoaRemoveFromParent(void);
  73 protected:
  74     // enable==false: disables the control
  75     // enable==true: enables the control IF it should be enabled
  76     bool EnableSelfAndChildren(bool enable);
  77     // actually enable/disable the cocoa control, overridden by subclasses
  78     virtual void CocoaSetEnabled(bool enable) { }
  79     // Reflects the state for THIS window (ignoring disables by parents)
  80     bool m_shouldBeEnabled;
  81
  82     void CocoaCreateNSScrollView();
  83     void InitMouseEvent(wxMouseEvent &event, WX_NSEvent cocoaEvent);
  84     virtual void Cocoa_FrameChanged(void);
  85     virtual bool Cocoa_drawRect(const NSRect &rect);
  86     virtual bool Cocoa_mouseDown(WX_NSEvent theEvent);
  87     virtual bool Cocoa_mouseDragged(WX_NSEvent theEvent);
  88     virtual bool Cocoa_mouseUp(WX_NSEvent theEvent);
  89     virtual bool Cocoa_mouseMoved(WX_NSEvent theEvent);
  90     virtual bool Cocoa_mouseEntered(WX_NSEvent theEvent);
  91     virtual bool Cocoa_mouseExited(WX_NSEvent theEvent);
  92     virtual bool Cocoa_rightMouseDown(WX_NSEvent theEvent);
  93     virtual bool Cocoa_rightMouseDragged(WX_NSEvent theEvent);
  94     virtual bool Cocoa_rightMouseUp(WX_NSEvent theEvent);
  95     virtual bool Cocoa_otherMouseDown(WX_NSEvent theEvent);
  96     virtual bool Cocoa_otherMouseDragged(WX_NSEvent theEvent);
  97     virtual bool Cocoa_otherMouseUp(WX_NSEvent theEvent);
  98     virtual bool Cocoa_resetCursorRects();
  99     void SetNSView(WX_NSView cocoaNSView);
 100     WX_NSView m_cocoaNSView;
 101     wxWindowCocoaHider *m_cocoaHider;
 102     wxWindowCocoaScroller *m_cocoaScroller;
 103     bool m_isInPaint;
 104     static wxWindow *sm_capturedWindow;
 105     virtual void CocoaReplaceView(WX_NSView oldView, WX_NSView newView);
 106     void SetInitialFrameRect(const wxPoint& pos, const wxSize& size);
 107 #ifdef __OBJC__
 108     inline NSRect MakeDefaultNSRect(const wxSize& size)
 109     {
 110         // NOTE: position is 10,10 to make it "obvious" that it's out of place
 111         return NSMakeRect(10.0,10.0,WidthDefault(size.x),HeightDefault(size.y));
 112     }
 113 #endif //def __OBJC__
 114 // ------------------------------------------------------------------------
 115 // Implementation
 116 // ------------------------------------------------------------------------
 117 public:
 118     /* Pure Virtuals */
 119     // Raise the window to the top of the Z order
 120     virtual void Raise();
 121     // Lower the window to the bottom of the Z order
 122     virtual void Lower();
 123     // Set the focus to this window
 124     virtual void SetFocus();
 125     // Warp the pointer the given position
 126     virtual void WarpPointer(int x_pos, int y_pos) ;
 127     // Send the window a refresh event
 128     virtual void Refresh(bool eraseBack = TRUE, const wxRect *rect = NULL);
 129     // Set/get the window's font
 130     virtual bool SetFont(const wxFont& f);
 131 //    inline virtual wxFont& GetFont() const;
 132     // Get character size
 133     virtual int GetCharHeight() const;
 134     virtual int GetCharWidth() const;
 135     virtual void GetTextExtent(const wxString& string, int *x, int *y,
 136                              int *descent = NULL,
 137                              int *externalLeading = NULL,
 138                              const wxFont *theFont = NULL) const;
 139     // Scroll stuff
 140     virtual void SetScrollbar(int orient, int pos, int thumbVisible,
 141       int range, bool refresh = TRUE);
 142     virtual void SetScrollPos(int orient, int pos, bool refresh = TRUE);
 143     virtual int GetScrollPos(int orient) const;
 144     virtual int GetScrollThumb(int orient) const;
 145     virtual int GetScrollRange(int orient) const;
 146     virtual void ScrollWindow(int dx, int dy, const wxRect *rect = NULL);
 147     virtual void DoSetVirtualSize(int x, int y);
 148     // Get the private handle (platform-dependent)
 149     virtual WXWidget GetHandle() const;
 150     // Convert client to screen coordinates
 151     virtual void DoClientToScreen(int *x, int *y) const;
 152     // Convert screen to client coordinates
 153     virtual void DoScreenToClient(int *x, int *y) const;
 154     // Capture/release mouse
 155     virtual void DoCaptureMouse();
 156     virtual void DoReleaseMouse();
 157     // Get window position, relative to parent (or screen if no parent)
 158     virtual void DoGetPosition(int *x, int *y) const;
 159     // Get overall window size
 160     virtual void DoGetSize(int *width, int *height) const;
 161     // Get/set client (application-useable) size
 162     virtual void DoGetClientSize(int *width, int *height) const;
 163     virtual void DoSetClientSize(int width, int size);
 164     // Set this window's tooltip
 165     virtual void DoSetToolTip( wxToolTip *tip );
 166     // Set the size of the wxWindow (the contentView of an NSWindow)
 167     // wxTopLevelWindow will override this and set the NSWindow size
 168     // such that the contentView will be this size
 169     virtual void CocoaSetWxWindowSize(int width, int height);
 170     // Set overall size and position
 171     virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
 172     virtual void DoMoveWindow(int x, int y, int width, int height);
 173     // Popup a menu
 174     virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
 175
 176     /* Other implementation */
 177
 178     // NOTE: typically Close() is not virtual, but we want this for Cocoa
 179     virtual bool Close( bool force = false );
 180     virtual bool Show( bool show = true );
 181     virtual bool Enable( bool enable = true );
 182 };
 183
 184 #endif // __WX_COCOA_WINDOW_H__