// Created: 06.08.00
// RCS-ID: $Id$
// Copyright: (c) 2000 SciTech Software, Inc. (www.scitechsoft.com)
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
/*
- wxRenderer class is used to draw all wxWindows controls. This is an ABC and
+ wxRenderer class is used to draw all wxWidgets controls. This is an ABC and
the look of the application is determined by the concrete derivation of
wxRenderer used in the program.
renderers and provide the functionality which is often similar or identical
in all renderers (using inheritance here would be more restrictive as the
given concrete renderer may need an arbitrary subset of the base class
- methods)
+ methods).
+
+ Finally note that wxRenderer supersedes wxRendererNative in wxUniv build and
+ includes the latters functionality (which it may delegate to the generic
+ implementation of the latter or reimplement itself).
*/
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma interface "renderer.h"
#endif
#ifndef _WX_UNIV_RENDERER_H_
#define _WX_UNIV_RENDERER_H_
+#include "wx/renderer.h"
+
class WXDLLEXPORT wxDC;
class WXDLLEXPORT wxCheckListBox;
class WXDLLEXPORT wxListBox;
#include "wx/string.h"
#include "wx/gdicmn.h"
+#include "wx/icon.h"
#include "wx/scrolbar.h" // for wxScrollBar::Element
+// helper class used by wxMenu-related functions
+class WXDLLEXPORT wxMenuGeometryInfo
+{
+public:
+ // get the total size of the menu
+ virtual wxSize GetSize() const = 0;
+
+ virtual ~wxMenuGeometryInfo();
+};
+
// ----------------------------------------------------------------------------
// wxRenderer: abstract renderers interface
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxRenderer
+class WXDLLEXPORT wxRenderer : public wxDelegateRendererNative
{
public:
// drawing functions
virtual void DrawBackground(wxDC& dc,
const wxColour& col,
const wxRect& rect,
- int flags) = 0;
+ int flags,
+ wxWindow *window = NULL ) = 0;
+
+ // draw the button surface
+ virtual void DrawButtonSurface(wxDC& dc,
+ const wxColour& col,
+ const wxRect& rect,
+ int flags )
+ { DrawBackground( dc, col, rect, flags ); }
+
// draw the label inside the given rectangle with the specified alignment
// and optionally emphasize the character with the given index
wxAlignment align = wxALIGN_LEFT,
int indexAccel = -1) = 0;
+ // draw a toolbar button (label may be empty, bitmap may be invalid, if
+ // both conditions are true this function draws a separator)
+ virtual void DrawToolBarButton(wxDC& dc,
+ const wxString& label,
+ const wxBitmap& bitmap,
+ const wxRect& rect,
+ int flags = 0,
+ long style = 0) = 0;
+
// draw a (part of) line in the text control
virtual void DrawTextLine(wxDC& dc,
const wxString& text,
// draw the slider shaft
virtual void DrawSliderShaft(wxDC& dc,
const wxRect& rect,
+ int lenThumb,
wxOrientation orient,
int flags = 0,
+ long style = 0,
wxRect *rectShaft = NULL) = 0;
// draw the slider thumb
virtual void DrawSliderThumb(wxDC& dc,
const wxRect& rect,
wxOrientation orient,
- int flags = 0) = 0;
+ int flags = 0,
+ long style = 0) = 0;
// draw the slider ticks
virtual void DrawSliderTicks(wxDC& dc,
const wxRect& rect,
- const wxSize& sizeThumb,
+ int lenThumb,
wxOrientation orient,
int start,
int end,
int step = 1,
- int flags = 0) = 0;
+ int flags = 0,
+ long style = 0) = 0;
-#if wxUSE_MENUS
// draw a menu bar item
virtual void DrawMenuBarItem(wxDC& dc,
const wxRect& rect,
virtual void DrawMenuSeparator(wxDC& dc,
wxCoord y,
const wxMenuGeometryInfo& geomInfo) = 0;
-#endif
+
+ // draw a status bar field: wxCONTROL_ISDEFAULT bit in the flags is
+ // interpreted specially and means "draw the status bar grip" here
+ virtual void DrawStatusField(wxDC& dc,
+ const wxRect& rect,
+ const wxString& label,
+ int flags = 0) = 0;
+
+ // draw complete frame/dialog titlebar
+ virtual void DrawFrameTitleBar(wxDC& dc,
+ const wxRect& rect,
+ const wxString& title,
+ const wxIcon& icon,
+ int flags,
+ int specialButton = 0,
+ int specialButtonFlags = 0) = 0;
+
+ // draw frame borders
+ virtual void DrawFrameBorder(wxDC& dc,
+ const wxRect& rect,
+ int flags) = 0;
+
+ // draw frame titlebar background
+ virtual void DrawFrameBackground(wxDC& dc,
+ const wxRect& rect,
+ int flags) = 0;
+
+ // draw frame title
+ virtual void DrawFrameTitle(wxDC& dc,
+ const wxRect& rect,
+ const wxString& title,
+ int flags) = 0;
+
+ // draw frame icon
+ virtual void DrawFrameIcon(wxDC& dc,
+ const wxRect& rect,
+ const wxIcon& icon,
+ int flags) = 0;
+
+ // draw frame buttons
+ virtual void DrawFrameButton(wxDC& dc,
+ wxCoord x, wxCoord y,
+ int button,
+ int flags = 0) = 0;
+
// misc functions
// --------------
virtual wxSize GetRadioBitmapSize() const = 0;
virtual wxCoord GetCheckItemMargin() const = 0;
+ // get the standard size of a toolbar button and also return the size of
+ // a toolbar separator in the provided pointer
+ virtual wxSize GetToolBarButtonSize(wxCoord *separator) const = 0;
+
+ // get the margins between/around the toolbar buttons
+ virtual wxSize GetToolBarMargin() const = 0;
+
// convert between text rectangle and client rectangle for text controls:
// the former is typicall smaller to leave margins around text
virtual wxRect GetTextTotalArea(const wxTextCtrl *text,
- const wxRect& rectText) = 0;
+ const wxRect& rectText) const = 0;
// extra space is for line indicators
virtual wxRect GetTextClientArea(const wxTextCtrl *text,
const wxRect& rectTotal,
- wxCoord *extraSpaceBeyond) = 0;
+ wxCoord *extraSpaceBeyond) const = 0;
// get the overhang of a selected tab
virtual wxSize GetTabIndent() const = 0;
// get the slider shaft rect from the total slider rect
virtual wxRect GetSliderShaftRect(const wxRect& rect,
- wxOrientation orient) const = 0;
+ int lenThumb,
+ wxOrientation orient,
+ long style = 0) const = 0;
// get the size of the slider thumb for the given total slider rect
virtual wxSize GetSliderThumbSize(const wxRect& rect,
+ int lenThumb,
wxOrientation orient) const = 0;
// get the size of one progress bar step (in horz and vertical directions)
virtual wxSize GetProgressBarStep() const = 0;
-#if wxUSE_MENUS
// get the size of rectangle to use in the menubar for the given text rect
virtual wxSize GetMenuBarItemSize(const wxSize& sizeText) const = 0;
// the returned pointer must be deleted by the caller
virtual wxMenuGeometryInfo *GetMenuGeometry(wxWindow *win,
const wxMenu& menu) const = 0;
-#endif
+
+ // get the borders around the status bar fields (x and y fields of the
+ // return value) and also, optionally, the border between the fields
+ virtual wxSize GetStatusBarBorders(wxCoord *borderBetweenFields) const = 0;
+
+ // get client area rectangle of top level window (i.e. subtract
+ // decorations from given rectangle)
+ virtual wxRect GetFrameClientArea(const wxRect& rect, int flags) const = 0;
+
+ // get size of whole top level window, given size of its client area size
+ virtual wxSize GetFrameTotalSize(const wxSize& clientSize, int flags) const = 0;
+
+ // get the minimal size of top level window
+ virtual wxSize GetFrameMinSize(int flags) const = 0;
+
+ // get titlebar icon size
+ virtual wxSize GetFrameIconSize() const = 0;
+
+ // returns one of wxHT_TOPLEVEL_XXX constants
+ virtual int HitTestFrame(const wxRect& rect,
+ const wxPoint& pt,
+ int flags = 0) const = 0;
+
// virtual dtor for any base class
virtual ~wxRenderer();
+
protected:
// draw a frame around rectFrame rectangle but not touching the rectLabel
// one: this is used by DrawFrame()
virtual void DrawBackground(wxDC& dc,
const wxColour& col,
const wxRect& rect,
- int flags)
- { m_renderer->DrawBackground(dc, col, rect, flags); }
+ int flags,
+ wxWindow *window = NULL )
+ { m_renderer->DrawBackground(dc, col, rect, flags, window ); }
virtual void DrawLabel(wxDC& dc,
const wxString& label,
const wxRect& rect,
int indexAccel = -1)
{ m_renderer->DrawRadioButton(dc, label, bitmap, rect,
flags, align, indexAccel); }
+ virtual void DrawToolBarButton(wxDC& dc,
+ const wxString& label,
+ const wxBitmap& bitmap,
+ const wxRect& rect,
+ int flags = 0,
+ long style = 0)
+ { m_renderer->DrawToolBarButton(dc, label, bitmap, rect, flags, style); }
virtual void DrawTextLine(wxDC& dc,
const wxString& text,
const wxRect& rect,
int selStart = -1,
- int selEnd = -1)
- { m_renderer->DrawTextLine(dc, text, rect, selStart, selEnd); }
+ int selEnd = -1,
+ int flags = 0)
+ { m_renderer->DrawTextLine(dc, text, rect, selStart, selEnd, flags); }
virtual void DrawLineWrapMark(wxDC& dc, const wxRect& rect)
{ m_renderer->DrawLineWrapMark(dc, rect); }
virtual void DrawSliderShaft(wxDC& dc,
const wxRect& rect,
+ int lenThumb,
wxOrientation orient,
int flags = 0,
+ long style = 0,
wxRect *rectShaft = NULL)
- { m_renderer->DrawSliderShaft(dc, rect, orient, flags, rectShaft); }
+ { m_renderer->DrawSliderShaft(dc, rect, lenThumb, orient, flags, style, rectShaft); }
virtual void DrawSliderThumb(wxDC& dc,
const wxRect& rect,
wxOrientation orient,
- int flags = 0)
- { m_renderer->DrawSliderThumb(dc, rect, orient, flags); }
+ int flags = 0,
+ long style = 0)
+ { m_renderer->DrawSliderThumb(dc, rect, orient, flags, style); }
virtual void DrawSliderTicks(wxDC& dc,
const wxRect& rect,
- const wxSize& sizeThumb,
+ int lenThumb,
wxOrientation orient,
int start,
int end,
- int step = 1,
- int flags = 0)
- { m_renderer->DrawSliderTicks(dc, rect, sizeThumb, orient,
- start, end, start, flags); }
-#if wxUSE_MENUS
+ int WXUNUSED(step) = 1,
+ int flags = 0,
+ long style = 0)
+ { m_renderer->DrawSliderTicks(dc, rect, lenThumb, orient,
+ start, end, start, flags, style); }
virtual void DrawMenuBarItem(wxDC& dc,
const wxRect& rect,
wxCoord y,
const wxMenuGeometryInfo& geomInfo)
{ m_renderer->DrawMenuSeparator(dc, y, geomInfo); }
-#endif
+
+ virtual void DrawStatusField(wxDC& dc,
+ const wxRect& rect,
+ const wxString& label,
+ int flags = 0)
+ { m_renderer->DrawStatusField(dc, rect, label, flags); }
+
+ virtual void DrawFrameTitleBar(wxDC& dc,
+ const wxRect& rect,
+ const wxString& title,
+ const wxIcon& icon,
+ int flags,
+ int specialButton = 0,
+ int specialButtonFlag = 0)
+ { m_renderer->DrawFrameTitleBar(dc, rect, title, icon, flags,
+ specialButton, specialButtonFlag); }
+ virtual void DrawFrameBorder(wxDC& dc,
+ const wxRect& rect,
+ int flags)
+ { m_renderer->DrawFrameBorder(dc, rect, flags); }
+ virtual void DrawFrameBackground(wxDC& dc,
+ const wxRect& rect,
+ int flags)
+ { m_renderer->DrawFrameBackground(dc, rect, flags); }
+ virtual void DrawFrameTitle(wxDC& dc,
+ const wxRect& rect,
+ const wxString& title,
+ int flags)
+ { m_renderer->DrawFrameTitle(dc, rect, title, flags); }
+ virtual void DrawFrameIcon(wxDC& dc,
+ const wxRect& rect,
+ const wxIcon& icon,
+ int flags)
+ { m_renderer->DrawFrameIcon(dc, rect, icon, flags); }
+ virtual void DrawFrameButton(wxDC& dc,
+ wxCoord x, wxCoord y,
+ int button,
+ int flags = 0)
+ { m_renderer->DrawFrameButton(dc, x, y, button, flags); }
+
virtual void GetComboBitmaps(wxBitmap *bmpNormal,
wxBitmap *bmpFocus,
wxBitmap *bmpPressed,
virtual wxCoord GetCheckItemMargin() const
{ return m_renderer->GetCheckItemMargin(); }
- virtual wxRect GetTextTotalArea(const wxTextCtrl *text, const wxRect& rect)
+ virtual wxSize GetToolBarButtonSize(wxCoord *separator) const
+ { return m_renderer->GetToolBarButtonSize(separator); }
+ virtual wxSize GetToolBarMargin() const
+ { return m_renderer->GetToolBarMargin(); }
+
+ virtual wxRect GetTextTotalArea(const wxTextCtrl *text,
+ const wxRect& rect) const
{ return m_renderer->GetTextTotalArea(text, rect); }
virtual wxRect GetTextClientArea(const wxTextCtrl *text,
const wxRect& rect,
- wxCoord *extraSpaceBeyond)
+ wxCoord *extraSpaceBeyond) const
{ return m_renderer->GetTextClientArea(text, rect, extraSpaceBeyond); }
virtual wxSize GetTabIndent() const { return m_renderer->GetTabIndent(); }
virtual wxCoord GetSliderTickLen() const
{ return m_renderer->GetSliderTickLen(); }
virtual wxRect GetSliderShaftRect(const wxRect& rect,
- wxOrientation orient) const
- { return GetSliderShaftRect(rect, orient); }
+ int lenThumb,
+ wxOrientation orient,
+ long style = 0) const
+ { return m_renderer->GetSliderShaftRect(rect, lenThumb, orient, style); }
virtual wxSize GetSliderThumbSize(const wxRect& rect,
+ int lenThumb,
wxOrientation orient) const
- { return m_renderer->GetSliderThumbSize(rect, orient); }
+ { return m_renderer->GetSliderThumbSize(rect, lenThumb, orient); }
virtual wxSize GetProgressBarStep() const
{ return m_renderer->GetProgressBarStep(); }
-#if wxUSE_MENUS
virtual wxSize GetMenuBarItemSize(const wxSize& sizeText) const
{ return m_renderer->GetMenuBarItemSize(sizeText); }
virtual wxMenuGeometryInfo *GetMenuGeometry(wxWindow *win,
const wxMenu& menu) const
{ return m_renderer->GetMenuGeometry(win, menu); }
-#endif
+ virtual wxSize GetStatusBarBorders(wxCoord *borderBetweenFields) const
+ { return m_renderer->GetStatusBarBorders(borderBetweenFields); }
+ virtual wxRect GetFrameClientArea(const wxRect& rect, int flags) const
+ { return m_renderer->GetFrameClientArea(rect, flags); }
+ virtual wxSize GetFrameTotalSize(const wxSize& clientSize, int flags) const
+ { return m_renderer->GetFrameTotalSize(clientSize, flags); }
+ virtual wxSize GetFrameMinSize(int flags) const
+ { return m_renderer->GetFrameMinSize(flags); }
+ virtual wxSize GetFrameIconSize() const
+ { return m_renderer->GetFrameIconSize(); }
+ virtual int HitTestFrame(const wxRect& rect,
+ const wxPoint& pt,
+ int flags) const
+ { return m_renderer->HitTestFrame(rect, pt, flags); }
+
+ virtual void DrawHeaderButton(wxWindow *win,
+ wxDC& dc,
+ const wxRect& rect,
+ int flags = 0)
+ { m_renderer->DrawHeaderButton(win, dc, rect, flags); }
+ virtual void DrawTreeItemButton(wxWindow *win,
+ wxDC& dc,
+ const wxRect& rect,
+ int flags = 0)
+ { m_renderer->DrawTreeItemButton(win, dc, rect, flags); }
+
protected:
wxRenderer *m_renderer;
};
projects / wxWidgets.git / blobdiff