// 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_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
// ============================================================================
class wxListBoxItem : public wxOwnerDrawn
{
public:
- wxListBoxItem(const wxString& str = wxEmptyString);
-};
+ wxListBoxItem(wxListBox *parent)
+ { m_parent = parent; }
-wxListBoxItem::wxListBoxItem(const wxString& str) : wxOwnerDrawn(str, false)
-{
- // no bitmaps/checkmarks
- SetMarginWidth(0);
-}
+ wxListBox *GetParent() const
+ { return m_parent; }
+
+ int GetIndex() const
+ { return m_parent->GetItemIndex(const_cast<wxListBoxItem*>(this)); }
+
+ wxString GetName() const
+ { return m_parent->GetString(GetIndex()); }
+
+private:
+ wxListBox *m_parent;
+};
wxOwnerDrawn *wxListBox::CreateLboxItem(size_t WXUNUSED(n))
{
- return new wxListBoxItem();
+ return new wxListBoxItem(this);
}
#endif //USE_OWNER_DRAWN
// 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;
// create the native control
- if ( !MSWCreateControl(_T("LISTBOX"), wxEmptyString, pos, size) )
+ if ( !MSWCreateControl(wxT("LISTBOX"), wxEmptyString, pos, size) )
{
// control creation failed
return false;
}
// now we can compute our best size correctly, so do it again
- InvalidateBestSize();
SetInitialSize(size);
return true;
{
WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
- // always show the vertical scrollbar if necessary -- otherwise it is
- // impossible to use the control with the mouse
- msStyle |= WS_VSCROLL;
-
// we always want to get the notifications
msStyle |= LBS_NOTIFY;
msStyle |= LBS_NOINTEGRALHEIGHT;
wxASSERT_MSG( !(style & wxLB_MULTIPLE) || !(style & wxLB_EXTENDED),
- _T("only one of listbox selection modes can be specified") );
+ wxT("only one of listbox selection modes can be specified") );
if ( style & wxLB_MULTIPLE )
msStyle |= LBS_MULTIPLESEL;
else if ( style & wxLB_EXTENDED )
msStyle |= LBS_EXTENDEDSEL;
- if ( m_windowStyle & wxLB_ALWAYS_SB )
- msStyle |= LBS_DISABLENOSCROLL;
+ wxASSERT_MSG( !(style & wxLB_ALWAYS_SB) || !(style & wxLB_NO_SB),
+ wxT( "Conflicting styles wxLB_ALWAYS_SB and wxLB_NO_SB." ) );
+
+ if ( !(style & wxLB_NO_SB) )
+ {
+ msStyle |= WS_VSCROLL;
+ if ( style & wxLB_ALWAYS_SB )
+ msStyle |= LBS_DISABLENOSCROLL;
+ }
+
if ( m_windowStyle & wxLB_HSCROLL )
msStyle |= WS_HSCROLL;
if ( m_windowStyle & wxLB_SORT )
void wxListBox::OnInternalIdle()
{
wxWindow::OnInternalIdle();
-
+
if (m_updateHorizontalExtent)
{
SetHorizontalExtent(wxEmptyString);
}
}
+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
// ----------------------------------------------------------------------------
wxCHECK_RET( IsValid(n),
wxT("invalid index in wxListBox::Delete") );
+#if wxUSE_OWNER_DRAWN
+ 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()
{
- Free();
+#if wxUSE_OWNER_DRAWN
+ if ( HasFlag(wxLB_OWNERDRAW) )
+ {
+ WX_CLEAR_ARRAY(m_aItems);
+ }
+#endif // wxUSE_OWNER_DRAWN
ListBox_ResetContent(GetHwnd());
m_noItems = 0;
- m_updateHorizontalExtent = true;
+ MSWOnItemsChanged();
UpdateOldSelections();
}
-void wxListBox::Free()
-{
-#if wxUSE_OWNER_DRAWN
- if ( m_windowStyle & wxLB_OWNERDRAW )
- {
- WX_CLEAR_ARRAY(m_aItems);
- }
-#endif // wxUSE_OWNER_DRAWN
-}
-
void wxListBox::DoSetSelection(int N, bool select)
{
wxCHECK_RET( N == wxNOT_FOUND || IsValid(N),
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 wxUSE_OWNER_DRAWN
- if ( m_windowStyle & wxLB_OWNERDRAW )
- {
- // client data must be pointer to wxOwnerDrawn, otherwise we would crash
- // in OnMeasure/OnDraw.
- wxFAIL_MSG(wxT("Can't use client data with owner-drawn listboxes"));
- }
-#endif // wxUSE_OWNER_DRAWN
-
if ( ListBox_SetItemData(GetHwnd(), n, clientData) == LB_ERR )
+ {
wxLogDebug(wxT("LB_SETITEMDATA failed"));
+ }
}
// Return number of selections and an array of selected integers
int countSel = ListBox_GetSelCount(GetHwnd());
if ( countSel == LB_ERR )
{
- wxLogDebug(_T("ListBox_GetSelCount failed"));
+ wxLogDebug(wxT("ListBox_GetSelCount failed"));
}
else if ( countSel != 0 )
{
if ( HasFlag(wxLB_OWNERDRAW) )
{
wxOwnerDrawn *pNewItem = CreateLboxItem(n);
- pNewItem->SetName(items[i]);
pNewItem->SetFont(GetFont());
m_aItems.Insert(pNewItem, n);
-
- ListBox_SetItemData(GetHwnd(), n, pNewItem);
}
#endif // wxUSE_OWNER_DRAWN
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,
- 0L, MAKELONG(point.x, point.y));
+ LRESULT lRes = ::SendMessage(GetHwnd(), LB_ITEMFROMPOINT,
+ 0, MAKELPARAM(point.x, point.y));
// non zero high-order word means that this item is outside of the client
// area, IOW the point is outside of the listbox
- return HIWORD(lRes) ? wxNOT_FOUND : lRes;
+ return HIWORD(lRes) ? wxNOT_FOUND : LOWORD(lRes);
}
void wxListBox::SetString(unsigned int n, const wxString& s)
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 )
else if ( oldObjData )
SetClientObject(n, oldObjData);
-#if wxUSE_OWNER_DRAWN
- if ( m_windowStyle & wxLB_OWNERDRAW )
- {
- // update item's text
- m_aItems[n]->SetName(s);
-
- // reassign the item's data
- ListBox_SetItemData(GetHwnd(), n, m_aItems[n]);
- }
-#endif //USE_OWNER_DRAWN
-
// we may have lost the selection
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;
//else: it shouldn't change
}
-wxSize wxListBox::DoGetBestSize() const
+wxSize wxListBox::DoGetBestClientSize() const
{
// find the widest string
int wLine;
wListbox = 100;
// the listbox should be slightly larger than the widest string
- int cx, cy;
- wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
-
- wListbox += 3*cx;
+ wListbox += 3*GetCharWidth();
- // Add room for the scrollbar
+ // add room for the scrollbar
wListbox += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
// don't make the listbox too tall (limit height to 10 items) but don't
// make it too small neither
- int hListbox = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)*
+ int hListbox = SendMessage(GetHwnd(), LB_GETITEMHEIGHT, 0, 0)*
wxMin(wxMax(m_noItems, 3), 10);
- wxSize best(wListbox, hListbox);
- CacheBestSize(best);
- return best;
+ return wxSize(wListbox, hListbox);
}
// ----------------------------------------------------------------------------
bool wxListBox::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
{
- if ((param == LBN_SELCHANGE) && HasMultipleSelection())
- {
- CalcAndSendEvent();
- return true;
- }
-
wxEventType evtType;
if ( param == LBN_SELCHANGE )
{
- evtType = wxEVT_COMMAND_LISTBOX_SELECTED;
+ if ( HasMultipleSelection() )
+ return CalcAndSendEvent();
+
+ evtType = wxEVT_LISTBOX;
}
else if ( param == LBN_DBLCLK )
{
- evtType = wxEVT_COMMAND_LISTBOX_DOUBLECLICKED;
+ // 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;
}
- wxCommandEvent event(evtType, m_windowId);
- event.SetEventObject( this );
+ const int n = ListBox_GetCurSel(GetHwnd());
+
+ // We get events even when mouse is clicked outside of any valid item from
+ // Windows, just ignore them.
+ if ( n == wxNOT_FOUND )
+ return false;
+
+ if ( param == LBN_SELCHANGE )
+ {
+ if ( !DoChangeSingleSelection(n) )
+ return false;
+ }
+
+ // Do generate an event otherwise.
+ return SendEvent(evtType, n, true /* selection */);
+}
+
+// ----------------------------------------------------------------------------
+// owner-drawn list boxes support
+// ----------------------------------------------------------------------------
+
+#if wxUSE_OWNER_DRAWN
+
+// misc overloaded methods
+// -----------------------
- // retrieve the affected item
- int n = SendMessage(GetHwnd(), LB_GETCARETINDEX, 0, 0);
- if ( n != LB_ERR )
+bool wxListBox::SetFont(const wxFont &font)
+{
+ if ( HasFlag(wxLB_OWNERDRAW) )
{
- if ( HasClientObjectData() )
- event.SetClientObject( GetClientObject(n) );
- else if ( HasClientUntypedData() )
- event.SetClientData( GetClientData(n) );
+ 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;
- event.SetString(GetString(n));
+ 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;
}
+}
- event.SetInt(n);
+bool wxListBox::RefreshItem(size_t n)
+{
+ wxRect rect;
+ if ( !GetItemRect(n, rect) )
+ return false;
- return HandleWindowEvent(event);
-}
+ RECT rc;
+ wxCopyRectToRECT(rect, rc);
-// ----------------------------------------------------------------------------
-// wxCheckListBox support
-// ----------------------------------------------------------------------------
+ return ::InvalidateRect((HWND)GetHWND(), &rc, FALSE) == TRUE;
+}
-#if wxUSE_OWNER_DRAWN
// 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;
- UINT itemID = pStruct->itemID;
// the item may be -1 for an empty listbox
- if ( itemID == (UINT)-1 )
+ if ( pStruct->itemID == (UINT)-1 )
return false;
- LRESULT data = ListBox_GetItemData(GetHwnd(), pStruct->itemID);
-
- wxCHECK( data && (data != LB_ERR), false );
-
- wxListBoxItem *pItem = (wxListBoxItem *)data;
+ wxListBoxItem *pItem = (wxListBoxItem *)m_aItems[pStruct->itemID];
wxDCTemp dc((WXHDC)pStruct->hDC);
- wxPoint pt1(pStruct->rcItem.left, pStruct->rcItem.top);
- wxPoint pt2(pStruct->rcItem.right, pStruct->rcItem.bottom);
- wxRect rect(pt1, pt2);
- return pItem->OnDrawItem(dc, rect,
+ return pItem->OnDrawItem(dc, wxRectFromRECT(pStruct->rcItem),
(wxOwnerDrawn::wxODAction)pStruct->itemAction,
- (wxOwnerDrawn::wxODStatus)pStruct->itemState);
+ (wxOwnerDrawn::wxODStatus)(pStruct->itemState | wxOwnerDrawn::wxODHidePrefix));
}
#endif // wxUSE_OWNER_DRAWN
projects / wxWidgets.git / blobdiff