1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/renderg.cpp
3 // Purpose: generic implementation of wxRendererNative (for any platform)
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
9 // License: wxWindows license
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // for compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
27 #include "wx/renderer.h"
30 #include "wx/string.h"
32 #include "wx/settings.h"
33 #include "wx/gdicmn.h"
34 #include "wx/module.h"
37 #include "wx/splitter.h"
38 #include "wx/dcmirror.h"
41 #include "wx/osx/private.h"
44 // ----------------------------------------------------------------------------
45 // wxRendererGeneric: our wxRendererNative implementation
46 // ----------------------------------------------------------------------------
48 class WXDLLEXPORT wxRendererGeneric
: public wxRendererNative
53 virtual int DrawHeaderButton(wxWindow
*win
,
57 wxHeaderSortIconType sortArrow
= wxHDR_SORT_ICON_NONE
,
58 wxHeaderButtonParams
* params
= NULL
);
60 virtual int DrawHeaderButtonContents(wxWindow
*win
,
64 wxHeaderSortIconType sortArrow
= wxHDR_SORT_ICON_NONE
,
65 wxHeaderButtonParams
* params
= NULL
);
67 virtual int GetHeaderButtonHeight(wxWindow
*win
);
69 virtual void DrawTreeItemButton(wxWindow
*win
,
74 virtual void DrawSplitterBorder(wxWindow
*win
,
79 virtual void DrawSplitterSash(wxWindow
*win
,
86 virtual void DrawComboBoxDropButton(wxWindow
*win
,
91 virtual void DrawDropArrow(wxWindow
*win
,
96 virtual void DrawCheckBox(wxWindow
*win
,
101 virtual wxSize
GetCheckBoxSize(wxWindow
*win
);
103 virtual void DrawPushButton(wxWindow
*win
,
108 virtual void DrawItemSelectionRect(wxWindow
*win
,
113 virtual void DrawFocusRect(wxWindow
* win
, wxDC
& dc
, const wxRect
& rect
, int flags
= 0);
115 virtual void DrawChoice(wxWindow
* win
, wxDC
& dc
, const wxRect
& rect
, int flags
=0);
117 virtual void DrawComboBox(wxWindow
* win
, wxDC
& dc
, const wxRect
& rect
, int flags
=0);
119 virtual void DrawTextCtrl(wxWindow
* win
, wxDC
& dc
, const wxRect
& rect
, int flags
=0);
121 virtual void DrawRadioBitmap(wxWindow
* win
, wxDC
& dc
, const wxRect
& rect
, int flags
=0);
123 #ifdef wxHAS_DRAW_TITLE_BAR_BITMAP
124 virtual void DrawTitleBarBitmap(wxWindow
*win
,
127 wxTitleBarButton button
,
129 #endif // wxHAS_DRAW_TITLE_BAR_BITMAP
131 virtual wxSplitterRenderParams
GetSplitterParams(const wxWindow
*win
);
133 virtual wxRendererVersion
GetVersion() const
135 return wxRendererVersion(wxRendererVersion::Current_Version
,
136 wxRendererVersion::Current_Age
);
140 // Cleanup by deleting standard renderer
141 static void Cleanup();
143 // Get the generic object
144 static wxRendererGeneric
* DoGetGeneric();
147 // draw the rectange using the first pen for the left and top sides and
148 // the second one for the bottom and right ones
149 void DrawShadedRect(wxDC
& dc
, wxRect
*rect
,
150 const wxPen
& pen1
, const wxPen
& pen2
);
158 static wxRendererGeneric
* sm_rendererGeneric
;
161 // ============================================================================
162 // wxRendererGeneric implementation
163 // ============================================================================
165 // Get the generic object
166 wxRendererGeneric
* wxRendererGeneric::DoGetGeneric()
168 if (!sm_rendererGeneric
)
169 sm_rendererGeneric
= new wxRendererGeneric
;
170 return sm_rendererGeneric
;
173 // ----------------------------------------------------------------------------
174 // wxRendererGeneric creation
175 // ----------------------------------------------------------------------------
178 wxRendererNative
& wxRendererNative::GetGeneric()
180 return * wxRendererGeneric::DoGetGeneric();
183 void wxRendererGeneric::Cleanup()
185 if (sm_rendererGeneric
)
186 delete sm_rendererGeneric
;
188 sm_rendererGeneric
= NULL
;
191 wxRendererGeneric
* wxRendererGeneric::sm_rendererGeneric
= NULL
;
193 wxRendererGeneric::wxRendererGeneric()
194 : m_penBlack(wxSystemSettings::GetColour(wxSYS_COLOUR_3DDKSHADOW
)),
195 m_penDarkGrey(wxSystemSettings::GetColour(wxSYS_COLOUR_3DSHADOW
)),
196 m_penLightGrey(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
)),
197 m_penHighlight(wxSystemSettings::GetColour(wxSYS_COLOUR_3DHIGHLIGHT
))
201 // ----------------------------------------------------------------------------
202 // wxRendererGeneric helpers
203 // ----------------------------------------------------------------------------
206 wxRendererGeneric::DrawShadedRect(wxDC
& dc
,
211 // draw the rectangle
213 dc
.DrawLine(rect
->GetLeft(), rect
->GetTop(),
214 rect
->GetLeft(), rect
->GetBottom());
215 dc
.DrawLine(rect
->GetLeft() + 1, rect
->GetTop(),
216 rect
->GetRight(), rect
->GetTop());
218 dc
.DrawLine(rect
->GetRight(), rect
->GetTop(),
219 rect
->GetRight(), rect
->GetBottom());
220 dc
.DrawLine(rect
->GetLeft(), rect
->GetBottom(),
221 rect
->GetRight() + 1, rect
->GetBottom());
227 // ----------------------------------------------------------------------------
228 // tree/list ctrl drawing
229 // ----------------------------------------------------------------------------
232 wxRendererGeneric::DrawHeaderButton(wxWindow
* win
,
236 wxHeaderSortIconType sortArrow
,
237 wxHeaderButtonParams
* params
)
239 const wxCoord x
= rect
.x
,
244 dc
.SetBrush(wxBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
)));
245 dc
.SetPen(*wxTRANSPARENT_PEN
);
246 dc
.DrawRectangle(rect
);
248 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
250 dc
.SetPen(m_penBlack
);
251 dc
.DrawLine( x
+w
-1, y
, x
+w
-1, y
+h
); // right (outer)
252 dc
.DrawLine( x
, y
+h
-1, x
+w
, y
+h
-1 ); // bottom (outer)
254 dc
.SetPen(m_penDarkGrey
);
255 dc
.DrawLine( x
+w
-2, y
+1, x
+w
-2, y
+h
-1 ); // right (inner)
256 dc
.DrawLine( x
+1, y
+h
-2, x
+w
-1, y
+h
-2 ); // bottom (inner)
258 dc
.SetPen(m_penHighlight
);
259 dc
.DrawLine( x
, y
, x
, y
+h
-1 ); // left (outer)
260 dc
.DrawLine( x
, y
, x
+w
-1, y
); // top (outer)
262 return DrawHeaderButtonContents(win
, dc
, rect
, flags
, sortArrow
, params
);
267 wxRendererGeneric::DrawHeaderButtonContents(wxWindow
*win
,
271 wxHeaderSortIconType sortArrow
,
272 wxHeaderButtonParams
* params
)
276 // Mark this item as selected. For the generic version we'll just draw an
278 if ( flags
& wxCONTROL_SELECTED
)
280 // draw a line at the bottom of the header button, overlaying the
281 // native hot-tracking line (on XP)
282 const int penwidth
= 3;
283 int y
= rect
.y
+ rect
.height
+ 1 - penwidth
;
284 wxColour c
= (params
&& params
->m_selectionColour
.Ok()) ?
285 params
->m_selectionColour
: wxColour(0x66, 0x66, 0x66);
286 wxPen
pen(c
, penwidth
);
287 pen
.SetCap(wxCAP_BUTT
);
289 dc
.DrawLine(rect
.x
, y
, rect
.x
+ rect
.width
, y
);
292 // Draw an up or down arrow
294 if (sortArrow
!= wxHDR_SORT_ICON_NONE
)
298 // make a rect for the arrow
301 ar
.y
+= (rect
.height
- ar
.height
)/2;
302 ar
.x
= ar
.x
+ rect
.width
- 3*ar
.width
/2;
303 arrowSpace
= 3*ar
.width
/2; // space to preserve when drawing the label
306 if ( sortArrow
& wxHDR_SORT_ICON_UP
)
308 triPt
[0].x
= ar
.width
/ 2;
310 triPt
[1].x
= ar
.width
;
311 triPt
[1].y
= ar
.height
;
313 triPt
[2].y
= ar
.height
;
319 triPt
[1].x
= ar
.width
;
321 triPt
[2].x
= ar
.width
/ 2;
322 triPt
[2].y
= ar
.height
;
325 wxColour c
= (params
&& params
->m_arrowColour
.Ok()) ?
326 params
->m_arrowColour
: wxSystemSettings::GetColour(wxSYS_COLOUR_3DSHADOW
);
328 wxDCPenChanger
setPen(dc
, c
);
329 wxDCBrushChanger
setBrush(dc
, c
);
331 wxDCClipper
clip(dc
, rect
);
332 dc
.DrawPolygon( 3, triPt
, ar
.x
, ar
.y
);
334 labelWidth
+= arrowSpace
;
338 // draw the bitmap if there is one
339 if ( params
&& params
->m_labelBitmap
.Ok() )
341 int w
= params
->m_labelBitmap
.GetWidth();
342 int h
= params
->m_labelBitmap
.GetHeight();
344 const int margin
= 1; // an extra pixel on either side of the bitmap
346 bmpWidth
= w
+ 2*margin
;
347 labelWidth
+= bmpWidth
;
349 int x
= rect
.x
+ margin
;
350 const int y
= rect
.y
+ wxMax(1, (rect
.height
- h
) / 2);
352 const int extraSpace
= rect
.width
- labelWidth
;
353 if ( params
->m_labelText
.empty() && extraSpace
> 0 )
355 // use the alignment flags
356 switch (params
->m_labelAlignment
)
372 wxDCClipper
clip(dc
, rect
);
373 dc
.DrawBitmap(params
->m_labelBitmap
, x
, y
, true);
376 // Draw a label if one is given
377 if ( params
&& !params
->m_labelText
.empty() )
379 const int margin
= 5; // number of pixels to reserve on either side of the label
380 labelWidth
+= 2*margin
;
382 wxFont font
= params
->m_labelFont
.Ok() ?
383 params
->m_labelFont
: win
->GetFont();
384 wxColour clr
= params
->m_labelColour
.Ok() ?
385 params
->m_labelColour
: win
->GetForegroundColour();
387 wxString
label( params
->m_labelText
);
390 dc
.SetTextForeground(clr
);
391 dc
.SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT
);
394 dc
.GetTextExtent( label
, &tw
, &th
, &td
);
396 int x
= rect
.x
+ bmpWidth
+ margin
;
397 const int y
= rect
.y
+ wxMax(0, (rect
.height
- (th
+td
)) / 2);
399 // truncate and add an ellipsis (...) if the text is too wide.
400 const int availWidth
= rect
.width
- labelWidth
;
401 if ( tw
> availWidth
)
403 label
= wxControl::Ellipsize(label
,
407 wxELLIPSIZE_FLAGS_NONE
);
408 tw
= dc
.GetTextExtent(label
).x
;
410 else // enough space, we can respect alignment
412 switch (params
->m_labelAlignment
)
419 x
+= (availWidth
- tw
)/2;
423 x
+= availWidth
- tw
;
428 dc
.DrawText(label
, x
, y
);
437 int wxRendererGeneric::GetHeaderButtonHeight(wxWindow
*win
)
439 // Copied and adapted from src/generic/listctrl.cpp
440 const int HEADER_OFFSET_Y
= 1;
441 const int EXTRA_HEIGHT
= 4;
445 win
->GetTextExtent(wxT("Hg"), &w
, &h
, &d
);
447 return h
+ d
+ 2 * HEADER_OFFSET_Y
+ EXTRA_HEIGHT
;
451 // draw the plus or minus sign
453 wxRendererGeneric::DrawTreeItemButton(wxWindow
* WXUNUSED(win
),
459 wxDCPenChanger
penChanger(dc
, *wxGREY_PEN
);
460 wxDCBrushChanger
brushChanger(dc
, *wxWHITE_BRUSH
);
462 dc
.DrawRectangle(rect
);
465 const wxCoord xMiddle
= rect
.x
+ rect
.width
/2;
466 const wxCoord yMiddle
= rect
.y
+ rect
.height
/2;
468 // half of the length of the horz lines in "-" and "+"
469 const wxCoord halfWidth
= rect
.width
/2 - 2;
470 dc
.SetPen(*wxBLACK_PEN
);
471 dc
.DrawLine(xMiddle
- halfWidth
, yMiddle
,
472 xMiddle
+ halfWidth
+ 1, yMiddle
);
474 if ( !(flags
& wxCONTROL_EXPANDED
) )
477 const wxCoord halfHeight
= rect
.height
/2 - 2;
478 dc
.DrawLine(xMiddle
, yMiddle
- halfHeight
,
479 xMiddle
, yMiddle
+ halfHeight
+ 1);
483 // ----------------------------------------------------------------------------
485 // ----------------------------------------------------------------------------
487 wxSplitterRenderParams
488 wxRendererGeneric::GetSplitterParams(const wxWindow
*win
)
494 if ( win
->HasFlag(wxSP_3DSASH
) )
496 else if ( win
->HasFlag(wxSP_NOSASH
) )
501 if ( win
->HasFlag(wxSP_3DBORDER
) )
506 return wxSplitterRenderParams(sashWidth
, border
, false);
510 wxRendererGeneric::DrawSplitterBorder(wxWindow
*win
,
512 const wxRect
& rectOrig
,
515 if ( win
->HasFlag(wxSP_3DBORDER
) )
517 wxRect rect
= rectOrig
;
518 DrawShadedRect(dc
, &rect
, m_penDarkGrey
, m_penHighlight
);
519 DrawShadedRect(dc
, &rect
, m_penBlack
, m_penLightGrey
);
524 wxRendererGeneric::DrawSplitterSash(wxWindow
*win
,
526 const wxSize
& sizeReal
,
528 wxOrientation orient
,
531 // to avoid duplicating the same code for horizontal and vertical sashes,
532 // simply mirror the DC instead if needed (i.e. if horz splitter)
533 wxMirrorDC
dc(dcReal
, orient
!= wxVERTICAL
);
534 wxSize size
= dc
.Reflect(sizeReal
);
537 // we draw a Win32-like grey sash with possible 3D border here:
539 // ---- this is position
544 // GWGGGDB where G is light grey (face)
545 // GWGGGDB W white (light)
546 // GWGGGDB D dark grey (shadow)
547 // GWGGGDB B black (dark shadow)
549 // GWGGGDB and lower letters are our border (already drawn)
553 // only the middle 3 columns are drawn unless wxSP_3D is specified
555 const wxCoord h
= size
.y
;
558 // If we're drawing the border, draw the sash 3d lines shorter
559 if ( win
->HasFlag(wxSP_3DBORDER
) )
564 dc
.SetPen(*wxTRANSPARENT_PEN
);
565 dc
.SetBrush(wxBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
)));
567 if ( win
->HasFlag(wxSP_3DSASH
) )
570 dc
.DrawRectangle(position
+ 2, 0, 3, h
);
572 dc
.SetPen(m_penLightGrey
);
573 dc
.DrawLine(position
, offset
, position
, h
- offset
);
575 dc
.SetPen(m_penHighlight
);
576 dc
.DrawLine(position
+ 1, 0, position
+ 1, h
);
578 dc
.SetPen(m_penDarkGrey
);
579 dc
.DrawLine(position
+ 5, 0, position
+ 5, h
);
581 dc
.SetPen(m_penBlack
);
582 dc
.DrawLine(position
+ 6, offset
, position
+ 6, h
- offset
);
587 dc
.DrawRectangle(position
, 0, 3, h
);
591 // ----------------------------------------------------------------------------
593 // ----------------------------------------------------------------------------
596 wxRendererGeneric::DrawComboBoxDropButton(wxWindow
*win
,
601 DrawPushButton(win
,dc
,rect
,flags
);
602 DrawDropArrow(win
,dc
,rect
,flags
);
606 wxRendererGeneric::DrawDropArrow(wxWindow
*win
,
611 // This generic implementation should be good
612 // enough for Windows platforms (including XP).
614 int arrowHalf
= rect
.width
/5;
615 int rectMid
= rect
.width
/ 2;
616 int arrowTopY
= (rect
.height
/2) - (arrowHalf
/2);
618 // This should always result in arrow with odd width.
621 wxPoint(rectMid
- arrowHalf
, arrowTopY
),
622 wxPoint(rectMid
+ arrowHalf
, arrowTopY
),
623 wxPoint(rectMid
, arrowTopY
+ arrowHalf
)
625 dc
.SetBrush(wxBrush(win
->GetForegroundColour()));
626 dc
.SetPen(wxPen(win
->GetForegroundColour()));
627 dc
.DrawPolygon(WXSIZEOF(pt
), pt
, rect
.x
, rect
.y
);
631 wxRendererGeneric::DrawCheckBox(wxWindow
*WXUNUSED(win
),
636 dc
.SetPen(*(flags
& wxCONTROL_DISABLED
? wxGREY_PEN
: wxBLACK_PEN
));
637 dc
.SetBrush( *wxTRANSPARENT_BRUSH
);
638 dc
.DrawRectangle(rect
);
640 if ( flags
& wxCONTROL_CHECKED
)
642 dc
.DrawCheckMark(rect
.Deflate(2, 2));
646 wxSize
wxRendererGeneric::GetCheckBoxSize(wxWindow
*WXUNUSED(win
))
648 return wxSize(16, 16);
652 wxRendererGeneric::DrawPushButton(wxWindow
*win
,
657 // Don't try anything too fancy. It'll just turn out looking
658 // out-of-place on most platforms.
659 wxColour bgCol
= flags
& wxCONTROL_DISABLED
?
660 wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE
) :
661 win
->GetBackgroundColour();
662 dc
.SetBrush(wxBrush(bgCol
));
663 dc
.SetPen(wxPen(bgCol
));
664 dc
.DrawRectangle(rect
);
668 wxRendererGeneric::DrawItemSelectionRect(wxWindow
* win
,
674 if ( flags
& wxCONTROL_SELECTED
)
676 if ( flags
& wxCONTROL_FOCUSED
)
678 brush
= wxBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT
));
682 brush
= wxBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_BTNSHADOW
));
687 brush
= *wxTRANSPARENT_BRUSH
;
691 if ((flags
& wxCONTROL_CURRENT
) && (flags
& wxCONTROL_FOCUSED
)
692 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__) && wxOSX_USE_CARBON
693 && IsControlActive( (ControlRef
)win
->GetHandle() )
696 dc
.SetPen( *wxBLACK_PEN
);
698 dc
.SetPen( *wxTRANSPARENT_PEN
);
700 dc
.DrawRectangle( rect
);
702 // it's unused everywhere except in wxOSX/Carbon
707 wxRendererGeneric::DrawFocusRect(wxWindow
* WXUNUSED(win
), wxDC
& dc
, const wxRect
& rect
, int WXUNUSED(flags
))
709 // draw the pixels manually because the "dots" in wxPen with wxDOT style
710 // may be short traits and not really dots
712 // note that to behave in the same manner as DrawRect(), we must exclude
713 // the bottom and right borders from the rectangle
714 wxCoord x1
= rect
.GetLeft(),
716 x2
= rect
.GetRight(),
717 y2
= rect
.GetBottom();
719 dc
.SetPen(m_penBlack
);
722 dc
.SetLogicalFunction(wxCOPY
);
724 // this seems to be closer than what Windows does than wxINVERT although
725 // I'm still not sure if it's correct
726 dc
.SetLogicalFunction(wxAND_REVERSE
);
730 for ( z
= x1
+ 1; z
< x2
; z
+= 2 )
731 dc
.DrawPoint(z
, rect
.GetTop());
733 wxCoord shift
= z
== x2
? 0 : 1;
734 for ( z
= y1
+ shift
; z
< y2
; z
+= 2 )
737 shift
= z
== y2
? 0 : 1;
738 for ( z
= x2
- shift
; z
> x1
; z
-= 2 )
741 shift
= z
== x1
? 0 : 1;
742 for ( z
= y2
- shift
; z
> y1
; z
-= 2 )
745 dc
.SetLogicalFunction(wxCOPY
);
748 void wxRendererGeneric::DrawChoice(wxWindow
* WXUNUSED(win
), wxDC
& WXUNUSED(dc
),
749 const wxRect
& WXUNUSED(rect
), int WXUNUSED(flags
))
751 wxFAIL_MSG("UNIMPLEMENTED: wxRendererGeneric::DrawChoice");
754 void wxRendererGeneric::DrawComboBox(wxWindow
* WXUNUSED(win
), wxDC
& WXUNUSED(dc
),
755 const wxRect
& WXUNUSED(rect
), int WXUNUSED(flags
))
757 wxFAIL_MSG("UNIMPLEMENTED: wxRendererGeneric::DrawComboBox");
760 void wxRendererGeneric::DrawRadioBitmap(wxWindow
* WXUNUSED(win
), wxDC
& WXUNUSED(dc
),
761 const wxRect
& WXUNUSED(rect
), int WXUNUSED(flags
))
763 wxFAIL_MSG("UNIMPLEMENTED: wxRendererGeneric::DrawRadioBitmap");
766 void wxRendererGeneric::DrawTextCtrl(wxWindow
* WXUNUSED(win
), wxDC
& WXUNUSED(dc
),
767 const wxRect
& WXUNUSED(rect
), int WXUNUSED(flags
))
769 wxFAIL_MSG("UNIMPLEMENTED: wxRendererGeneric::DrawTextCtrl");
772 #ifdef wxHAS_DRAW_TITLE_BAR_BITMAP
774 void wxRendererGeneric::DrawTitleBarBitmap(wxWindow
* WXUNUSED(win
),
776 const wxRect
& WXUNUSED(rect
),
777 wxTitleBarButton
WXUNUSED(button
),
780 // no need to fail here, if wxHAS_DRAW_TITLE_BAR_BITMAP is defined this
781 // will be implemented in the native renderer and this version is never
782 // going to be used -- but we still need to define it to allow
783 // instantiation of this class (which would have been pure virtual
787 #endif // wxHAS_DRAW_TITLE_BAR_BITMAP
790 // ----------------------------------------------------------------------------
791 // A module to allow cleanup of generic renderer.
792 // ----------------------------------------------------------------------------
794 class wxGenericRendererModule
: public wxModule
796 DECLARE_DYNAMIC_CLASS(wxGenericRendererModule
)
798 wxGenericRendererModule() {}
799 bool OnInit() { return true; }
800 void OnExit() { wxRendererGeneric::Cleanup(); }
803 IMPLEMENT_DYNAMIC_CLASS(wxGenericRendererModule
, wxModule
)