[wxWidgets.git] / include / wx / renderer.h

///////////////////////////////////////////////////////////////////////////////
// Name:        wx/renderer.h
// Purpose:     wxRendererNative class declaration
// Author:      Vadim Zeitlin
// Modified by:
// Created:     20.07.2003
// RCS-ID:      $Id$
// Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
// Licence:     wxWindows licence
///////////////////////////////////////////////////////////////////////////////

/*
   Renderers are used in wxWindows for two similar but different things:
    (a) wxUniversal uses them to draw everything, i.e. all the control
    (b) all the native ports use them to draw generic controls only

   wxUniversal needs more functionality than what is included in the base class
   as it needs to draw stuff like scrollbars which are never going to be
   generic. So we put the bare minimum needed by the native ports here and the
   full wxRenderer class is declared in wx/univ/renderer.h and is only used by
   wxUniveral (although note that native ports can load wxRenderer objects from
   theme DLLs and use them as wxRendererNative ones, of course).
 */

#ifndef _WX_RENDERER_H_
#define _WX_RENDERER_H_

class WXDLLEXPORT wxDC;
class WXDLLEXPORT wxWindow;

#include "wx/gdicmn.h" // for wxPoint

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

// control state flags used in wxRenderer and wxColourScheme
enum
{
    wxCONTROL_DISABLED   = 0x00000001,  // control is disabled
    wxCONTROL_FOCUSED    = 0x00000002,  // currently has keyboard focus
    wxCONTROL_PRESSED    = 0x00000004,  // (button) is pressed
    wxCONTROL_ISDEFAULT  = 0x00000008,  // only applies to the buttons
    wxCONTROL_ISSUBMENU  = wxCONTROL_ISDEFAULT, // only for menu items
    wxCONTROL_EXPANDED   = wxCONTROL_ISDEFAULT, // only for the tree items
    wxCONTROL_CURRENT    = 0x00000010,  // mouse is currently over the control
    wxCONTROL_SELECTED   = 0x00000020,  // selected item in e.g. listbox
    wxCONTROL_CHECKED    = 0x00000040,  // (check/radio button) is checked
    wxCONTROL_CHECKABLE  = 0x00000080,  // (menu) item can be checked

    wxCONTROL_FLAGS_MASK = 0x000000ff,

    // this is a pseudo flag not used directly by wxRenderer but rather by some
    // controls internally
    wxCONTROL_DIRTY      = 0x80000000
};

// ----------------------------------------------------------------------------
// wxRendererNative: abstracts drawing methods needed by the native controls
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxRendererNative
{
public:
    virtual ~wxRendererNative() { } // stop GCC warning

    // drawing functions
    // -----------------

    // draw the header control button (used by wxListCtrl)
    virtual void DrawHeaderButton(wxWindow *win,
                                  wxDC& dc,
                                  const wxRect& rect,
                                  int flags = 0) = 0;

    // draw the expanded/collapsed icon for a tree control item
    virtual void DrawTreeItemButton(wxWindow *win,
                                    wxDC& dc,
                                    const wxRect& rect,
                                    int flags = 0) = 0;

    // draw the border for sash window: this border must be such that the sash
    // drawn by DrawSash() blends into it well
    virtual void DrawSplitterBorder(wxWindow *win,
                                    wxDC& dc,
                                    const wxRect& rect) = 0;

    // draw a (vertical) sash
    virtual void DrawSplitterSash(wxWindow *win,
                                  wxDC& dc,
                                  const wxSize& size,
                                  wxCoord position) = 0;


    // geometry functions
    // ------------------

    // get the splitter parameters: the x field of the returned point is the
    // sash width and the y field is the border width
    virtual wxPoint GetSplitterSashAndBorder(const wxWindow *win) = 0;


    // pseudo constructors
    // -------------------

    // return the currently used renderer
    static wxRendererNative& Get();

    // return the generic implementation of the renderer
    static wxRendererNative& GetGeneric();
};

// ----------------------------------------------------------------------------
// wxDelegateRendererNative: allows reuse of renderers code
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxDelegateRendererNative : public wxRendererNative
{
public:
    wxDelegateRendererNative()
        : m_rendererNative(GetGeneric()) { }

    wxDelegateRendererNative(wxRendererNative& rendererNative)
        : m_rendererNative(rendererNative) { }


    virtual void DrawHeaderButton(wxWindow *win,
                                  wxDC& dc,
                                  const wxRect& rect,
                                  int flags = 0)
        { m_rendererNative.DrawHeaderButton(win, dc, rect, flags); }

    virtual void DrawTreeItemButton(wxWindow *win,
                                    wxDC& dc,
                                    const wxRect& rect,
                                    int flags = 0)
        { m_rendererNative.DrawTreeItemButton(win, dc, rect, flags); }

    virtual void DrawSplitterBorder(wxWindow *win,
                                    wxDC& dc,
                                    const wxRect& rect)
        { m_rendererNative.DrawSplitterBorder(win, dc, rect); }

    virtual void DrawSplitterSash(wxWindow *win,
                                  wxDC& dc,
                                  const wxSize& size,
                                  wxCoord position)
        { m_rendererNative.DrawSplitterSash(win, dc, size, position); }


    virtual wxPoint GetSplitterSashAndBorder(const wxWindow *win)
        { return m_rendererNative.GetSplitterSashAndBorder(win); }

protected:
    wxRendererNative& m_rendererNative;

    DECLARE_NO_COPY_CLASS(wxDelegateRendererNative)
};

#endif // _WX_RENDERER_H_
Commit	Line	Data
9c7f49f5 VZ	1	///////////////////////////////////////////////////////////////////////////////
	2	// Name: wx/renderer.h
	3	// Purpose: wxRendererNative class declaration
	4	// Author: Vadim Zeitlin
	5	// Modified by:
	6	// Created: 20.07.2003
	7	// RCS-ID: $Id$
	8	// Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
	9	// Licence: wxWindows licence
	10	///////////////////////////////////////////////////////////////////////////////
	11
	12	/*
	13	Renderers are used in wxWindows for two similar but different things:
	14	(a) wxUniversal uses them to draw everything, i.e. all the control
	15	(b) all the native ports use them to draw generic controls only
	16
	17	wxUniversal needs more functionality than what is included in the base class
	18	as it needs to draw stuff like scrollbars which are never going to be
	19	generic. So we put the bare minimum needed by the native ports here and the
	20	full wxRenderer class is declared in wx/univ/renderer.h and is only used by
	21	wxUniveral (although note that native ports can load wxRenderer objects from
	22	theme DLLs and use them as wxRendererNative ones, of course).
	23	*/
	24
	25	#ifndef _WX_RENDERER_H_
	26	#define _WX_RENDERER_H_
	27
38c4cb6a	28	class WXDLLEXPORT wxDC;
38c4cb6a VZ	29	class WXDLLEXPORT wxWindow;
38c4cb6a VZ	30
7df07b10 MB	31	#include "wx/gdicmn.h" // for wxPoint
7df07b10 MB	32
9c7f49f5 VZ	33	// ----------------------------------------------------------------------------
	34	// constants
	35	// ----------------------------------------------------------------------------
	36
	37	// control state flags used in wxRenderer and wxColourScheme
	38	enum
	39	{
	40	wxCONTROL_DISABLED = 0x00000001, // control is disabled
	41	wxCONTROL_FOCUSED = 0x00000002, // currently has keyboard focus
	42	wxCONTROL_PRESSED = 0x00000004, // (button) is pressed
	43	wxCONTROL_ISDEFAULT = 0x00000008, // only applies to the buttons
	44	wxCONTROL_ISSUBMENU = wxCONTROL_ISDEFAULT, // only for menu items
	45	wxCONTROL_EXPANDED = wxCONTROL_ISDEFAULT, // only for the tree items
	46	wxCONTROL_CURRENT = 0x00000010, // mouse is currently over the control
	47	wxCONTROL_SELECTED = 0x00000020, // selected item in e.g. listbox
	48	wxCONTROL_CHECKED = 0x00000040, // (check/radio button) is checked
	49	wxCONTROL_CHECKABLE = 0x00000080, // (menu) item can be checked
	50
	51	wxCONTROL_FLAGS_MASK = 0x000000ff,
	52
	53	// this is a pseudo flag not used directly by wxRenderer but rather by some
	54	// controls internally
	55	wxCONTROL_DIRTY = 0x80000000
	56	};
	57
	58	// ----------------------------------------------------------------------------
	59	// wxRendererNative: abstracts drawing methods needed by the native controls
	60	// ----------------------------------------------------------------------------
	61
	62	class WXDLLEXPORT wxRendererNative
	63	{
	64	public:
7df07b10 MB	65	virtual ~wxRendererNative() { } // stop GCC warning
7df07b10 MB	66
9c7f49f5 VZ	67	// drawing functions
	68	// -----------------
	69
	70	// draw the header control button (used by wxListCtrl)
	71	virtual void DrawHeaderButton(wxWindow *win,
	72	wxDC& dc,
	73	const wxRect& rect,
	74	int flags = 0) = 0;
	75
	76	// draw the expanded/collapsed icon for a tree control item
	77	virtual void DrawTreeItemButton(wxWindow *win,
	78	wxDC& dc,
	79	const wxRect& rect,
	80	int flags = 0) = 0;
	81
b3208e11 VZ	82	// draw the border for sash window: this border must be such that the sash
	83	// drawn by DrawSash() blends into it well
	84	virtual void DrawSplitterBorder(wxWindow *win,
	85	wxDC& dc,
	86	const wxRect& rect) = 0;
	87
	88	// draw a (vertical) sash
	89	virtual void DrawSplitterSash(wxWindow *win,
	90	wxDC& dc,
	91	const wxSize& size,
	92	wxCoord position) = 0;
	93
	94
	95	// geometry functions
	96	// ------------------
	97
	98	// get the splitter parameters: the x field of the returned point is the
	99	// sash width and the y field is the border width
	100	virtual wxPoint GetSplitterSashAndBorder(const wxWindow *win) = 0;
	101
9c7f49f5 VZ	102
	103	// pseudo constructors
	104	// -------------------
	105
	106	// return the currently used renderer
	107	static wxRendererNative& Get();
	108
	109	// return the generic implementation of the renderer
	110	static wxRendererNative& GetGeneric();
	111	};
	112
	113	// ----------------------------------------------------------------------------
	114	// wxDelegateRendererNative: allows reuse of renderers code
	115	// ----------------------------------------------------------------------------
	116
	117	class WXDLLEXPORT wxDelegateRendererNative : public wxRendererNative
	118	{
	119	public:
	120	wxDelegateRendererNative()
	121	: m_rendererNative(GetGeneric()) { }
	122
	123	wxDelegateRendererNative(wxRendererNative& rendererNative)
	124	: m_rendererNative(rendererNative) { }
	125
	126
	127	virtual void DrawHeaderButton(wxWindow *win,
	128	wxDC& dc,
	129	const wxRect& rect,
	130	int flags = 0)
	131	{ m_rendererNative.DrawHeaderButton(win, dc, rect, flags); }
b3208e11	132
9c7f49f5 VZ	133	virtual void DrawTreeItemButton(wxWindow *win,
	134	wxDC& dc,
	135	const wxRect& rect,
	136	int flags = 0)
	137	{ m_rendererNative.DrawTreeItemButton(win, dc, rect, flags); }
	138
b3208e11 VZ	139	virtual void DrawSplitterBorder(wxWindow *win,
	140	wxDC& dc,
	141	const wxRect& rect)
	142	{ m_rendererNative.DrawSplitterBorder(win, dc, rect); }
	143
	144	virtual void DrawSplitterSash(wxWindow *win,
	145	wxDC& dc,
	146	const wxSize& size,
	147	wxCoord position)
	148	{ m_rendererNative.DrawSplitterSash(win, dc, size, position); }
	149
	150
	151	virtual wxPoint GetSplitterSashAndBorder(const wxWindow *win)
	152	{ return m_rendererNative.GetSplitterSashAndBorder(win); }
	153
9c7f49f5 VZ	154	protected:
9c7f49f5 VZ	155	wxRendererNative& m_rendererNative;
fc7a2a60 VZ	156
fc7a2a60 VZ	157	DECLARE_NO_COPY_CLASS(wxDelegateRendererNative)
9c7f49f5 VZ	158	};
	159
	160	#endif // _WX_RENDERER_H_
	161