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 dc
.DrawPolygon( 3, triPt
, ar
.x
, ar
.y
);
333 labelWidth
+= arrowSpace
;
335 const int margin
= 5; // number of pixels to reserve on either side of the label
338 if ( params
&& params
->m_labelBitmap
.Ok() )
339 bmpWidth
= params
->m_labelBitmap
.GetWidth() + 2;
341 labelWidth
+= bmpWidth
+ 2*margin
;
343 // draw the bitmap if there is one
344 if ( params
&& params
->m_labelBitmap
.Ok() )
347 w
= params
->m_labelBitmap
.GetWidth();
348 h
= params
->m_labelBitmap
.GetHeight();
351 y
= rect
.y
+ wxMax(1, (rect
.height
- h
) / 2);
353 if (params
->m_labelText
.empty())
355 // use the alignment flags
356 switch (params
->m_labelAlignment
)
363 x
= rect
.x
+ wxMax(1, (rect
.width
- arrowSpace
- w
)/2);
366 x
= rect
.x
+ wxMax(1, rect
.width
- arrowSpace
- margin
- w
);
370 dc
.DrawBitmap(params
->m_labelBitmap
, x
, y
, true);
373 // Draw a label if one is given
374 if ( params
&& !params
->m_labelText
.empty() )
376 wxFont font
= params
->m_labelFont
.Ok() ?
377 params
->m_labelFont
: win
->GetFont();
378 wxColour clr
= params
->m_labelColour
.Ok() ?
379 params
->m_labelColour
: win
->GetForegroundColour();
381 wxString
label( params
->m_labelText
);
384 dc
.SetTextForeground(clr
);
385 dc
.SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT
);
387 int tw
, th
, td
, x
, y
;
388 dc
.GetTextExtent( label
, &tw
, &th
, &td
);
390 y
= rect
.y
+ wxMax(0, (rect
.height
- (th
+td
)) / 2);
392 // truncate and add an ellipsis (...) if the text is too wide.
393 int targetWidth
= rect
.width
- arrowSpace
- bmpWidth
- 2*margin
;
394 if ( tw
> targetWidth
)
397 dc
.GetTextExtent( wxT("..."), &ellipsisWidth
, NULL
);
399 label
.Truncate( label
.length() - 1 );
400 dc
.GetTextExtent( label
, &tw
, &th
);
401 } while (tw
+ ellipsisWidth
> targetWidth
&& label
.length() );
402 label
.append( wxT("...") );
406 switch (params
->m_labelAlignment
)
413 x
= rect
.x
+ wxMax(0, (rect
.width
- arrowSpace
- tw
- bmpWidth
)/2);
416 x
= rect
.x
+ wxMax(0, rect
.width
- arrowSpace
- margin
- tw
- bmpWidth
);
420 dc
.DrawText(label
, x
+ bmpWidth
, y
);
426 int wxRendererGeneric
::GetHeaderButtonHeight(wxWindow
*win
)
428 // Copied and adapted from src/generic/listctrl.cpp
429 const int HEADER_OFFSET_Y
= 1;
430 const int EXTRA_HEIGHT
= 4;
434 win
->GetTextExtent(wxT("Hg"), &w
, &h
, &d
);
436 return h
+ d
+ 2 * HEADER_OFFSET_Y
+ EXTRA_HEIGHT
;
440 // draw the plus or minus sign
442 wxRendererGeneric
::DrawTreeItemButton(wxWindow
* WXUNUSED(win
),
448 wxDCPenChanger
penChanger(dc
, *wxGREY_PEN
);
449 wxDCBrushChanger
brushChanger(dc
, *wxWHITE_BRUSH
);
451 dc
.DrawRectangle(rect
);
454 const wxCoord xMiddle
= rect
.x
+ rect
.width
/2;
455 const wxCoord yMiddle
= rect
.y
+ rect
.height
/2;
457 // half of the length of the horz lines in "-" and "+"
458 const wxCoord halfWidth
= rect
.width
/2 - 2;
459 dc
.SetPen(*wxBLACK_PEN
);
460 dc
.DrawLine(xMiddle
- halfWidth
, yMiddle
,
461 xMiddle
+ halfWidth
+ 1, yMiddle
);
463 if ( !(flags
& wxCONTROL_EXPANDED
) )
466 const wxCoord halfHeight
= rect
.height
/2 - 2;
467 dc
.DrawLine(xMiddle
, yMiddle
- halfHeight
,
468 xMiddle
, yMiddle
+ halfHeight
+ 1);
472 // ----------------------------------------------------------------------------
474 // ----------------------------------------------------------------------------
476 wxSplitterRenderParams
477 wxRendererGeneric
::GetSplitterParams(const wxWindow
*win
)
483 if ( win
->HasFlag(wxSP_3DSASH
) )
485 else if ( win
->HasFlag(wxSP_NOSASH
) )
490 if ( win
->HasFlag(wxSP_3DBORDER
) )
495 return wxSplitterRenderParams(sashWidth
, border
, false);
499 wxRendererGeneric
::DrawSplitterBorder(wxWindow
*win
,
501 const wxRect
& rectOrig
,
504 if ( win
->HasFlag(wxSP_3DBORDER
) )
506 wxRect rect
= rectOrig
;
507 DrawShadedRect(dc
, &rect
, m_penDarkGrey
, m_penHighlight
);
508 DrawShadedRect(dc
, &rect
, m_penBlack
, m_penLightGrey
);
513 wxRendererGeneric
::DrawSplitterSash(wxWindow
*win
,
515 const wxSize
& sizeReal
,
517 wxOrientation orient
,
520 // to avoid duplicating the same code for horizontal and vertical sashes,
521 // simply mirror the DC instead if needed (i.e. if horz splitter)
522 wxMirrorDC
dc(dcReal
, orient
!= wxVERTICAL
);
523 wxSize size
= dc
.Reflect(sizeReal
);
526 // we draw a Win32-like grey sash with possible 3D border here:
528 // ---- this is position
533 // GWGGGDB where G is light grey (face)
534 // GWGGGDB W white (light)
535 // GWGGGDB D dark grey (shadow)
536 // GWGGGDB B black (dark shadow)
538 // GWGGGDB and lower letters are our border (already drawn)
542 // only the middle 3 columns are drawn unless wxSP_3D is specified
544 const wxCoord h
= size
.y
;
547 // If we're drawing the border, draw the sash 3d lines shorter
548 if ( win
->HasFlag(wxSP_3DBORDER
) )
553 dc
.SetPen(*wxTRANSPARENT_PEN
);
554 dc
.SetBrush(wxBrush(wxSystemSettings
::GetColour(wxSYS_COLOUR_3DFACE
)));
556 if ( win
->HasFlag(wxSP_3DSASH
) )
559 dc
.DrawRectangle(position
+ 2, 0, 3, h
);
561 dc
.SetPen(m_penLightGrey
);
562 dc
.DrawLine(position
, offset
, position
, h
- offset
);
564 dc
.SetPen(m_penHighlight
);
565 dc
.DrawLine(position
+ 1, 0, position
+ 1, h
);
567 dc
.SetPen(m_penDarkGrey
);
568 dc
.DrawLine(position
+ 5, 0, position
+ 5, h
);
570 dc
.SetPen(m_penBlack
);
571 dc
.DrawLine(position
+ 6, offset
, position
+ 6, h
- offset
);
576 dc
.DrawRectangle(position
, 0, 3, h
);
580 // ----------------------------------------------------------------------------
582 // ----------------------------------------------------------------------------
585 wxRendererGeneric
::DrawComboBoxDropButton(wxWindow
*win
,
590 DrawPushButton(win
,dc
,rect
,flags
);
591 DrawDropArrow(win
,dc
,rect
,flags
);
595 wxRendererGeneric
::DrawDropArrow(wxWindow
*win
,
600 // This generic implementation should be good
601 // enough for Windows platforms (including XP).
603 int arrowHalf
= rect
.width
/5;
604 int rectMid
= rect
.width
/ 2;
605 int arrowTopY
= (rect
.height
/2) - (arrowHalf
/2);
607 // This should always result in arrow with odd width.
610 wxPoint(rectMid
- arrowHalf
, arrowTopY
),
611 wxPoint(rectMid
+ arrowHalf
, arrowTopY
),
612 wxPoint(rectMid
, arrowTopY
+ arrowHalf
)
614 dc
.SetBrush(wxBrush(win
->GetForegroundColour()));
615 dc
.SetPen(wxPen(win
->GetForegroundColour()));
616 dc
.DrawPolygon(WXSIZEOF(pt
), pt
, rect
.x
, rect
.y
);
620 wxRendererGeneric
::DrawCheckBox(wxWindow
*WXUNUSED(win
),
625 dc
.SetPen(*(flags
& wxCONTROL_DISABLED ? wxGREY_PEN
: wxBLACK_PEN
));
626 dc
.SetBrush( *wxTRANSPARENT_BRUSH
);
627 dc
.DrawRectangle(rect
);
629 if ( flags
& wxCONTROL_CHECKED
)
631 dc
.DrawCheckMark(rect
.Deflate(2, 2));
635 wxSize wxRendererGeneric
::GetCheckBoxSize(wxWindow
*WXUNUSED(win
))
637 return wxSize(16, 16);
641 wxRendererGeneric
::DrawPushButton(wxWindow
*win
,
646 // Don't try anything too fancy. It'll just turn out looking
647 // out-of-place on most platforms.
648 wxColour bgCol
= flags
& wxCONTROL_DISABLED ?
649 wxSystemSettings
::GetColour(wxSYS_COLOUR_BTNFACE
) :
650 win
->GetBackgroundColour();
651 dc
.SetBrush(wxBrush(bgCol
));
652 dc
.SetPen(wxPen(bgCol
));
653 dc
.DrawRectangle(rect
);
657 wxRendererGeneric
::DrawItemSelectionRect(wxWindow
* win
,
663 if ( flags
& wxCONTROL_SELECTED
)
665 if ( flags
& wxCONTROL_FOCUSED
)
667 brush
= wxBrush(wxSystemSettings
::GetColour(wxSYS_COLOUR_HIGHLIGHT
));
671 brush
= wxBrush(wxSystemSettings
::GetColour(wxSYS_COLOUR_BTNSHADOW
));
676 brush
= *wxTRANSPARENT_BRUSH
;
680 if ((flags
& wxCONTROL_CURRENT
) && (flags
& wxCONTROL_FOCUSED
)
681 #if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__) && wxOSX_USE_CARBON
682 && IsControlActive( (ControlRef
)win
->GetHandle() )
685 dc
.SetPen( *wxBLACK_PEN
);
687 dc
.SetPen( *wxTRANSPARENT_PEN
);
689 dc
.DrawRectangle( rect
);
691 // it's unused everywhere except in wxOSX/Carbon
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
))
740 wxFAIL_MSG("UNIMPLEMENTED: wxRendererGeneric::DrawChoice");
743 void wxRendererGeneric
::DrawComboBox(wxWindow
* WXUNUSED(win
), wxDC
& WXUNUSED(dc
),
744 const wxRect
& WXUNUSED(rect
), int WXUNUSED(flags
))
746 wxFAIL_MSG("UNIMPLEMENTED: wxRendererGeneric::DrawComboBox");
749 void wxRendererGeneric
::DrawRadioBitmap(wxWindow
* WXUNUSED(win
), wxDC
& WXUNUSED(dc
),
750 const wxRect
& WXUNUSED(rect
), int WXUNUSED(flags
))
752 wxFAIL_MSG("UNIMPLEMENTED: wxRendererGeneric::DrawRadioBitmap");
755 void wxRendererGeneric
::DrawTextCtrl(wxWindow
* WXUNUSED(win
), wxDC
& WXUNUSED(dc
),
756 const wxRect
& WXUNUSED(rect
), int WXUNUSED(flags
))
758 wxFAIL_MSG("UNIMPLEMENTED: wxRendererGeneric::DrawTextCtrl");
761 #ifdef wxHAS_DRAW_TITLE_BAR_BITMAP
763 void wxRendererGeneric
::DrawTitleBarBitmap(wxWindow
* WXUNUSED(win
),
765 const wxRect
& WXUNUSED(rect
),
766 wxTitleBarButton
WXUNUSED(button
),
769 // no need to fail here, if wxHAS_DRAW_TITLE_BAR_BITMAP is defined this
770 // will be implemented in the native renderer and this version is never
771 // going to be used -- but we still need to define it to allow
772 // instantiation of this class (which would have been pure virtual
776 #endif // wxHAS_DRAW_TITLE_BAR_BITMAP
779 // ----------------------------------------------------------------------------
780 // A module to allow cleanup of generic renderer.
781 // ----------------------------------------------------------------------------
783 class wxGenericRendererModule
: public wxModule
785 DECLARE_DYNAMIC_CLASS(wxGenericRendererModule
)
787 wxGenericRendererModule() {}
788 bool OnInit() { return true; }
789 void OnExit() { wxRendererGeneric
::Cleanup(); }
792 IMPLEMENT_DYNAMIC_CLASS(wxGenericRendererModule
, wxModule
)