Return optimal label width from DrawHeaderButton

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@43726 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2006-11-30 23:44:55 +00:00
parent 3706bae03e
commit c97c995223
8 changed files with 55 additions and 45 deletions

View File

@@ -131,16 +131,19 @@ rectangle of a drop down button which arrow matches the size you need.
\membersection{wxRendererNative::DrawHeaderButton}\label{wxrenderernativedrawheaderbutton} \membersection{wxRendererNative::DrawHeaderButton}\label{wxrenderernativedrawheaderbutton}
\func{void}{DrawHeaderButton}{\param{wxWindow* }{win}, \param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{int }{flags = 0}, \param{wxHeaderSortIconType }{sortArrow = wxHDR\_SORT\_ICON\_NONE}, \param{wxHeaderButtonParams* }{params = NULL}} \func{int}{DrawHeaderButton}{\param{wxWindow* }{win}, \param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{int }{flags = 0}, \param{wxHeaderSortIconType }{sortArrow = wxHDR\_SORT\_ICON\_NONE}, \param{wxHeaderButtonParams* }{params = NULL}}
Draw the header control button (used, for example, by Draw the header control button (used, for example, by
\helpref{wxListCtrl}{wxlistctrl}). Depending on platforms the \helpref{wxListCtrl}{wxlistctrl}). Depending on platforms the
\arg{flags} parameter may support the \texttt{wxCONTROL\_SELECTED} \arg{flags} parameter may support the \texttt{wxCONTROL\_SELECTED}
\texttt{wxCONTROL\_DISABLED} and \texttt{wxCONTROL\_CURRENT} bits. \texttt{wxCONTROL\_DISABLED} and \texttt{wxCONTROL\_CURRENT} bits.
The \arg{sortArrow} parameter can be one of The \arg{sortArrow} parameter can be one of
\texttt{wxHDR\_SORT\_ICON\_NONE}, \texttt{wxHDR\_SORT\_ICON\_UP}, or \texttt{wxHDR\_SORT\_ICON\_NONE}, \texttt{wxHDR\_SORT\_ICON\_UP}, or
\texttt{wxHDR\_SORT\_ICON\_DOWN}. Additional values controlling the \texttt{wxHDR\_SORT\_ICON\_DOWN}. Additional values controlling the
drawing of a text or bitmap label can be passed in \arg{params}. drawing of a text or bitmap label can be passed in \arg{params}. The
value returned is the optimal width to contain the the unabreviated
label text or bitmap, the sort arrow if present, and internal margins.
\membersection{wxRendererNative::DrawItemSelectionRect}\label{wxrenderernativedrawitemselectionrect} \membersection{wxRendererNative::DrawItemSelectionRect}\label{wxrenderernativedrawitemselectionrect}

View File

@@ -157,8 +157,9 @@ public:
// drawing functions // drawing functions
// ----------------- // -----------------
// draw the header control button (used by wxListCtrl) // draw the header control button (used by wxListCtrl) Returns optimal
virtual void DrawHeaderButton(wxWindow *win, // width for the label contents.
virtual int DrawHeaderButton(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
@@ -168,7 +169,7 @@ public:
// Draw the contents of a header control button (label, sort arrows, etc.) // Draw the contents of a header control button (label, sort arrows, etc.)
// Normally only called by DrawHeaderButton. // Normally only called by DrawHeaderButton.
virtual void DrawHeaderButtonContents(wxWindow *win, virtual int DrawHeaderButtonContents(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
@@ -308,21 +309,21 @@ public:
: m_rendererNative(rendererNative) { } : m_rendererNative(rendererNative) { }
virtual void DrawHeaderButton(wxWindow *win, virtual int DrawHeaderButton(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE, wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
wxHeaderButtonParams* params = NULL) wxHeaderButtonParams* params = NULL)
{ m_rendererNative.DrawHeaderButton(win, dc, rect, flags, sortArrow, params); } { return m_rendererNative.DrawHeaderButton(win, dc, rect, flags, sortArrow, params); }
virtual void DrawHeaderButtonContents(wxWindow *win, virtual int DrawHeaderButtonContents(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE, wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
wxHeaderButtonParams* params = NULL) wxHeaderButtonParams* params = NULL)
{ m_rendererNative.DrawHeaderButtonContents(win, dc, rect, flags, sortArrow, params); } { return m_rendererNative.DrawHeaderButtonContents(win, dc, rect, flags, sortArrow, params); }
virtual int GetHeaderButtonHeight(wxWindow *win) virtual int GetHeaderButtonHeight(wxWindow *win)
{ return m_rendererNative.GetHeaderButtonHeight(win); } { return m_rendererNative.GetHeaderButtonHeight(win); }

View File

@@ -847,13 +847,13 @@ public:
int flags) const int flags) const
{ return m_renderer->HitTestFrame(rect, pt, flags); } { return m_renderer->HitTestFrame(rect, pt, flags); }
virtual void DrawHeaderButton(wxWindow *win, virtual int DrawHeaderButton(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
wxHeaderSortIconType sortIcon = wxHDR_SORT_ICON_NONE, wxHeaderSortIconType sortIcon = wxHDR_SORT_ICON_NONE,
wxHeaderButtonParams* params = NULL) wxHeaderButtonParams* params = NULL)
{ m_renderer->DrawHeaderButton(win, dc, rect, flags, sortIcon, params); } { return m_renderer->DrawHeaderButton(win, dc, rect, flags, sortIcon, params); }
virtual void DrawTreeItemButton(wxWindow *win, virtual void DrawTreeItemButton(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,

View File

@@ -46,14 +46,14 @@ class WXDLLEXPORT wxRendererGeneric : public wxRendererNative
public: public:
wxRendererGeneric(); wxRendererGeneric();
virtual void DrawHeaderButton(wxWindow *win, virtual int DrawHeaderButton(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE, wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
wxHeaderButtonParams* params = NULL); wxHeaderButtonParams* params = NULL);
virtual void DrawHeaderButtonContents(wxWindow *win, virtual int DrawHeaderButtonContents(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
@@ -204,7 +204,7 @@ wxRendererGeneric::DrawShadedRect(wxDC& dc,
// tree/list ctrl drawing // tree/list ctrl drawing
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
void int
wxRendererGeneric::DrawHeaderButton(wxWindow* win, wxRendererGeneric::DrawHeaderButton(wxWindow* win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
@@ -239,11 +239,11 @@ wxRendererGeneric::DrawHeaderButton(wxWindow* win,
dc.DrawLine( x, y+h-1, x+1, y+h-1 ); dc.DrawLine( x, y+h-1, x+1, y+h-1 );
dc.DrawLine( x+w-1, y, x+w-1, y+1 ); dc.DrawLine( x+w-1, y, x+w-1, y+1 );
DrawHeaderButtonContents(win, dc, rect, flags, sortArrow, params); return DrawHeaderButtonContents(win, dc, rect, flags, sortArrow, params);
} }
void int
wxRendererGeneric::DrawHeaderButtonContents(wxWindow *win, wxRendererGeneric::DrawHeaderButtonContents(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
@@ -251,6 +251,8 @@ wxRendererGeneric::DrawHeaderButtonContents(wxWindow *win,
wxHeaderSortIconType sortArrow, wxHeaderSortIconType sortArrow,
wxHeaderButtonParams* params) wxHeaderButtonParams* params)
{ {
int labelWidth = 0;
// Mark this item as selected. For the generic version we'll just draw an // Mark this item as selected. For the generic version we'll just draw an
// underline // underline
if ( flags & wxCONTROL_SELECTED ) if ( flags & wxCONTROL_SELECTED )
@@ -306,14 +308,17 @@ wxRendererGeneric::DrawHeaderButtonContents(wxWindow *win,
dc.SetBrush(wxBrush(c)); dc.SetBrush(wxBrush(c));
dc.DrawPolygon( 3, triPt, ar.x, ar.y); dc.DrawPolygon( 3, triPt, ar.x, ar.y);
} }
labelWidth += arrowSpace;
const int margin = 5; // number of pixels to reserve on either side of the label const int margin = 5; // number of pixels to reserve on either side of the label
int bmpWidth = 0; int bmpWidth = 0;
int txtEnd = 0; int txtEnd = 0;
if ( params && params->m_labelBitmap.Ok() ) if ( params && params->m_labelBitmap.Ok() )
bmpWidth = params->m_labelBitmap.GetWidth() + 2; bmpWidth = params->m_labelBitmap.GetWidth() + 2;
labelWidth += bmpWidth + 2*margin;
// Draw a label if one is given // Draw a label if one is given
if ( params && !params->m_labelText.empty() ) if ( params && !params->m_labelText.empty() )
{ {
@@ -330,8 +335,9 @@ wxRendererGeneric::DrawHeaderButtonContents(wxWindow *win,
int tw, th, td, x, y; int tw, th, td, x, y;
dc.GetTextExtent( label, &tw, &th, &td); dc.GetTextExtent( label, &tw, &th, &td);
labelWidth += tw;
y = rect.y + wxMax(0, (rect.height - (th+td)) / 2); y = rect.y + wxMax(0, (rect.height - (th+td)) / 2);
// truncate and add an ellipsis (...) if the text is too wide. // truncate and add an ellipsis (...) if the text is too wide.
int targetWidth = rect.width - arrowSpace - bmpWidth - 2*margin; int targetWidth = rect.width - arrowSpace - bmpWidth - 2*margin;
if ( tw > targetWidth ) if ( tw > targetWidth )
@@ -397,6 +403,7 @@ wxRendererGeneric::DrawHeaderButtonContents(wxWindow *win,
} }
dc.DrawBitmap(params->m_labelBitmap, x, y, true); dc.DrawBitmap(params->m_labelBitmap, x, y, true);
} }
return labelWidth;
} }

View File

@@ -43,7 +43,7 @@ class WXDLLEXPORT wxRendererGTK : public wxDelegateRendererNative
{ {
public: public:
// draw the header control button (used by wxListCtrl) // draw the header control button (used by wxListCtrl)
virtual void DrawHeaderButton(wxWindow *win, virtual int DrawHeaderButton(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
@@ -181,7 +181,7 @@ wxRendererGTK::GetTreeWidget()
// list/tree controls drawing // list/tree controls drawing
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
void int
wxRendererGTK::DrawHeaderButton(wxWindow *win, wxRendererGTK::DrawHeaderButton(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
@@ -212,7 +212,7 @@ wxRendererGTK::DrawHeaderButton(wxWindow *win,
dc.LogicalToDeviceX(rect.x) - x_diff, rect.y, rect.width, rect.height dc.LogicalToDeviceX(rect.x) - x_diff, rect.y, rect.width, rect.height
); );
DrawHeaderButtonContents(win, dc, rect, flags, sortArrow, params); return DrawHeaderButtonContents(win, dc, rect, flags, sortArrow, params);
} }
// draw a ">" or "v" button // draw a ">" or "v" button

View File

@@ -34,7 +34,7 @@ class WXDLLEXPORT wxRendererMac : public wxDelegateRendererNative
{ {
public: public:
// draw the header control button (used by wxListCtrl) // draw the header control button (used by wxListCtrl)
virtual void DrawHeaderButton( wxWindow *win, virtual int DrawHeaderButton( wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
@@ -97,7 +97,7 @@ wxRendererNative& wxRendererNative::GetDefault()
return s_rendererMac; return s_rendererMac;
} }
void wxRendererMac::DrawHeaderButton( wxWindow *win, int wxRendererMac::DrawHeaderButton( wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags, int flags,
@@ -200,7 +200,7 @@ void wxRendererMac::DrawHeaderButton( wxWindow *win,
} }
flags &= ~wxCONTROL_SELECTED; flags &= ~wxCONTROL_SELECTED;
DrawHeaderButtonContents(win, dc, newRect, flags, sortArrow, params); return DrawHeaderButtonContents(win, dc, newRect, flags, sortArrow, params);
} }

View File

@@ -118,7 +118,7 @@ public:
static wxRendererNative& Get(); static wxRendererNative& Get();
virtual void DrawHeaderButton(wxWindow *win, virtual int DrawHeaderButton(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
@@ -290,7 +290,7 @@ wxRendererXP::DrawComboBoxDropButton(wxWindow * win,
} }
void int
wxRendererXP::DrawHeaderButton(wxWindow *win, wxRendererXP::DrawHeaderButton(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
@@ -301,8 +301,7 @@ wxRendererXP::DrawHeaderButton(wxWindow *win,
wxUxThemeHandle hTheme(win, L"HEADER"); wxUxThemeHandle hTheme(win, L"HEADER");
if ( !hTheme ) if ( !hTheme )
{ {
m_rendererNative.DrawHeaderButton(win, dc, rect, flags, sortArrow, params); return m_rendererNative.DrawHeaderButton(win, dc, rect, flags, sortArrow, params);
return;
} }
RECT r; RECT r;
@@ -330,7 +329,7 @@ wxRendererXP::DrawHeaderButton(wxWindow *win,
// and then clear those flags before calling DrawHeaderButtonContents. // and then clear those flags before calling DrawHeaderButtonContents.
// Add any extras that are specified in flags and params // Add any extras that are specified in flags and params
DrawHeaderButtonContents(win, dc, rect, flags, sortArrow, params); return DrawHeaderButtonContents(win, dc, rect, flags, sortArrow, params);
} }

View File

@@ -156,23 +156,23 @@ public:
DocDeclStr( DocDeclStr(
virtual void , DrawHeaderButton(wxWindow *win, virtual int , DrawHeaderButton(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE, wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
wxHeaderButtonParams* params=NULL), wxHeaderButtonParams* params=NULL),
"Draw the header control button (such as what is used by `wx.ListCtrl` "Draw a header control button (such as what is used by `wx.ListCtrl` in report
in report mode.)", ""); mode.) The optimal size of the label (text and icons) is returned.", "");
DocDeclStr( DocDeclStr(
virtual void , DrawHeaderButtonContents(wxWindow *win, virtual int , DrawHeaderButtonContents(wxWindow *win,
wxDC& dc, wxDC& dc,
const wxRect& rect, const wxRect& rect,
int flags = 0, int flags = 0,
wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE, wxHeaderSortIconType sortArrow = wxHDR_SORT_ICON_NONE,
wxHeaderButtonParams* params=NULL), wxHeaderButtonParams* params=NULL),
"Draw the contents of a header control button, (label, sort "Draw the contents of a header control button, (label, sort
arrows, etc.) Normally this is only called by `DrawHeaderButton`.", ""); arrows, etc.) Normally this is only called by `DrawHeaderButton`.", "");