[wxWidgets.git] / include / wx / mac / classic / window.h

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/mac/carbon/window.h
// Purpose:     wxWindowMac class
// Author:      Stefan Csomor
// Modified by:
// Created:     1998-01-01
// RCS-ID:      $Id$
// Copyright:   (c) Stefan Csomor
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_WINDOW_H_
#define _WX_WINDOW_H_

#include "wx/brush.h"

// ---------------------------------------------------------------------------
// forward declarations
// ---------------------------------------------------------------------------

class WXDLLEXPORT wxButton;
class WXDLLEXPORT wxScrollBar;
class WXDLLEXPORT wxTopLevelWindowMac;

// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------

class WXDLLEXPORT wxWindowMac: public wxWindowBase
{
    DECLARE_DYNAMIC_CLASS(wxWindowMac)

    friend class wxDC;
    friend class wxPaintDC;

public:

    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 ~wxWindowMac();

    bool Create(wxWindowMac *parent,
                wxWindowID id,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,
                const wxString& name = wxPanelNameStr);


    // implement base class pure virtuals
    virtual void SetLabel( const wxString& title);
    virtual wxString GetLabel() const;

    virtual void Raise();
    virtual void Lower();

    virtual bool Show( bool show = true );
    virtual bool Enable( bool enable = true );

    virtual void SetFocus();

    virtual void WarpPointer(int x, int y);

    virtual void Refresh( bool eraseBackground = true,
                          const wxRect *rect = (const wxRect *) NULL );

    virtual bool SetCursor( const wxCursor &cursor );
    virtual bool SetFont(const wxFont& font)
           { return wxWindowBase::SetFont(font); }
    virtual int GetCharHeight() const;
    virtual int GetCharWidth() const;
    virtual void GetTextExtent(const wxString& string,
                               int *x, int *y,
                               int *descent = (int *) NULL,
                               int *externalLeading = (int *) NULL,
                               const wxFont *theFont = (const wxFont *) NULL)
                               const;

    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 SetScrollPos( int orient, int pos, bool refresh = true );
    virtual int GetScrollPos( int orient ) const;
    virtual int GetScrollThumb( int orient ) const;
    virtual int GetScrollRange( int orient ) const;
    virtual void ScrollWindow( int dx, int dy,
                               const wxRect* rect = (wxRect *) NULL );

#if wxUSE_DRAG_AND_DROP
    virtual void SetDropTarget( wxDropTarget *dropTarget );
#endif // wxUSE_DRAG_AND_DROP

    // Accept files for dragging
    virtual void DragAcceptFiles(bool accept);

    // Native resource loading (implemented in src/msw/nativdlg.cpp)
    // FIXME: should they really be all virtual?
    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 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 ; }

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

    wxWindowMac *FindItem(long id) const;
    wxWindowMac *FindItemByHWND(WXHWND hWnd, bool controlOnly = false) const;

    // Make a Windows extended style from the given wxWidgets window style
    static WXDWORD MakeExtendedStyle(long style,
                                     bool eliminateBorders = true);
    // Determine whether 3D effects are wanted
    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; };

    // Setup background and foreground colours correctly
    virtual void SetupColours();

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:
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() ;

    bool                 m_backgroundTransparent ;

    // 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 DoSetSize(int x, int y,
                           int width, int height,
                           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
    // 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

private:
    // common part of all ctors
    void Init();

    DECLARE_NO_COPY_CLASS(wxWindowMac)
    DECLARE_EVENT_TABLE()
};

#endif
    // _WX_WINDOW_H_
Commit	Line	Data
52479aef	1	/////////////////////////////////////////////////////////////////////////////
fb5246be	2	// Name: wx/mac/carbon/window.h
52479aef SC	3	// Purpose: wxWindowMac class
	4	// Author: Stefan Csomor
	5	// Modified by:
	6	// Created: 1998-01-01
	7	// RCS-ID: $Id$
	8	// Copyright: (c) Stefan Csomor
65571936	9	// Licence: wxWindows licence
52479aef SC	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef _WX_WINDOW_H_
	13	#define _WX_WINDOW_H_
	14
52479aef SC	15	#include "wx/brush.h"
	16
	17	// ---------------------------------------------------------------------------
	18	// forward declarations
	19	// ---------------------------------------------------------------------------
	20
	21	class WXDLLEXPORT wxButton;
	22	class WXDLLEXPORT wxScrollBar;
	23	class WXDLLEXPORT wxTopLevelWindowMac;
	24
	25	// ---------------------------------------------------------------------------
	26	// constants
	27	// ---------------------------------------------------------------------------
	28
	29	class WXDLLEXPORT wxWindowMac: public wxWindowBase
	30	{
	31	DECLARE_DYNAMIC_CLASS(wxWindowMac)
fb5246be	32
52479aef SC	33	friend class wxDC;
52479aef SC	34	friend class wxPaintDC;
fb5246be	35
52479aef	36	public:
fb5246be	37
52479aef SC	38	wxWindowMac()
	39	: m_macBackgroundBrush()
	40	, m_macVisibleRegion()
	41	, m_x(0), m_y(0), m_width(0), m_height(0)
	42	, m_hScrollBar(NULL), m_vScrollBar(NULL)
	43	, m_label(wxEmptyString)
	44	{ Init(); }
	45
	46	wxWindowMac(wxWindowMac *parent,
	47	wxWindowID id,
	48	const wxPoint& pos = wxDefaultPosition,
	49	const wxSize& size = wxDefaultSize,
	50	long style = 0,
	51	const wxString& name = wxPanelNameStr)
	52	{
	53	Init();
	54	Create(parent, id, pos, size, style, name);
	55	}
	56
	57	virtual ~wxWindowMac();
	58
	59	bool Create(wxWindowMac *parent,
	60	wxWindowID id,
	61	const wxPoint& pos = wxDefaultPosition,
	62	const wxSize& size = wxDefaultSize,
	63	long style = 0,
	64	const wxString& name = wxPanelNameStr);
	65
	66
	67	// implement base class pure virtuals
fb5246be WS	68	virtual void SetLabel( const wxString& title);
fb5246be WS	69	virtual wxString GetLabel() const;
52479aef SC	70
	71	virtual void Raise();
	72	virtual void Lower();
	73
fb5246be WS	74	virtual bool Show( bool show = true );
fb5246be WS	75	virtual bool Enable( bool enable = true );
52479aef SC	76
	77	virtual void SetFocus();
	78
	79	virtual void WarpPointer(int x, int y);
	80
fb5246be	81	virtual void Refresh( bool eraseBackground = true,
52479aef SC	82	const wxRect rect = (const wxRect ) NULL );
	83
	84	virtual bool SetCursor( const wxCursor &cursor );
	85	virtual bool SetFont(const wxFont& font)
	86	{ return wxWindowBase::SetFont(font); }
	87	virtual int GetCharHeight() const;
	88	virtual int GetCharWidth() const;
	89	virtual void GetTextExtent(const wxString& string,
	90	int x, int y,
	91	int descent = (int ) NULL,
	92	int externalLeading = (int ) NULL,
	93	const wxFont theFont = (const wxFont ) NULL)
	94	const;
	95
	96	virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
	97
	98	virtual void SetScrollbar( int orient, int pos, int thumbVisible,
fb5246be WS	99	int range, bool refresh = true );
fb5246be WS	100	virtual void SetScrollPos( int orient, int pos, bool refresh = true );
52479aef SC	101	virtual int GetScrollPos( int orient ) const;
	102	virtual int GetScrollThumb( int orient ) const;
	103	virtual int GetScrollRange( int orient ) const;
	104	virtual void ScrollWindow( int dx, int dy,
	105	const wxRect* rect = (wxRect *) NULL );
	106
	107	#if wxUSE_DRAG_AND_DROP
	108	virtual void SetDropTarget( wxDropTarget *dropTarget );
	109	#endif // wxUSE_DRAG_AND_DROP
	110
	111	// Accept files for dragging
	112	virtual void DragAcceptFiles(bool accept);
	113
	114	// Native resource loading (implemented in src/msw/nativdlg.cpp)
	115	// FIXME: should they really be all virtual?
	116	wxWindowMac* GetWindowChild1(wxWindowID id);
	117	wxWindowMac* GetWindowChild(wxWindowID id);
	118
	119	// implementation from now on
	120	// --------------------------
	121
	122	void MacClientToRootWindow( int x , int y ) const ;
	123	void MacRootWindowToClient( int x , int y ) const ;
	124	void MacWindowToRootWindow( int x , int y ) const ;
	125	void MacRootWindowToWindow( int x , int y ) const ;
fb5246be	126
52479aef SC	127	virtual wxString MacGetToolTipString( wxPoint &where ) ;
	128
	129	// simple accessors
	130	// ----------------
	131
	132	// WXHWND GetHWND() const { return m_hWnd; }
	133	// void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
	134	virtual WXWidget GetHandle() const { return (WXWidget) NULL ; }
	135
	136	bool GetTransparentBackground() const { return m_backgroundTransparent; }
fb5246be	137	void SetTransparent(bool t = true) { m_backgroundTransparent = t; }
52479aef SC	138
	139	// event handlers
	140	// --------------
	141	void OnSetFocus(wxFocusEvent& event) ;
	142	void OnNcPaint(wxNcPaintEvent& event);
	143	void OnEraseBackground(wxEraseEvent& event);
	144	void OnMouseEvent( wxMouseEvent &event ) ;
	145
	146	void MacOnScroll(wxScrollEvent&event ) ;
fb5246be	147
52479aef SC	148	bool AcceptsFocus() const ;
	149
	150	public:
	151	void OnInternalIdle();
	152
	153	// For implementation purposes - sometimes decorations make the client area
	154	// smaller
	155	virtual wxPoint GetClientAreaOrigin() const;
	156
	157	wxWindowMac *FindItem(long id) const;
fb5246be	158	wxWindowMac *FindItemByHWND(WXHWND hWnd, bool controlOnly = false) const;
52479aef	159
77ffb593	160	// Make a Windows extended style from the given wxWidgets window style
52479aef	161	static WXDWORD MakeExtendedStyle(long style,
fb5246be	162	bool eliminateBorders = true);
52479aef SC	163	// Determine whether 3D effects are wanted
	164	WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D) const;
	165
fb5246be WS	166	// MSW only: true if this control is part of the main control
fb5246be WS	167	virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return false; };
52479aef SC	168
	169	// Setup background and foreground colours correctly
	170	virtual void SetupColours();
	171
	172	public:
	173	static bool MacGetWindowFromPoint( const wxPoint &point , wxWindowMac** outWin ) ;
	174	virtual bool MacGetWindowFromPointSub( const wxPoint &point , wxWindowMac** outWin ) ;
	175	virtual void MacRedraw( WXHRGN updatergn , long time , bool erase) ;
	176	virtual bool MacCanFocus() const { return true ; }
fb5246be	177
52479aef SC	178	virtual bool MacDispatchMouseEvent(wxMouseEvent& event ) ;
	179	// this should not be overriden in classes above wxWindowMac because it is called from its destructor via DeleteChildren
	180	virtual void RemoveChild( wxWindowBase *child );
	181	virtual void MacPaintBorders( int left , int top ) ;
	182	WXWindow MacGetRootWindow() const ;
	183	wxTopLevelWindowMac* MacGetTopLevelWindow() const ;
fb5246be	184
52479aef	185	virtual WXWidget MacGetContainerForEmbedding() ;
fb5246be	186
52479aef SC	187	virtual long MacGetLeftBorderSize() const ;
	188	virtual long MacGetRightBorderSize() const ;
	189	virtual long MacGetTopBorderSize() const ;
	190	virtual long MacGetBottomBorderSize() const ;
fb5246be	191
52479aef SC	192	static long MacRemoveBordersFromStyle( long style ) ;
	193	virtual void MacSuperChangedPosition() ;
	194	// the absolute coordinates of this item within the toplevel window may have changed
	195	virtual void MacUpdateDimensions() {}
	196	// the absolute coortinates of this window's root have changed
	197	virtual void MacTopLevelWindowChangedPosition() ;
	198	virtual void MacSuperShown( bool show ) ;
	199	virtual void MacSuperEnabled( bool enable ) ;
	200	bool MacIsReallyShown() const ;
	201	virtual void Update() ;
	202	// for compatibility
	203	void MacUpdateImmediately() { Update() ; }
	204	virtual bool MacSetupCursor( const wxPoint& pt ) ;
fb5246be	205
52479aef SC	206	// virtual bool MacSetPortDrawingParams( const Point & localOrigin, const Rect & clipRect, WindowRef window , wxWindowMac* rootwin ) ;
	207	// virtual void MacGetPortParams(Point* localOrigin, Rect* clipRect, WindowRef window , wxWindowMac* rootwin ) ;
	208	// virtual void MacGetPortClientParams(Point* localOrigin, Rect* clipRect, WindowRef window , wxWindowMac* rootwin) ;
	209	const wxBrush& MacGetBackgroundBrush() ;
	210	const wxRegion& MacGetVisibleRegion( bool respectChildrenAndSiblings = true ) ;
	211	bool MacIsWindowScrollbar( const wxScrollBar* sb )
	212	{ return (m_hScrollBar == sb \|\| m_vScrollBar == sb) ; }
	213	static wxWindowMac* s_lastMouseWindow ;
	214	private:
	215	protected:
	216	wxBrush m_macBackgroundBrush ;
	217	wxRegion m_macVisibleRegion ;
	218	int m_x ;
	219	int m_y ;
	220	int m_width ;
	221	int m_height ;
fb5246be	222
52479aef SC	223	wxScrollBar* m_hScrollBar ;
	224	wxScrollBar* m_vScrollBar ;
	225	wxString m_label ;
fb5246be	226
52479aef SC	227	void MacCreateScrollBars( long style ) ;
	228	void MacRepositionScrollBars() ;
	229
	230	bool m_backgroundTransparent ;
	231
	232	// implement the base class pure virtuals
	233	virtual void DoClientToScreen( int x, int y ) const;
	234	virtual void DoScreenToClient( int x, int y ) const;
	235	virtual void DoGetPosition( int x, int y ) const;
	236	virtual void DoGetSize( int width, int height ) const;
	237	virtual void DoGetClientSize( int width, int height ) const;
	238	virtual void DoSetSize(int x, int y,
	239	int width, int height,
	240	int sizeFlags = wxSIZE_AUTO);
	241	virtual void DoSetClientSize(int width, int height);
	242
	243	virtual void DoCaptureMouse();
	244	virtual void DoReleaseMouse();
	245
	246	// move the window to the specified location and resize it: this is called
	247	// from both DoSetSize() and DoSetClientSize() and would usually just call
	248	// ::MoveWindow() except for composite controls which will want to arrange
	249	// themselves inside the given rectangle
	250	virtual void DoMoveWindow(int x, int y, int width, int height);
	251
	252	#if wxUSE_TOOLTIPS
	253	virtual void DoSetToolTip( wxToolTip *tip );
	254	#endif // wxUSE_TOOLTIPS
	255
	256	private:
	257	// common part of all ctors
	258	void Init();
	259
	260	DECLARE_NO_COPY_CLASS(wxWindowMac)
	261	DECLARE_EVENT_TABLE()
	262	};
	263
	264	#endif
	265	// _WX_WINDOW_H_