[wxWidgets.git] / include / wx / univ / stdrend.h

///////////////////////////////////////////////////////////////////////////////
// Name:        wx/univ/stdrend.h
// Purpose:     wxStdRenderer class declaration
// Author:      Vadim Zeitlin
// Created:     2006-09-18
// RCS-ID:      $Id$
// Copyright:   (c) 2006 Vadim Zeitlin <vadim@wxwindows.org>
// Licence:     wxWindows licence
///////////////////////////////////////////////////////////////////////////////

#ifndef _WX_UNIV_STDREND_H_
#define _WX_UNIV_STDREND_H_

#include "wx/univ/renderer.h"
#include "wx/pen.h"

class WXDLLEXPORT wxColourScheme;

// ----------------------------------------------------------------------------
// wxStdRenderer: implements as much of wxRenderer API as possible generically
// ----------------------------------------------------------------------------

class wxStdRenderer : public wxRenderer
{
public:
    // the renderer will use the given scheme, whose lifetime must be at least
    // as long as of this object itself, to choose the colours for drawing
    wxStdRenderer(const wxColourScheme *scheme);

    virtual void DrawBackground(wxDC& dc,
                                const wxColour& col,
                                const wxRect& rect,
                                int flags = 0,
                                wxWindow *window = NULL);
    virtual void DrawButtonSurface(wxDC& dc,
                                   const wxColour& col,
                                   const wxRect& rect,
                                   int flags);


    virtual void DrawFocusRect(wxDC& dc, const wxRect& rect);
    virtual void DrawLabel(wxDC& dc,
                           const wxString& label,
                           const wxRect& rect,
                           int flags = 0,
                           int alignment = wxALIGN_LEFT | wxALIGN_TOP,
                           int indexAccel = -1,
                           wxRect *rectBounds = NULL);
    virtual void DrawButtonLabel(wxDC& dc,
                                 const wxString& label,
                                 const wxBitmap& image,
                                 const wxRect& rect,
                                 int flags = 0,
                                 int alignment = wxALIGN_LEFT | wxALIGN_TOP,
                                 int indexAccel = -1,
                                 wxRect *rectBounds = NULL);


    virtual void DrawBorder(wxDC& dc,
                            wxBorder border,
                            const wxRect& rect,
                            int flags = 0,
                            wxRect *rectIn = NULL);
    virtual void DrawTextBorder(wxDC& dc,
                                wxBorder border,
                                const wxRect& rect,
                                int flags = 0,
                                wxRect *rectIn = NULL);

    virtual void DrawHorizontalLine(wxDC& dc,
                                    wxCoord y, wxCoord x1, wxCoord x2);
    virtual void DrawVerticalLine(wxDC& dc,
                                  wxCoord x, wxCoord y1, wxCoord y2);
    virtual void DrawFrame(wxDC& dc,
                           const wxString& label,
                           const wxRect& rect,
                           int flags = 0,
                           int alignment = wxALIGN_LEFT,
                           int indexAccel = -1);


    virtual void DrawItem(wxDC& dc,
                          const wxString& label,
                          const wxRect& rect,
                          int flags = 0);
    virtual void DrawCheckItem(wxDC& dc,
                               const wxString& label,
                               const wxBitmap& bitmap,
                               const wxRect& rect,
                               int flags = 0);

    virtual void DrawCheckButton(wxDC& dc,
                                 const wxString& label,
                                 const wxBitmap& bitmap,
                                 const wxRect& rect,
                                 int flags = 0,
                                 wxAlignment align = wxALIGN_LEFT,
                                 int indexAccel = -1);
    virtual void DrawRadioButton(wxDC& dc,
                                 const wxString& label,
                                 const wxBitmap& bitmap,
                                 const wxRect& rect,
                                 int flags = 0,
                                 wxAlignment align = wxALIGN_LEFT,
                                 int indexAccel = -1);

    virtual void DrawScrollbarArrow(wxDC& dc,
                                    wxDirection dir,
                                    const wxRect& rect,
                                    int flags = 0);
    virtual void DrawScrollCorner(wxDC& dc,
                                  const wxRect& rect);

#if wxUSE_TEXTCTRL
    virtual void DrawTextLine(wxDC& dc,
                              const wxString& text,
                              const wxRect& rect,
                              int selStart = -1,
                              int selEnd = -1,
                              int flags = 0);

    virtual void DrawLineWrapMark(wxDC& dc, const wxRect& rect);

    virtual wxRect GetTextTotalArea(const wxTextCtrl *text,
                                    const wxRect& rect) const;
    virtual wxRect GetTextClientArea(const wxTextCtrl *text,
                                     const wxRect& rect,
                                     wxCoord *extraSpaceBeyond) const;
#endif // wxUSE_TEXTCTRL

    virtual wxRect GetBorderDimensions(wxBorder border) const;

    virtual bool AreScrollbarsInsideBorder() const;

    virtual void AdjustSize(wxSize *size, const wxWindow *window);

    virtual wxCoord GetListboxItemHeight(wxCoord fontHeight);

#if wxUSE_SCROLLBAR
    virtual wxRect GetScrollbarRect(const wxScrollBar *scrollbar,
                                    wxScrollBar::Element elem,
                                    int thumbPos = -1) const;

    virtual wxCoord GetScrollbarSize(const wxScrollBar *scrollbar);

    virtual wxHitTest HitTestScrollbar(const wxScrollBar *scrollbar,
                                       const wxPoint& pt) const;

    virtual wxCoord ScrollbarToPixel(const wxScrollBar *scrollbar,
                                     int thumbPos = -1);
    virtual int PixelToScrollbar(const wxScrollBar *scrollbar, wxCoord coord);
#endif // wxUSE_SCROLLBAR

#if wxUSE_STATUSBAR
    virtual void DrawStatusField(wxDC& dc,
                                 const wxRect& rect,
                                 const wxString& label,
                                 int flags = 0, int style = 0);

    virtual wxSize GetStatusBarBorders(wxCoord *borderBetweenFields) const;
#endif // wxUSE_STATUSBAR

    virtual wxCoord GetCheckItemMargin() const { return 0; }

protected:
    // various constants
    enum ArrowDirection
    {
        Arrow_Left,
        Arrow_Right,
        Arrow_Up,
        Arrow_Down,
        Arrow_Max
    };

    enum ArrowStyle
    {
        Arrow_Normal,
        Arrow_Disabled,
        Arrow_Pressed,
        Arrow_Inverted,
        Arrow_InvertedDisabled,
        Arrow_StateMax
    };

    enum IndicatorType
    {
        IndicatorType_Check,
        IndicatorType_Radio,
        IndicatorType_MaxCtrl,
        IndicatorType_Menu = IndicatorType_MaxCtrl,
        IndicatorType_Max
    };

    enum IndicatorState
    {
        IndicatorState_Normal,
        IndicatorState_Pressed, // this one is for check/radioboxes
        IndicatorState_Disabled,
        IndicatorState_MaxCtrl,

        // the rest of the states are valid for menu items only
        IndicatorState_Selected = IndicatorState_Pressed,
        IndicatorState_SelectedDisabled = IndicatorState_MaxCtrl,
        IndicatorState_MaxMenu
    };

    enum IndicatorStatus
    {
        IndicatorStatus_Checked,
        IndicatorStatus_Unchecked,
        IndicatorStatus_Undetermined,
        IndicatorStatus_Max
    };

    // translate the appropriate bits in flags to the above enum elements
    static void GetIndicatorsFromFlags(int flags,
                                       IndicatorState& state,
                                       IndicatorStatus& status);

    // translate wxDirection to ArrowDirection
    static ArrowDirection GetArrowDirection(wxDirection dir);


    // fill the rectangle with a brush of given colour (must be valid)
    void DrawSolidRect(wxDC& dc, const wxColour& col, const wxRect& rect);


    // all the functions in this section adjust the rect parameter to
    // correspond to the interiour of the drawn area

        // draw complete rectangle
    void DrawRect(wxDC& dc, wxRect *rect, const wxPen& pen);

        // draw the rectange using the first pen for the left and top sides
        // and the second one for the bottom and right ones
    void DrawShadedRect(wxDC& dc, wxRect *rect,
                        const wxPen& pen1, const wxPen& pen2);

        // border drawing routines, may be overridden in the derived class
    virtual void DrawRaisedBorder(wxDC& dc, wxRect *rect);
    virtual void DrawSunkenBorder(wxDC& dc, wxRect *rect);
    virtual void DrawAntiSunkenBorder(wxDC& dc, wxRect *rect);
    virtual void DrawFrameBorder(wxDC& dc, wxRect *rect);


    // draw the frame with non-empty label inside the given rectText
    virtual void DrawFrameWithLabel(wxDC& dc,
                                    const wxString& label,
                                    const wxRect& rectFrame,
                                    const wxRect& rectText,
                                    int flags,
                                    int alignment,
                                    int indexAccel);

    // draw the (static box) frame without the part corresponding to rectLabel
    void DrawFrameWithoutLabel(wxDC& dc,
                               const wxRect& rectFrame,
                               const wxRect& rectLabel);


    // draw the bitmap for a check item (which is by default the same as check
    // box one but may be different)
    virtual void DrawCheckItemBitmap(wxDC& dc,
                                     const wxBitmap& bitmap,
                                     const wxRect& rect,
                                     int flags);

    // common routine for drawing check and radio buttons
    void DrawCheckOrRadioButton(wxDC& dc,
                                const wxString& label,
                                const wxBitmap& bitmap,
                                const wxRect& rect,
                                int flags,
                                wxAlignment align,
                                int indexAccel);

    // return the check/radio bitmap for the given flags
    virtual wxBitmap GetRadioBitmap(int flags) = 0;
    virtual wxBitmap GetCheckBitmap(int flags) = 0;

#if wxUSE_TEXTCTRL
    // return the width of the border around the text area in the text control
    virtual int GetTextBorderWidth(const wxTextCtrl *text) const;
#endif // wxUSE_TEXTCTRL

    // return the starting and ending positions, in pixels, of the thumb of a
    // scrollbar with the given logical position, thumb size and range and the
    // given physical length
    static void GetScrollBarThumbSize(wxCoord length,
                                      int thumbPos,
                                      int thumbSize,
                                      int range,
                                      wxCoord *thumbStart,
                                      wxCoord *thumbEnd);

    // GDI objects we often use
    wxPen m_penBlack,
          m_penDarkGrey,
          m_penLightGrey,
          m_penHighlight;

    // the colours we use, they never change currently so we don't have to ever
    // update m_penXXX objects above
    const wxColourScheme * const m_scheme;

    DECLARE_NO_COPY_CLASS(wxStdRenderer)
};

#endif // _WX_UNIV_STDREND_H_
Commit	Line	Data
147b8a4a VZ	1	///////////////////////////////////////////////////////////////////////////////
	2	// Name: wx/univ/stdrend.h
	3	// Purpose: wxStdRenderer class declaration
	4	// Author: Vadim Zeitlin
	5	// Created: 2006-09-18
	6	// RCS-ID: $Id$
	7	// Copyright: (c) 2006 Vadim Zeitlin <vadim@wxwindows.org>
	8	// Licence: wxWindows licence
	9	///////////////////////////////////////////////////////////////////////////////
	10
	11	#ifndef _WX_UNIV_STDREND_H_
	12	#define _WX_UNIV_STDREND_H_
	13
	14	#include "wx/univ/renderer.h"
762ad185	15	#include "wx/pen.h"
147b8a4a VZ	16
	17	class WXDLLEXPORT wxColourScheme;
	18
	19	// ----------------------------------------------------------------------------
	20	// wxStdRenderer: implements as much of wxRenderer API as possible generically
	21	// ----------------------------------------------------------------------------
	22
	23	class wxStdRenderer : public wxRenderer
	24	{
	25	public:
	26	// the renderer will use the given scheme, whose lifetime must be at least
	27	// as long as of this object itself, to choose the colours for drawing
	28	wxStdRenderer(const wxColourScheme *scheme);
	29
	30	virtual void DrawBackground(wxDC& dc,
	31	const wxColour& col,
	32	const wxRect& rect,
	33	int flags = 0,
	34	wxWindow *window = NULL);
	35	virtual void DrawButtonSurface(wxDC& dc,
	36	const wxColour& col,
	37	const wxRect& rect,
	38	int flags);
	39
	40
	41	virtual void DrawFocusRect(wxDC& dc, const wxRect& rect);
	42	virtual void DrawLabel(wxDC& dc,
	43	const wxString& label,
	44	const wxRect& rect,
	45	int flags = 0,
	46	int alignment = wxALIGN_LEFT \| wxALIGN_TOP,
	47	int indexAccel = -1,
	48	wxRect *rectBounds = NULL);
	49	virtual void DrawButtonLabel(wxDC& dc,
	50	const wxString& label,
	51	const wxBitmap& image,
	52	const wxRect& rect,
	53	int flags = 0,
	54	int alignment = wxALIGN_LEFT \| wxALIGN_TOP,
	55	int indexAccel = -1,
	56	wxRect *rectBounds = NULL);
	57
	58
	59	virtual void DrawBorder(wxDC& dc,
	60	wxBorder border,
	61	const wxRect& rect,
	62	int flags = 0,
	63	wxRect *rectIn = NULL);
	64	virtual void DrawTextBorder(wxDC& dc,
	65	wxBorder border,
	66	const wxRect& rect,
	67	int flags = 0,
	68	wxRect *rectIn = NULL);
	69
	70	virtual void DrawHorizontalLine(wxDC& dc,
	71	wxCoord y, wxCoord x1, wxCoord x2);
	72	virtual void DrawVerticalLine(wxDC& dc,
	73	wxCoord x, wxCoord y1, wxCoord y2);
	74	virtual void DrawFrame(wxDC& dc,
	75	const wxString& label,
	76	const wxRect& rect,
	77	int flags = 0,
	78	int alignment = wxALIGN_LEFT,
	79	int indexAccel = -1);
80
81
82	virtual void DrawItem(wxDC& dc,
83	const wxString& label,
84	const wxRect& rect,
85	int flags = 0);
6229b92f VZ	86	virtual void DrawCheckItem(wxDC& dc,
	87	const wxString& label,
	88	const wxBitmap& bitmap,
	89	const wxRect& rect,
	90	int flags = 0);
147b8a4a VZ	91
	92	virtual void DrawCheckButton(wxDC& dc,
	93	const wxString& label,
	94	const wxBitmap& bitmap,
	95	const wxRect& rect,
	96	int flags = 0,
	97	wxAlignment align = wxALIGN_LEFT,
	98	int indexAccel = -1);
	99	virtual void DrawRadioButton(wxDC& dc,
	100	const wxString& label,
	101	const wxBitmap& bitmap,
	102	const wxRect& rect,
	103	int flags = 0,
	104	wxAlignment align = wxALIGN_LEFT,
	105	int indexAccel = -1);
	106
0428ac8c VZ	107	virtual void DrawScrollbarArrow(wxDC& dc,
	108	wxDirection dir,
	109	const wxRect& rect,
	110	int flags = 0);
	111	virtual void DrawScrollCorner(wxDC& dc,
	112	const wxRect& rect);
	113
147b8a4a VZ	114	#if wxUSE_TEXTCTRL
	115	virtual void DrawTextLine(wxDC& dc,
	116	const wxString& text,
	117	const wxRect& rect,
	118	int selStart = -1,
	119	int selEnd = -1,
	120	int flags = 0);
	121
	122	virtual void DrawLineWrapMark(wxDC& dc, const wxRect& rect);
6229b92f VZ	123
	124	virtual wxRect GetTextTotalArea(const wxTextCtrl *text,
	125	const wxRect& rect) const;
	126	virtual wxRect GetTextClientArea(const wxTextCtrl *text,
	127	const wxRect& rect,
	128	wxCoord *extraSpaceBeyond) const;
147b8a4a VZ	129	#endif // wxUSE_TEXTCTRL
	130
	131	virtual wxRect GetBorderDimensions(wxBorder border) const;
	132
	133	virtual bool AreScrollbarsInsideBorder() const;
	134
1cd9779f VZ	135	virtual void AdjustSize(wxSize size, const wxWindow window);
	136
	137	virtual wxCoord GetListboxItemHeight(wxCoord fontHeight);
	138
147b8a4a VZ	139	#if wxUSE_SCROLLBAR
	140	virtual wxRect GetScrollbarRect(const wxScrollBar *scrollbar,
	141	wxScrollBar::Element elem,
	142	int thumbPos = -1) const;
	143
	144	virtual wxCoord GetScrollbarSize(const wxScrollBar *scrollbar);
	145
	146	virtual wxHitTest HitTestScrollbar(const wxScrollBar *scrollbar,
	147	const wxPoint& pt) const;
	148
	149	virtual wxCoord ScrollbarToPixel(const wxScrollBar *scrollbar,
	150	int thumbPos = -1);
	151	virtual int PixelToScrollbar(const wxScrollBar *scrollbar, wxCoord coord);
	152	#endif // wxUSE_SCROLLBAR
	153
1cd9779f VZ	154	#if wxUSE_STATUSBAR
	155	virtual void DrawStatusField(wxDC& dc,
	156	const wxRect& rect,
	157	const wxString& label,
	158	int flags = 0, int style = 0);
	159
	160	virtual wxSize GetStatusBarBorders(wxCoord *borderBetweenFields) const;
	161	#endif // wxUSE_STATUSBAR
	162
	163	virtual wxCoord GetCheckItemMargin() const { return 0; }
	164
147b8a4a VZ	165	protected:
147b8a4a VZ	166	// various constants
0428ac8c VZ	167	enum ArrowDirection
	168	{
	169	Arrow_Left,
	170	Arrow_Right,
	171	Arrow_Up,
	172	Arrow_Down,
	173	Arrow_Max
	174	};
	175
	176	enum ArrowStyle
	177	{
	178	Arrow_Normal,
	179	Arrow_Disabled,
	180	Arrow_Pressed,
	181	Arrow_Inverted,
	182	Arrow_InvertedDisabled,
	183	Arrow_StateMax
	184	};
	185
147b8a4a VZ	186	enum IndicatorType
	187	{
	188	IndicatorType_Check,
	189	IndicatorType_Radio,
6229b92f VZ	190	IndicatorType_MaxCtrl,
6229b92f VZ	191	IndicatorType_Menu = IndicatorType_MaxCtrl,
147b8a4a VZ	192	IndicatorType_Max
	193	};
	194
	195	enum IndicatorState
	196	{
	197	IndicatorState_Normal,
	198	IndicatorState_Pressed, // this one is for check/radioboxes
	199	IndicatorState_Disabled,
	200	IndicatorState_MaxCtrl,
	201
	202	// the rest of the states are valid for menu items only
	203	IndicatorState_Selected = IndicatorState_Pressed,
	204	IndicatorState_SelectedDisabled = IndicatorState_MaxCtrl,
	205	IndicatorState_MaxMenu
	206	};
	207
	208	enum IndicatorStatus
	209	{
	210	IndicatorStatus_Checked,
	211	IndicatorStatus_Unchecked,
	212	IndicatorStatus_Undetermined,
	213	IndicatorStatus_Max
	214	};
	215
	216	// translate the appropriate bits in flags to the above enum elements
	217	static void GetIndicatorsFromFlags(int flags,
	218	IndicatorState& state,
	219	IndicatorStatus& status);
	220
0428ac8c VZ	221	// translate wxDirection to ArrowDirection
	222	static ArrowDirection GetArrowDirection(wxDirection dir);
	223
	224
147b8a4a VZ	225	// fill the rectangle with a brush of given colour (must be valid)
	226	void DrawSolidRect(wxDC& dc, const wxColour& col, const wxRect& rect);
	227
	228
	229	// all the functions in this section adjust the rect parameter to
	230	// correspond to the interiour of the drawn area
	231
	232	// draw complete rectangle
	233	void DrawRect(wxDC& dc, wxRect *rect, const wxPen& pen);
	234
	235	// draw the rectange using the first pen for the left and top sides
	236	// and the second one for the bottom and right ones
	237	void DrawShadedRect(wxDC& dc, wxRect *rect,
	238	const wxPen& pen1, const wxPen& pen2);
	239
	240	// border drawing routines, may be overridden in the derived class
	241	virtual void DrawRaisedBorder(wxDC& dc, wxRect *rect);
	242	virtual void DrawSunkenBorder(wxDC& dc, wxRect *rect);
	243	virtual void DrawAntiSunkenBorder(wxDC& dc, wxRect *rect);
6229b92f	244	virtual void DrawFrameBorder(wxDC& dc, wxRect *rect);
147b8a4a VZ	245
	246
	247	// draw the frame with non-empty label inside the given rectText
	248	virtual void DrawFrameWithLabel(wxDC& dc,
	249	const wxString& label,
	250	const wxRect& rectFrame,
	251	const wxRect& rectText,
	252	int flags,
	253	int alignment,
	254	int indexAccel);
	255
	256	// draw the (static box) frame without the part corresponding to rectLabel
	257	void DrawFrameWithoutLabel(wxDC& dc,
	258	const wxRect& rectFrame,
	259	const wxRect& rectLabel);
	260
	261
6229b92f VZ	262	// draw the bitmap for a check item (which is by default the same as check
	263	// box one but may be different)
	264	virtual void DrawCheckItemBitmap(wxDC& dc,
	265	const wxBitmap& bitmap,
	266	const wxRect& rect,
	267	int flags);
	268
147b8a4a VZ	269	// common routine for drawing check and radio buttons
	270	void DrawCheckOrRadioButton(wxDC& dc,
	271	const wxString& label,
	272	const wxBitmap& bitmap,
	273	const wxRect& rect,
	274	int flags,
	275	wxAlignment align,
	276	int indexAccel);
	277
	278	// return the check/radio bitmap for the given flags
	279	virtual wxBitmap GetRadioBitmap(int flags) = 0;
	280	virtual wxBitmap GetCheckBitmap(int flags) = 0;
	281
6229b92f VZ	282	#if wxUSE_TEXTCTRL
	283	// return the width of the border around the text area in the text control
	284	virtual int GetTextBorderWidth(const wxTextCtrl *text) const;
	285	#endif // wxUSE_TEXTCTRL
147b8a4a VZ	286
	287	// return the starting and ending positions, in pixels, of the thumb of a
	288	// scrollbar with the given logical position, thumb size and range and the
	289	// given physical length
	290	static void GetScrollBarThumbSize(wxCoord length,
	291	int thumbPos,
	292	int thumbSize,
	293	int range,
	294	wxCoord *thumbStart,
	295	wxCoord *thumbEnd);
	296
	297	// GDI objects we often use
	298	wxPen m_penBlack,
	299	m_penDarkGrey,
	300	m_penLightGrey,
	301	m_penHighlight;
	302
	303	// the colours we use, they never change currently so we don't have to ever
	304	// update m_penXXX objects above
	305	const wxColourScheme * const m_scheme;
	306
	307	DECLARE_NO_COPY_CLASS(wxStdRenderer)
	308	};
	309
	310	#endif // _WX_UNIV_STDREND_H_