Change the return type of wxListCtrl::SetItem() overload to bool

For some reason lost in the depths of time (but probably just a typo)
(but probably just a typo) (but probably just a typo) (but probably just
a typo), SetItem() overload taking the column index returned "long" and
not "bool", even though the actual return value was always "true" or
"false" (or even just always "true" in the case of the generic version).

Change it to return "bool" for consistency with the other overload and
because this just makes more sense and shouldn't break any existing code
due to the implicit conversions between bool and long.

Also document the return value meaning.

Closes #18153.
This commit is contained in:
Vadim Zeitlin 2018-06-23 23:56:55 +02:00
parent 7331903f56
commit a824ee092d
6 changed files with 15 additions and 5 deletions

View File

@ -78,6 +78,10 @@ Changes in behaviour which may result in build errors
- wxHtmlCell::AdjustPagebreak() has lost its "known_pagebreaks" argument,
update your code if you override this method (you shouldn't be calling it).
- wxListCtrl::SetItem() overload taking the column index now returns bool and
not long. Its return value hasn't changed, however, and is still always
either true or false, so normally the existing code should continue to work.
3.1.2: (released 2018-??-??)
----------------------------

View File

@ -72,7 +72,7 @@ public:
bool GetItem( wxListItem& info ) const;
bool SetItem( wxListItem& info ) ;
long SetItem( long index, int col, const wxString& label, int imageId = -1 );
bool SetItem( long index, int col, const wxString& label, int imageId = -1 );
int GetItemState( long item, long stateMask ) const;
bool SetItemState( long item, long state, long stateMask);
bool SetItemImage( long item, int image, int selImage = -1 );

View File

@ -158,7 +158,7 @@ public:
bool SetItem(wxListItem& info);
// Sets a string field at a particular column
long SetItem(long index, int col, const wxString& label, int imageId = -1);
bool SetItem(long index, int col, const wxString& label, int imageId = -1);
// Gets the item state
int GetItemState(long item, long stateMask) const;

View File

@ -1093,13 +1093,19 @@ public:
Using the wxListItem's mask and state mask, you can change only selected
attributes of a wxListCtrl item.
@return @true if the item was successfully updated or @false if the
update failed for some reason (e.g. an invalid item index).
*/
bool SetItem(wxListItem& info);
/**
Sets an item string field at a particular column.
@return @true if the item was successfully updated or @false if the
update failed for some reason (e.g. an invalid item index).
*/
long SetItem(long index, int column, const wxString& label, int imageId = -1);
bool SetItem(long index, int column, const wxString& label, int imageId = -1);
/**
Sets the background colour for this item.

View File

@ -4913,7 +4913,7 @@ bool wxGenericListCtrl::SetItem( wxListItem &info )
return true;
}
long wxGenericListCtrl::SetItem( long index, int col, const wxString& label, int imageId )
bool wxGenericListCtrl::SetItem( long index, int col, const wxString& label, int imageId )
{
wxListItem info;
info.m_text = label;

View File

@ -956,7 +956,7 @@ bool wxListCtrl::SetItem(wxListItem& info)
return true;
}
long wxListCtrl::SetItem(long index, int col, const wxString& label, int imageId)
bool wxListCtrl::SetItem(long index, int col, const wxString& label, int imageId)
{
wxListItem info;
info.m_text = label;