Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Simplify API for extending wxListCtrl background display

Browse Source 
Replace SetListRulesAlternateColourOnBlank() taking 2 arguments, with
the second of them being used only when the first one is true, with a
simpler but still sufficient ExtendRulesAndAlternateColour(bool).

Make the new method virtual and define it as doing nothing in
wxListCtrlBase class, so that it's still available, even if currently
not implemented, in wxMSW.

Also simplify the implementation, fix style problems and other minor
improvements.
This commit is contained in:
Vadim Zeitlin
2020-11-09 00:37:55 +01:00
parent 584d1ae47d
commit 5ae2a8ebb8
7 changed files with 80 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/wx/generic/listctrl.h
View File

@@ -189,6 +189,8 @@ public:
virtual bool SetFont( const wxFont &font ) wxOVERRIDE;
virtual bool SetCursor( const wxCursor &cursor ) wxOVERRIDE;
virtual void ExtendRulesAndAlternateColour(bool extend = true) wxOVERRIDE;
#if wxUSE_DRAG_AND_DROP
virtual void SetDropTarget( wxDropTarget *dropTarget ) wxOVERRIDE;
virtual wxDropTarget *GetDropTarget() const wxOVERRIDE;
@@ -208,8 +210,6 @@ public:
wxListHeaderWindow *m_headerWin;
wxListMainWindow *m_mainWin;
void SetListRulesAlternateColourOnBlank(bool state, const wxColour& colour);
protected:
// Implement base class pure virtual methods.
long DoInsertColumn(long col, const wxListItem& info) wxOVERRIDE;

23
include/wx/generic/private/listctrl.h
View File

@@ -740,6 +740,12 @@ public:
return true;
}
void ExtendRulesAndAlternateColour(bool extend)
{
m_extendRulesAndAlternateColour = extend;
}
// these are for wxListLineData usage only
// get the backpointer to the list ctrl
@@ -779,13 +785,6 @@ public:
const wxRect& rect,
int lineNumber );
void SetListRulesAlternateColourOnBlank( const bool state,
const wxColour& colour)
{
m_listRulesAlternateColourOnBlank = state;
m_alternateColourOnBlank = colour;
}
protected:
// the array of all line objects for a non virtual list control (for the
// virtual list control we only ever use m_lines[0])
@@ -947,18 +946,14 @@ private:
// NULL if no item is being edited
wxListTextCtrlWrapper *m_textctrlWrapper;
// tells whether or not to paint empty rows with alternate colour and draw
// rulers on empty rows
bool m_extendRulesAndAlternateColour;
wxDECLARE_EVENT_TABLE();
friend class wxGenericListCtrl;
friend class wxListCtrlMaxWidthCalculator;
// tells whether or not to paint empty rows with alternate colour and draw
// rulers on empty rows
bool m_listRulesAlternateColourOnBlank;
// colour to paint empty rows (zebra effect)
wxColour m_alternateColourOnBlank;
};
#endif // wxUSE_LISTCTRL

2
include/wx/listbase.h
View File

@@ -417,6 +417,8 @@ public:
void SetAlternateRowColour(const wxColour& colour);
wxColour GetAlternateRowColour() const { return m_alternateRowColour.GetBackgroundColour(); }
virtual void ExtendRulesAndAlternateColour(bool WXUNUSED(extend) = true) { }
// Header attributes support: only implemented in wxMSW currently.
virtual bool SetHeaderAttr(const wxItemAttr& WXUNUSED(attr)) { return false; }

29
interface/wx/listctrl.h
View File

@@ -1334,28 +1334,31 @@ public:
void CheckItem(long item, bool check);
/**
When the content of state is true, tells listctrl to draw
horizontal and vertical rulers on blank rows and also to
paint the background of alternate rows on blank rows, using
colour to paint the alternate blank(empty) rows' background.
Extend rules and alternate rows background to the entire client area.
As EnableAlternateRowColours(), this method can only be used with
controls having ::wxLC_REPORT and ::wxLC_VIRTUAL styles.
Bu default, the rules (when enabled with wxLC_HRULES and wxLC_VRULES)
and alternate row background (when EnableAlternateRowColours() was
called) are only shown in the part of the control occupied by the
items, which can be smaller than the entire window if there are few
items in the control.
This method is NOT available on Windows.
Calling this function extends the display of the rules and alternate
background rows to the entire client area.
@param state
Similarly to EnableAlternateRowColours(), this method can only be used
with controls having ::wxLC_REPORT and ::wxLC_VIRTUAL styles.
Note that this method is currently not implemented in the native MSW
version and does nothing there.
@param extend
if @true, draws horizontal rules and vertical rules on empty rows
and uses the colour parameter to paint the background of
alternate rows when those rows are blank, empty, with no data.
@param colour
A valid row background colour to enable alternating rows on
blank rows (rows with no data).
@since 3.1.5
@note This method is currently NOT implemented in the Windows version.
*/
void SetListRulesAlternateColourOnBlank(const bool state, const wxColour& colour);
void ExtendRulesAndAlternateColour(bool extend = true);
protected:

23
samples/listctrl/listtest.cpp
View File

@@ -134,9 +134,7 @@ wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
EVT_MENU(LIST_SET_FG_COL, MyFrame::OnSetFgColour)
EVT_MENU(LIST_SET_BG_COL, MyFrame::OnSetBgColour)
EVT_MENU(LIST_ROW_LINES, MyFrame::OnSetRowLines)
#if !defined(__WXMSW__)
EVT_MENU(LIST_ROW_LINES_ON_BLANK, MyFrame::OnSetRowLinesOnBlank)
#endif
EVT_MENU(LIST_CUSTOM_HEADER_ATTR, MyFrame::OnCustomHeaderAttr)
EVT_MENU(LIST_TOGGLE_MULTI_SEL, MyFrame::OnToggleMultiSel)
EVT_MENU(LIST_SHOW_COL_INFO, MyFrame::OnShowColInfo)
@@ -168,9 +166,7 @@ wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
EVT_UPDATE_UI(LIST_TOGGLE_CHECKBOXES, MyFrame::OnUpdateToggleCheckBoxes)
EVT_UPDATE_UI(LIST_TOGGLE_HEADER, MyFrame::OnUpdateToggleHeader)
EVT_UPDATE_UI(LIST_ROW_LINES, MyFrame::OnUpdateRowLines)
#if !defined(__WXMSW__)
EVT_UPDATE_UI(LIST_ROW_LINES_ON_BLANK, MyFrame::OnUpdateRowLines)
#endif
EVT_UPDATE_UI(LIST_ROW_LINES_ON_BLANK, MyFrame::OnUpdateUIEnableInReport)
wxEND_EVENT_TABLE()
// My frame constructor
@@ -283,9 +279,7 @@ MyFrame::MyFrame(const wxString& title)
menuCol->Append(LIST_SET_FG_COL, "&Foreground colour...");
menuCol->Append(LIST_SET_BG_COL, "&Background colour...");
menuCol->AppendCheckItem(LIST_ROW_LINES, "Alternating colours");
#if !defined(__WXMSW__)
menuCol->AppendCheckItem(LIST_ROW_LINES_ON_BLANK, "Alternating colours on Blank");
#endif
menuCol->AppendCheckItem(LIST_ROW_LINES_ON_BLANK, "Extend to whole window");
menuCol->AppendCheckItem(LIST_CUSTOM_HEADER_ATTR, "&Custom header attributes");
wxMenuBar *menubar = new wxMenuBar;
@@ -529,9 +523,7 @@ void MyFrame::RecreateList(long flags, bool withText)
}
GetMenuBar()->Check(LIST_ROW_LINES, false);
#if !defined(__WXMSW__)
GetMenuBar()->Check(LIST_ROW_LINES_ON_BLANK, false);
#endif
m_logWindow->Clear();
}
@@ -952,19 +944,10 @@ void MyFrame::OnSetRowLines(wxCommandEvent& event)
m_listCtrl->Refresh();
}
#if !defined(__WXMSW__)
void MyFrame::OnSetRowLinesOnBlank(wxCommandEvent& event)
{
wxColour color = wxGetColourFromUser(this);
m_listCtrl->SetSingleStyle(wxLC_HRULES | wxLC_VRULES, event.IsChecked());
if (event.IsChecked())
m_listCtrl->SetAlternateRowColour(color);
else
m_listCtrl->EnableAlternateRowColours(event.IsChecked());
m_listCtrl->SetListRulesAlternateColourOnBlank(event.IsChecked(), color);
m_listCtrl->Refresh();
m_listCtrl->ExtendRulesAndAlternateColour(event.IsChecked());
}
#endif
void MyFrame::OnCustomHeaderAttr(wxCommandEvent& event)
{

4
samples/listctrl/listtest.h
View File

@@ -133,9 +133,7 @@ protected:
void OnSetFgColour(wxCommandEvent& event);
void OnSetBgColour(wxCommandEvent& event);
void OnSetRowLines(wxCommandEvent& event);
#if !defined(__WXMSW__)
void OnSetRowLinesOnBlank(wxCommandEvent& event);
#endif
void OnCustomHeaderAttr(wxCommandEvent& event);
void OnToggleMultiSel(wxCommandEvent& event);
void OnShowColInfo(wxCommandEvent& event);
@@ -226,9 +224,7 @@ enum
LIST_SET_FG_COL,
LIST_SET_BG_COL,
LIST_ROW_LINES,
#if !defined(__WXMSW__)
LIST_ROW_LINES_ON_BLANK,
#endif
LIST_CUSTOM_HEADER_ATTR,
LIST_TOGGLE_MULTI_SEL,
LIST_TOGGLE_HEADER,

91
src/generic/listctrl.cpp
View File

@@ -793,22 +793,6 @@ void wxListLineData::Draw(wxDC *dc, bool current)
}
}
void wxListMainWindow::DrawInReportModeOnBlank ( wxDC *dc,
const wxRect& rect,
int lineNumber )
{
// Checks whether or not lineNumber is due to change on its background
// colour and fills the row from beginning to end with the colour stored
// in the m_alternateColourOnBlank instance variable in affirmative case
if ( lineNumber % 2 )
{
dc->SetBrush(m_alternateColourOnBlank);
dc->SetPen(*wxTRANSPARENT_PEN);
dc->DrawRectangle(rect);
}
}
void wxListLineData::DrawInReportMode( wxDC *dc,
const wxRect& rect,
const wxRect& rectHL,
@@ -1617,9 +1601,7 @@ void wxListMainWindow::Init()
m_anchor = (size_t)-1;
m_hasCheckBoxes = false;
m_listRulesAlternateColourOnBlank = false;
m_alternateColourOnBlank = wxColour(176, 235, 212, 0xff);;
m_extendRulesAndAlternateColour = false;
}
wxListMainWindow::wxListMainWindow()
@@ -2091,12 +2073,22 @@ void wxListMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
int lineHeight = GetLineHeight();
size_t visibleFrom, visibleTo;
size_t visibleEnd;
const size_t linesPerPage = (unsigned int) m_linesPerPage;
GetVisibleLinesRange(&visibleFrom, &visibleTo);
visibleEnd = (m_listRulesAlternateColourOnBlank &&
linesPerPage > visibleTo ? linesPerPage : visibleTo);
// We may need to iterate beyond visibleTo if we want to draw striped
// background across the entire window.
size_t visibleEnd;
wxColour colAlt;
if ( m_extendRulesAndAlternateColour )
{
colAlt = GetListCtrl()->GetAlternateRowColour();
visibleEnd = wxMax(linesPerPage, visibleTo);
}
else
{
visibleEnd = visibleTo;
}
wxRect rectLine;
int xOrig = dc.LogicalToDeviceX( 0 );
@@ -2126,15 +2118,26 @@ void wxListMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
continue;
}
if ( line <= visibleTo ) {
GetLine(line)->DrawInReportMode( &dc,
rectLine,
GetLineHighlightRect(line),
IsHighlighted(line),
line == m_current );
} else {
DrawInReportModeOnBlank( &dc, rectLine, line );
if ( line > visibleTo )
{
// We only iterate beyond visibleTo when we have to draw the
// odd rows background, so do this if needed.
if ( line % 2 )
{
dc.SetBrush(colAlt);
dc.SetPen(*wxTRANSPARENT_PEN);
dc.DrawRectangle(rectLine);
}
// But don't do anything else, as there is no valid item.
continue;
}
GetLine(line)->DrawInReportMode( &dc,
rectLine,
GetLineHighlightRect(line),
IsHighlighted(line),
line == m_current );
}
if ( HasFlag(wxLC_HRULES) )
@@ -2163,9 +2166,8 @@ void wxListMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
}
// Draw vertical rules if required
if ( HasFlag(wxLC_VRULES) && (m_listRulesAlternateColourOnBlank ||
( ! m_listRulesAlternateColourOnBlank
&& !IsEmpty() ) ) )
if ( HasFlag(wxLC_VRULES) &&
(m_extendRulesAndAlternateColour || !IsEmpty()) )
{
wxPen pen(GetRuleColour(), 1, wxPENSTYLE_SOLID);
wxRect firstItemRect, lastItemRect;
@@ -2186,13 +2188,12 @@ void wxListMainWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
int x_pos = x - dev_x;
if (col < GetColumnCount()-1) x_pos -= 2;
if (m_listRulesAlternateColourOnBlank) {
dc.DrawLine(x_pos, firstItemRect.GetY() - 1 - dev_y,
x_pos, clientHeight);
} else {
dc.DrawLine(x_pos, firstItemRect.GetY() - 1 - dev_y,
x_pos, lastItemRect.GetBottom() + 1 - dev_y);
}
int ruleHeight = m_extendRulesAndAlternateColour
? clientHeight
: lastItemRect.GetBottom() + 1 - dev_y;
dc.DrawLine(x_pos, firstItemRect.GetY() - 1 - dev_y,
x_pos, ruleHeight);
}
}
}
@@ -4986,10 +4987,14 @@ bool wxGenericListCtrl::Create(wxWindow *parent,
return true;
}
void wxGenericListCtrl::SetListRulesAlternateColourOnBlank(const bool state, const wxColour& colour)
void wxGenericListCtrl::ExtendRulesAndAlternateColour(bool state)
{
if (m_mainWin)
m_mainWin->SetListRulesAlternateColourOnBlank(state, colour);
wxCHECK_RET( m_mainWin, "can't be called before creation" );
wxASSERT_MSG( InReportView(), "can only be called in report mode" );
m_mainWin->ExtendRulesAndAlternateColour(state);
m_mainWin->Refresh();
}
wxBorder wxGenericListCtrl::GetDefaultBorder() const