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 DrawRadioButton(wxWindow
* win
, wxDC
& dc
, const wxRect
& rect
, int flags
=0);
123 virtual wxSplitterRenderParams
GetSplitterParams(const wxWindow
*win
);
125 virtual wxRendererVersion
GetVersion() const
127 return wxRendererVersion(wxRendererVersion::Current_Version
,
128 wxRendererVersion::Current_Age
);
132 // Cleanup by deleting standard renderer
133 static void Cleanup();
135 // Get the generic object
136 static wxRendererGeneric
* DoGetGeneric();
139 // draw the rectange using the first pen for the left and top sides and
140 // the second one for the bottom and right ones
141 void DrawShadedRect(wxDC
& dc
, wxRect
*rect
,
142 const wxPen
& pen1
, const wxPen
& pen2
);
150 static wxRendererGeneric
* sm_rendererGeneric
;
153 // ============================================================================
154 // wxRendererGeneric implementation
155 // ============================================================================
157 // Get the generic object
158 wxRendererGeneric
* wxRendererGeneric::DoGetGeneric()
160 if (!sm_rendererGeneric
)
161 sm_rendererGeneric
= new wxRendererGeneric
;
162 return sm_rendererGeneric
;
165 // ----------------------------------------------------------------------------
166 // wxRendererGeneric creation
167 // ----------------------------------------------------------------------------
170 wxRendererNative
& wxRendererNative::GetGeneric()
172 return * wxRendererGeneric::DoGetGeneric();
175 void wxRendererGeneric::Cleanup()
177 if (sm_rendererGeneric
)
178 delete sm_rendererGeneric
;
180 sm_rendererGeneric
= NULL
;
183 wxRendererGeneric
* wxRendererGeneric::sm_rendererGeneric
= NULL
;
185 wxRendererGeneric::wxRendererGeneric()
186 : m_penBlack(wxSystemSettings::GetColour(wxSYS_COLOUR_3DDKSHADOW
)),
187 m_penDarkGrey(wxSystemSettings::GetColour(wxSYS_COLOUR_3DSHADOW
)),
188 m_penLightGrey(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
)),
189 m_penHighlight(wxSystemSettings::GetColour(wxSYS_COLOUR_3DHIGHLIGHT
))
193 // ----------------------------------------------------------------------------
194 // wxRendererGeneric helpers
195 // ----------------------------------------------------------------------------
198 wxRendererGeneric::DrawShadedRect(wxDC
& dc
,
203 // draw the rectangle
205 dc
.DrawLine(rect
->GetLeft(), rect
->GetTop(),
206 rect
->GetLeft(), rect
->GetBottom());
207 dc
.DrawLine(rect
->GetLeft() + 1, rect
->GetTop(),
208 rect
->GetRight(), rect
->GetTop());
210 dc
.DrawLine(rect
->GetRight(), rect
->GetTop(),
211 rect
->GetRight(), rect
->GetBottom());
212 dc
.DrawLine(rect
->GetLeft(), rect
->GetBottom(),
213 rect
->GetRight() + 1, rect
->GetBottom());
219 // ----------------------------------------------------------------------------
220 // tree/list ctrl drawing
221 // ----------------------------------------------------------------------------
224 wxRendererGeneric::DrawHeaderButton(wxWindow
* win
,
228 wxHeaderSortIconType sortArrow
,
229 wxHeaderButtonParams
* params
)
231 const wxCoord x
= rect
.x
,
236 dc
.SetBrush(wxBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
)));
237 dc
.SetPen(*wxTRANSPARENT_PEN
);
238 dc
.DrawRectangle(rect
);
240 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
242 dc
.SetPen(m_penBlack
);
243 dc
.DrawLine( x
+w
-1, y
, x
+w
-1, y
+h
); // right (outer)
244 dc
.DrawLine( x
, y
+h
-1, x
+w
, y
+h
-1 ); // bottom (outer)
246 dc
.SetPen(m_penDarkGrey
);
247 dc
.DrawLine( x
+w
-2, y
+1, x
+w
-2, y
+h
-1 ); // right (inner)
248 dc
.DrawLine( x
+1, y
+h
-2, x
+w
-1, y
+h
-2 ); // bottom (inner)
250 dc
.SetPen(m_penHighlight
);
251 dc
.DrawLine( x
, y
, x
, y
+h
-1 ); // left (outer)
252 dc
.DrawLine( x
, y
, x
+w
-1, y
); // top (outer)
254 return DrawHeaderButtonContents(win
, dc
, rect
, flags
, sortArrow
, params
);
259 wxRendererGeneric::DrawHeaderButtonContents(wxWindow
*win
,
263 wxHeaderSortIconType sortArrow
,
264 wxHeaderButtonParams
* params
)
268 // Mark this item as selected. For the generic version we'll just draw an
270 if ( flags
& wxCONTROL_SELECTED
)
272 // draw a line at the bottom of the header button, overlaying the
273 // native hot-tracking line (on XP)
274 const int penwidth
= 3;
275 int y
= rect
.y
+ rect
.height
+ 1 - penwidth
;
276 wxColour c
= (params
&& params
->m_selectionColour
.Ok()) ?
277 params
->m_selectionColour
: wxColour(0x66, 0x66, 0x66);
278 wxPen
pen(c
, penwidth
);
279 pen
.SetCap(wxCAP_BUTT
);
281 dc
.DrawLine(rect
.x
, y
, rect
.x
+ rect
.width
, y
);
284 // Draw an up or down arrow
286 if (sortArrow
!= wxHDR_SORT_ICON_NONE
)
290 // make a rect for the arrow
293 ar
.y
+= (rect
.height
- ar
.height
)/2;
294 ar
.x
= ar
.x
+ rect
.width
- 3*ar
.width
/2;
295 arrowSpace
= 3*ar
.width
/2; // space to preserve when drawing the label
298 if ( sortArrow
& wxHDR_SORT_ICON_UP
)
300 triPt
[0].x
= ar
.width
/ 2;
302 triPt
[1].x
= ar
.width
;
303 triPt
[1].y
= ar
.height
;
305 triPt
[2].y
= ar
.height
;
311 triPt
[1].x
= ar
.width
;
313 triPt
[2].x
= ar
.width
/ 2;
314 triPt
[2].y
= ar
.height
;
317 wxColour c
= (params
&& params
->m_arrowColour
.Ok()) ?
318 params
->m_arrowColour
: wxSystemSettings::GetColour(wxSYS_COLOUR_3DSHADOW
);
320 dc
.SetBrush(wxBrush(c
));
321 dc
.DrawPolygon( 3, triPt
, ar
.x
, ar
.y
);
323 labelWidth
+= arrowSpace
;
325 const int margin
= 5; // number of pixels to reserve on either side of the label
329 if ( params
&& params
->m_labelBitmap
.Ok() )
330 bmpWidth
= params
->m_labelBitmap
.GetWidth() + 2;
332 labelWidth
+= bmpWidth
+ 2*margin
;
334 // Draw a label if one is given
335 if ( params
&& !params
->m_labelText
.empty() )
337 wxFont font
= params
->m_labelFont
.Ok() ?
338 params
->m_labelFont
: win
->GetFont();
339 wxColour clr
= params
->m_labelColour
.Ok() ?
340 params
->m_labelColour
: win
->GetForegroundColour();
342 wxString
label( params
->m_labelText
);
345 dc
.SetTextForeground(clr
);
346 dc
.SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT
);
348 int tw
, th
, td
, x
, y
;
349 dc
.GetTextExtent( label
, &tw
, &th
, &td
);
351 y
= rect
.y
+ wxMax(0, (rect
.height
- (th
+td
)) / 2);
353 // truncate and add an ellipsis (...) if the text is too wide.
354 int targetWidth
= rect
.width
- arrowSpace
- bmpWidth
- 2*margin
;
355 if ( tw
> targetWidth
)
358 dc
.GetTextExtent( wxT("..."), &ellipsisWidth
, NULL
);
360 label
.Truncate( label
.length() - 1 );
361 dc
.GetTextExtent( label
, &tw
, &th
);
362 } while (tw
+ ellipsisWidth
> targetWidth
&& label
.length() );
363 label
.append( wxT("...") );
367 switch (params
->m_labelAlignment
)
374 x
= rect
.x
+ wxMax(0, (rect
.width
- arrowSpace
- tw
- bmpWidth
)/2);
377 x
= rect
.x
+ wxMax(0, rect
.width
- arrowSpace
- margin
- tw
- bmpWidth
);
381 dc
.DrawText(label
, x
, y
);
385 // draw the bitmap if there is one
386 if ( params
&& params
->m_labelBitmap
.Ok() )
389 w
= params
->m_labelBitmap
.GetWidth();
390 h
= params
->m_labelBitmap
.GetHeight();
392 y
= rect
.y
+ wxMax(1, (rect
.height
- h
) / 2);
394 // if there is a text label, then put the bitmap at the end of the label
399 // otherwise use the alignment flags
402 switch (params
->m_labelAlignment
)
409 x
= rect
.x
+ wxMax(1, (rect
.width
- arrowSpace
- w
)/2);
412 x
= rect
.x
+ wxMax(1, rect
.width
- arrowSpace
- margin
- w
);
416 dc
.DrawBitmap(params
->m_labelBitmap
, x
, y
, true);
422 int wxRendererGeneric::GetHeaderButtonHeight(wxWindow
*win
)
424 // Copied and adapted from src/generic/listctrl.cpp
425 const int HEADER_OFFSET_Y
= 1;
426 const int EXTRA_HEIGHT
= 4;
430 win
->GetTextExtent(wxT("Hg"), &w
, &h
, &d
);
432 return h
+ d
+ 2 * HEADER_OFFSET_Y
+ EXTRA_HEIGHT
;
436 // draw the plus or minus sign
438 wxRendererGeneric::DrawTreeItemButton(wxWindow
* WXUNUSED(win
),
444 wxDCPenChanger
penChanger(dc
, *wxGREY_PEN
);
445 wxDCBrushChanger
brushChanger(dc
, *wxWHITE_BRUSH
);
447 dc
.DrawRectangle(rect
);
450 const wxCoord xMiddle
= rect
.x
+ rect
.width
/2;
451 const wxCoord yMiddle
= rect
.y
+ rect
.height
/2;
453 // half of the length of the horz lines in "-" and "+"
454 const wxCoord halfWidth
= rect
.width
/2 - 2;
455 dc
.SetPen(*wxBLACK_PEN
);
456 dc
.DrawLine(xMiddle
- halfWidth
, yMiddle
,
457 xMiddle
+ halfWidth
+ 1, yMiddle
);
459 if ( !(flags
& wxCONTROL_EXPANDED
) )
462 const wxCoord halfHeight
= rect
.height
/2 - 2;
463 dc
.DrawLine(xMiddle
, yMiddle
- halfHeight
,
464 xMiddle
, yMiddle
+ halfHeight
+ 1);
468 // ----------------------------------------------------------------------------
470 // ----------------------------------------------------------------------------
472 wxSplitterRenderParams
473 wxRendererGeneric::GetSplitterParams(const wxWindow
*win
)
479 if ( win
->HasFlag(wxSP_3DSASH
) )
481 else if ( win
->HasFlag(wxSP_NOSASH
) )
486 if ( win
->HasFlag(wxSP_3DBORDER
) )
491 return wxSplitterRenderParams(sashWidth
, border
, false);
495 wxRendererGeneric::DrawSplitterBorder(wxWindow
*win
,
497 const wxRect
& rectOrig
,
500 if ( win
->HasFlag(wxSP_3DBORDER
) )
502 wxRect rect
= rectOrig
;
503 DrawShadedRect(dc
, &rect
, m_penDarkGrey
, m_penHighlight
);
504 DrawShadedRect(dc
, &rect
, m_penBlack
, m_penLightGrey
);
509 wxRendererGeneric::DrawSplitterSash(wxWindow
*win
,
511 const wxSize
& sizeReal
,
513 wxOrientation orient
,
516 // to avoid duplicating the same code for horizontal and vertical sashes,
517 // simply mirror the DC instead if needed (i.e. if horz splitter)
518 wxMirrorDC
dc(dcReal
, orient
!= wxVERTICAL
);
519 wxSize size
= dc
.Reflect(sizeReal
);
522 // we draw a Win32-like grey sash with possible 3D border here:
524 // ---- this is position
529 // GWGGGDB where G is light grey (face)
530 // GWGGGDB W white (light)
531 // GWGGGDB D dark grey (shadow)
532 // GWGGGDB B black (dark shadow)
534 // GWGGGDB and lower letters are our border (already drawn)
538 // only the middle 3 columns are drawn unless wxSP_3D is specified
540 const wxCoord h
= size
.y
;
543 // If we're drawing the border, draw the sash 3d lines shorter
544 if ( win
->HasFlag(wxSP_3DBORDER
) )
549 dc
.SetPen(*wxTRANSPARENT_PEN
);
550 dc
.SetBrush(wxBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
)));
552 if ( win
->HasFlag(wxSP_3DSASH
) )
555 dc
.DrawRectangle(position
+ 2, 0, 3, h
);
557 dc
.SetPen(m_penLightGrey
);
558 dc
.DrawLine(position
, offset
, position
, h
- offset
);
560 dc
.SetPen(m_penHighlight
);
561 dc
.DrawLine(position
+ 1, 0, position
+ 1, h
);
563 dc
.SetPen(m_penDarkGrey
);
564 dc
.DrawLine(position
+ 5, 0, position
+ 5, h
);
566 dc
.SetPen(m_penBlack
);
567 dc
.DrawLine(position
+ 6, offset
, position
+ 6, h
- offset
);
572 dc
.DrawRectangle(position
, 0, 3, h
);
576 // ----------------------------------------------------------------------------
578 // ----------------------------------------------------------------------------
581 wxRendererGeneric::DrawComboBoxDropButton(wxWindow
*win
,
586 DrawPushButton(win
,dc
,rect
,flags
);
587 DrawDropArrow(win
,dc
,rect
,flags
);
591 wxRendererGeneric::DrawDropArrow(wxWindow
*win
,
596 // This generic implementation should be good
597 // enough for Windows platforms (including XP).
599 int arrowHalf
= rect
.width
/5;
600 int rectMid
= rect
.width
/ 2;
601 int arrowTopY
= (rect
.height
/2) - (arrowHalf
/2);
603 // This should always result in arrow with odd width.
606 wxPoint(rectMid
- arrowHalf
, arrowTopY
),
607 wxPoint(rectMid
+ arrowHalf
, arrowTopY
),
608 wxPoint(rectMid
, arrowTopY
+ arrowHalf
)
610 dc
.SetBrush(wxBrush(win
->GetForegroundColour()));
611 dc
.SetPen(wxPen(win
->GetForegroundColour()));
612 dc
.DrawPolygon(WXSIZEOF(pt
), pt
, rect
.x
, rect
.y
);
616 wxRendererGeneric::DrawCheckBox(wxWindow
*WXUNUSED(win
),
621 dc
.SetPen(*(flags
& wxCONTROL_DISABLED
? wxGREY_PEN
: wxBLACK_PEN
));
622 dc
.SetBrush( *wxTRANSPARENT_BRUSH
);
623 dc
.DrawRectangle(rect
);
625 if ( flags
& wxCONTROL_CHECKED
)
627 dc
.DrawCheckMark(rect
.Deflate(2, 2));
631 wxSize
wxRendererGeneric::GetCheckBoxSize(wxWindow
*WXUNUSED(win
))
633 return wxSize(16, 16);
637 wxRendererGeneric::DrawPushButton(wxWindow
*win
,
642 // Don't try anything too fancy. It'll just turn out looking
643 // out-of-place on most platforms.
644 wxColour bgCol
= flags
& wxCONTROL_DISABLED
?
645 wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE
) :
646 win
->GetBackgroundColour();
647 dc
.SetBrush(wxBrush(bgCol
));
648 dc
.SetPen(wxPen(bgCol
));
649 dc
.DrawRectangle(rect
);
654 wxRendererGeneric::DrawItemSelectionRect(wxWindow
* win
,
659 wxRendererGeneric::DrawItemSelectionRect(wxWindow
* WXUNUSED(win
),
666 if ( flags
& wxCONTROL_SELECTED
)
668 if ( flags
& wxCONTROL_FOCUSED
)
670 brush
= wxBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT
));
674 brush
= wxBrush(wxSystemSettings::GetColour(wxSYS_COLOUR_BTNSHADOW
));
679 brush
= *wxTRANSPARENT_BRUSH
;
683 if ((flags
& wxCONTROL_CURRENT
) && (flags
& wxCONTROL_FOCUSED
)
684 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__) && wxOSX_USE_CARBON
685 && IsControlActive( (ControlRef
)win
->GetHandle() )
688 dc
.SetPen( *wxBLACK_PEN
);
690 dc
.SetPen( *wxTRANSPARENT_PEN
);
692 dc
.DrawRectangle( rect
);
696 wxRendererGeneric::DrawFocusRect(wxWindow
* WXUNUSED(win
), wxDC
& dc
, const wxRect
& rect
, int WXUNUSED(flags
))
698 // draw the pixels manually because the "dots" in wxPen with wxDOT style
699 // may be short traits and not really dots
701 // note that to behave in the same manner as DrawRect(), we must exclude
702 // the bottom and right borders from the rectangle
703 wxCoord x1
= rect
.GetLeft(),
705 x2
= rect
.GetRight(),
706 y2
= rect
.GetBottom();
708 dc
.SetPen(m_penBlack
);
711 dc
.SetLogicalFunction(wxCOPY
);
713 // this seems to be closer than what Windows does than wxINVERT although
714 // I'm still not sure if it's correct
715 dc
.SetLogicalFunction(wxAND_REVERSE
);
719 for ( z
= x1
+ 1; z
< x2
; z
+= 2 )
720 dc
.DrawPoint(z
, rect
.GetTop());
722 wxCoord shift
= z
== x2
? 0 : 1;
723 for ( z
= y1
+ shift
; z
< y2
; z
+= 2 )
726 shift
= z
== y2
? 0 : 1;
727 for ( z
= x2
- shift
; z
> x1
; z
-= 2 )
730 shift
= z
== x1
? 0 : 1;
731 for ( z
= y2
- shift
; z
> y1
; z
-= 2 )
734 dc
.SetLogicalFunction(wxCOPY
);
737 void wxRendererGeneric::DrawChoice(wxWindow
* WXUNUSED(win
), wxDC
& WXUNUSED(dc
),
738 const wxRect
& WXUNUSED(rect
), int WXUNUSED(flags
))
743 void wxRendererGeneric::DrawComboBox(wxWindow
* WXUNUSED(win
), wxDC
& WXUNUSED(dc
),
744 const wxRect
& WXUNUSED(rect
), int WXUNUSED(flags
))
749 void wxRendererGeneric::DrawRadioButton(wxWindow
* WXUNUSED(win
), wxDC
& WXUNUSED(dc
),
750 const wxRect
& WXUNUSED(rect
), int WXUNUSED(flags
))
755 void wxRendererGeneric::DrawTextCtrl(wxWindow
* WXUNUSED(win
), wxDC
& WXUNUSED(dc
),
756 const wxRect
& WXUNUSED(rect
), int WXUNUSED(flags
))
764 // ----------------------------------------------------------------------------
765 // A module to allow cleanup of generic renderer.
766 // ----------------------------------------------------------------------------
768 class wxGenericRendererModule
: public wxModule
770 DECLARE_DYNAMIC_CLASS(wxGenericRendererModule
)
772 wxGenericRendererModule() {}
773 bool OnInit() { return true; }
774 void OnExit() { wxRendererGeneric::Cleanup(); }
777 IMPLEMENT_DYNAMIC_CLASS(wxGenericRendererModule
, wxModule
)