// Author: Julian Smart
// Modified by: Vadim Zeitlin (owner drawn stuff)
// Created:
-// RCS-ID: $Id$
// Copyright: (c) Julian Smart
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#include "wx/ownerdrw.h"
#endif
-#if wxUSE_EXTENDED_RTTI
-WX_DEFINE_FLAGS( wxListBoxStyle )
-
-wxBEGIN_FLAGS( wxListBoxStyle )
- // new style border flags, we put them first to
- // use them for streaming out
- wxFLAGS_MEMBER(wxBORDER_SIMPLE)
- wxFLAGS_MEMBER(wxBORDER_SUNKEN)
- wxFLAGS_MEMBER(wxBORDER_DOUBLE)
- wxFLAGS_MEMBER(wxBORDER_RAISED)
- wxFLAGS_MEMBER(wxBORDER_STATIC)
- wxFLAGS_MEMBER(wxBORDER_NONE)
-
- // old style border flags
- wxFLAGS_MEMBER(wxSIMPLE_BORDER)
- wxFLAGS_MEMBER(wxSUNKEN_BORDER)
- wxFLAGS_MEMBER(wxDOUBLE_BORDER)
- wxFLAGS_MEMBER(wxRAISED_BORDER)
- wxFLAGS_MEMBER(wxSTATIC_BORDER)
- wxFLAGS_MEMBER(wxBORDER)
-
- // standard window styles
- wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
- wxFLAGS_MEMBER(wxCLIP_CHILDREN)
- wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
- wxFLAGS_MEMBER(wxWANTS_CHARS)
- wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
- wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
- wxFLAGS_MEMBER(wxVSCROLL)
- wxFLAGS_MEMBER(wxHSCROLL)
-
- wxFLAGS_MEMBER(wxLB_SINGLE)
- wxFLAGS_MEMBER(wxLB_MULTIPLE)
- wxFLAGS_MEMBER(wxLB_EXTENDED)
- wxFLAGS_MEMBER(wxLB_HSCROLL)
- wxFLAGS_MEMBER(wxLB_ALWAYS_SB)
- wxFLAGS_MEMBER(wxLB_NEEDED_SB)
- wxFLAGS_MEMBER(wxLB_NO_SB)
- wxFLAGS_MEMBER(wxLB_SORT)
-
-wxEND_FLAGS( wxListBoxStyle )
-
-IMPLEMENT_DYNAMIC_CLASS_XTI(wxListBox, wxControlWithItems,"wx/listbox.h")
-
-wxBEGIN_PROPERTIES_TABLE(wxListBox)
- wxEVENT_PROPERTY( Select , wxEVT_COMMAND_LISTBOX_SELECTED , wxCommandEvent )
- wxEVENT_PROPERTY( DoubleClick , wxEVT_COMMAND_LISTBOX_DOUBLECLICKED , wxCommandEvent )
-
- wxPROPERTY( Font , wxFont , SetFont , GetFont , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
- wxPROPERTY_COLLECTION( Choices , wxArrayString , wxString , AppendString , GetStrings, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
- wxPROPERTY( Selection ,int, SetSelection, GetSelection, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
- wxPROPERTY_FLAGS( WindowStyle , wxListBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
-wxEND_PROPERTIES_TABLE()
-
-wxBEGIN_HANDLERS_TABLE(wxListBox)
-wxEND_HANDLERS_TABLE()
-
-wxCONSTRUCTOR_4( wxListBox , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
-#else
-IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControlWithItems)
-#endif
-
-/*
-TODO PROPERTIES
- selection
- content
- item
-*/
-
// ============================================================================
// list box item declaration and implementation
// ============================================================================
// creation
// ----------------------------------------------------------------------------
-// Listbox item
-wxListBox::wxListBox()
+void wxListBox::Init()
{
m_noItems = 0;
m_updateHorizontalExtent = false;
const wxValidator& validator,
const wxString& name)
{
- m_noItems = 0;
- m_updateHorizontalExtent = false;
-
// initialize base class fields
if ( !CreateControl(parent, id, pos, size, style, validator, name) )
return false;
}
// now we can compute our best size correctly, so do it again
- InvalidateBestSize();
SetInitialSize(size);
return true;
}
}
+void wxListBox::MSWOnItemsChanged()
+{
+ // we need to do two things when items change: update their max horizontal
+ // extent so that horizontal scrollbar could be shown or hidden as
+ // appropriate and also invlaidate the best size
+ //
+ // updating the max extent is slow (it's an O(N) operation) and so we defer
+ // it until the idle time but the best size should be invalidated
+ // immediately doing it in idle time is too late -- layout using incorrect
+ // old best size will have been already done by then
+
+ m_updateHorizontalExtent = true;
+
+ InvalidateBestSize();
+}
+
// ----------------------------------------------------------------------------
// implementation of wxListBoxBase methods
// ----------------------------------------------------------------------------
wxT("invalid index in wxListBox::Delete") );
#if wxUSE_OWNER_DRAWN
- delete m_aItems[n];
- m_aItems.RemoveAt(n);
+ if ( HasFlag(wxLB_OWNERDRAW) )
+ {
+ delete m_aItems[n];
+ m_aItems.RemoveAt(n);
+ }
#endif // wxUSE_OWNER_DRAWN
SendMessage(GetHwnd(), LB_DELETESTRING, n, 0);
m_noItems--;
- // SetHorizontalExtent(wxEmptyString); can be slow
- m_updateHorizontalExtent = true;
+ MSWOnItemsChanged();
UpdateOldSelections();
}
if (bCase)
return wxItemContainerImmutable::FindString( s, bCase );
- int pos = ListBox_FindStringExact(GetHwnd(), -1, s.wx_str());
+ int pos = ListBox_FindStringExact(GetHwnd(), -1, s.t_str());
if (pos == LB_ERR)
return wxNOT_FOUND;
else
void wxListBox::DoClear()
{
#if wxUSE_OWNER_DRAWN
- if ( m_windowStyle & wxLB_OWNERDRAW )
+ if ( HasFlag(wxLB_OWNERDRAW) )
{
WX_CLEAR_ARRAY(m_aItems);
}
ListBox_ResetContent(GetHwnd());
m_noItems = 0;
- m_updateHorizontalExtent = true;
+ MSWOnItemsChanged();
UpdateOldSelections();
}
if ( HasMultipleSelection() )
{
- SendMessage(GetHwnd(), LB_SETSEL, select, N);
+ // Setting selection to -1 should deselect everything.
+ const bool deselectAll = N == wxNOT_FOUND;
+ SendMessage(GetHwnd(), LB_SETSEL,
+ deselectAll ? FALSE : select,
+ deselectAll ? -1 : N);
}
else
{
void *wxListBox::DoGetItemClientData(unsigned int n) const
{
- wxCHECK_MSG( IsValid(n), NULL,
- wxT("invalid index in wxListBox::GetClientData") );
+ LPARAM rc = SendMessage(GetHwnd(), LB_GETITEMDATA, n, 0);
+ if ( rc == LB_ERR && GetLastError() != ERROR_SUCCESS )
+ {
+ wxLogLastError(wxT("LB_GETITEMDATA"));
+
+ return NULL;
+ }
- return (void *)SendMessage(GetHwnd(), LB_GETITEMDATA, n, 0);
+ return (void *)rc;
}
void wxListBox::DoSetItemClientData(unsigned int n, void *clientData)
{
- wxCHECK_RET( IsValid(n),
- wxT("invalid index in wxListBox::SetClientData") );
-
if ( ListBox_SetItemData(GetHwnd(), n, clientData) == LB_ERR )
{
wxLogDebug(wxT("LB_SETITEMDATA failed"));
AssignNewItemClientData(n, clientData, i, type);
}
- m_updateHorizontalExtent = true;
+ MSWOnItemsChanged();
UpdateOldSelections();
return n;
}
-int wxListBox::DoListHitTest(const wxPoint& point) const
+int wxListBox::DoHitTestList(const wxPoint& point) const
{
LRESULT lRes = ::SendMessage(GetHwnd(), LB_ITEMFROMPOINT,
0, MAKELPARAM(point.x, point.y));
if ( n == (m_noItems - 1) )
newN = -1;
- ListBox_InsertString(GetHwnd(), newN, s.wx_str());
+ ListBox_InsertString(GetHwnd(), newN, s.t_str());
// restore the client data
if ( oldData )
if ( wasSelected )
Select(n);
- m_updateHorizontalExtent = true;
+ MSWOnItemsChanged();
}
unsigned int wxListBox::GetCount() const
void wxListBox::SetHorizontalExtent(const wxString& s)
{
- // in any case, our best size could have changed
- InvalidateBestSize();
-
// the rest is only necessary if we want a horizontal scrollbar
if ( !HasFlag(wxHSCROLL) )
return;
bool wxListBox::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
{
- if ((param == LBN_SELCHANGE) && HasMultipleSelection())
- {
- CalcAndSendEvent();
- return true;
- }
-
wxEventType evtType;
- int n;
if ( param == LBN_SELCHANGE )
{
- evtType = wxEVT_COMMAND_LISTBOX_SELECTED;
- n = SendMessage(GetHwnd(), LB_GETCARETINDEX, 0, 0);
+ if ( HasMultipleSelection() )
+ return CalcAndSendEvent();
- // NB: conveniently enough, LB_ERR is the same as wxNOT_FOUND
+ evtType = wxEVT_LISTBOX;
}
else if ( param == LBN_DBLCLK )
{
- evtType = wxEVT_COMMAND_LISTBOX_DOUBLECLICKED;
- n = HitTest(ScreenToClient(wxGetMousePosition()));
+ // Clicking under the last item in the listbox generates double click
+ // event for the currently selected item which is rather surprising.
+ // Avoid the surprise by checking that we do have an item under mouse.
+ const DWORD pos = ::GetMessagePos();
+ const wxPoint pt(GET_X_LPARAM(pos), GET_Y_LPARAM(pos));
+ if ( HitTest(ScreenToClient(pt)) == wxNOT_FOUND )
+ return false;
+
+ evtType = wxEVT_LISTBOX_DCLICK;
}
else
{
return false;
}
- // retrieve the affected item
- if ( n == wxNOT_FOUND )
- return false;
-
- wxCommandEvent event(evtType, m_windowId);
- event.SetEventObject(this);
+ const int n = ListBox_GetCurSel(GetHwnd());
- if ( HasClientObjectData() )
- event.SetClientObject( GetClientObject(n) );
- else if ( HasClientUntypedData() )
- event.SetClientData( GetClientData(n) );
+ // We get events even when mouse is clicked outside of any valid item from
+ // Windows, just ignore them.
+ if ( n == wxNOT_FOUND )
+ return false;
- event.SetString(GetString(n));
- event.SetInt(n);
+ if ( param == LBN_SELCHANGE )
+ {
+ if ( !DoChangeSingleSelection(n) )
+ return false;
+ }
- return HandleWindowEvent(event);
+ // Do generate an event otherwise.
+ return SendEvent(evtType, n, true /* selection */);
}
// ----------------------------------------------------------------------------
-// wxCheckListBox support
+// owner-drawn list boxes support
// ----------------------------------------------------------------------------
#if wxUSE_OWNER_DRAWN
+// misc overloaded methods
+// -----------------------
+
+bool wxListBox::SetFont(const wxFont &font)
+{
+ if ( HasFlag(wxLB_OWNERDRAW) )
+ {
+ const unsigned count = m_aItems.GetCount();
+ for ( unsigned i = 0; i < count; i++ )
+ m_aItems[i]->SetFont(font);
+ }
+
+ wxListBoxBase::SetFont(font);
+
+ return true;
+}
+
+bool wxListBox::GetItemRect(size_t n, wxRect& rect) const
+{
+ wxCHECK_MSG( IsValid(n), false,
+ wxT("invalid index in wxListBox::GetItemRect") );
+
+ RECT rc;
+
+ if ( ListBox_GetItemRect(GetHwnd(), n, &rc) != LB_ERR )
+ {
+ rect = wxRectFromRECT(rc);
+ return true;
+ }
+ else
+ {
+ // couldn't retrieve rect: for example, item isn't visible
+ return false;
+ }
+}
+
+bool wxListBox::RefreshItem(size_t n)
+{
+ wxRect rect;
+ if ( !GetItemRect(n, rect) )
+ return false;
+
+ RECT rc;
+ wxCopyRectToRECT(rect, rc);
+
+ return ::InvalidateRect((HWND)GetHWND(), &rc, FALSE) == TRUE;
+}
+
+
// drawing
// -------
-// space beneath/above each row in pixels
-// "standard" checklistbox use 1 here, some might prefer 2. 0 is ugly.
-#define OWNER_DRAWN_LISTBOX_EXTRA_SPACE (1)
+namespace
+{
+ // space beneath/above each row in pixels
+ static const int LISTBOX_EXTRA_SPACE = 1;
+
+} // anonymous namespace
// the height is the same for all items
// TODO should be changed for LBS_OWNERDRAWVARIABLE style listboxes
bool wxListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
{
// only owner-drawn control should receive this message
- wxCHECK( ((m_windowStyle & wxLB_OWNERDRAW) == wxLB_OWNERDRAW), false );
+ wxCHECK( HasFlag(wxLB_OWNERDRAW), false );
MEASUREITEMSTRUCT *pStruct = (MEASUREITEMSTRUCT *)item;
wxDCTemp dc((WXHDC)hdc);
dc.SetFont(GetFont());
- pStruct->itemHeight = dc.GetCharHeight() + 2*OWNER_DRAWN_LISTBOX_EXTRA_SPACE;
+ pStruct->itemHeight = dc.GetCharHeight() + 2 * LISTBOX_EXTRA_SPACE;
pStruct->itemWidth = dc.GetCharWidth();
}
bool wxListBox::MSWOnDraw(WXDRAWITEMSTRUCT *item)
{
// only owner-drawn control should receive this message
- wxCHECK( ((m_windowStyle & wxLB_OWNERDRAW) == wxLB_OWNERDRAW), false );
+ wxCHECK( HasFlag(wxLB_OWNERDRAW), false );
DRAWITEMSTRUCT *pStruct = (DRAWITEMSTRUCT *)item;