/////////////////////////////////////////////////////////////////////////////
-// Name: choice.cpp
+// Name: src/msw/choice.cpp
// Purpose: wxChoice
// Author: Julian Smart
// Modified by: Vadim Zeitlin to derive from wxChoiceBase
// headers
// ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma implementation "choice.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#if wxUSE_CHOICE && !(defined(__SMARTPHONE__) && defined(__WXWINCE__))
+#include "wx/choice.h"
+
#ifndef WX_PRECOMP
- #include "wx/choice.h"
#include "wx/utils.h"
#include "wx/log.h"
#include "wx/brush.h"
wxEND_FLAGS( wxChoiceStyle )
-IMPLEMENT_DYNAMIC_CLASS_XTI(wxChoice, wxControl,"wx/choice.h")
+IMPLEMENT_DYNAMIC_CLASS_XTI(wxChoice, wxControlWithItems,"wx/choice.h")
wxBEGIN_PROPERTIES_TABLE(wxChoice)
wxEVENT_PROPERTY( Select , wxEVT_COMMAND_CHOICE_SELECTED , wxCommandEvent )
wxCONSTRUCTOR_4( wxChoice , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
#else
-IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControl)
+IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControlWithItems)
#endif
/*
TODO PROPERTIES
}
// and now we may finally size the control properly (if needed)
- SetBestSize(size);
+ SetInitialSize(size);
return true;
}
+void wxChoice::SetLabel(const wxString& label)
+{
+ if ( FindString(label) == wxNOT_FOUND )
+ {
+ // unless we explicitly do this here, CB_GETCURSEL will continue to
+ // return the index of the previously selected item which will result
+ // in wrongly replacing the value being set now with the previously
+ // value if the user simply opens and closes (without selecting
+ // anything) the combobox popup
+ SetSelection(-1);
+ }
+
+ wxChoiceBase::SetLabel(label);
+}
+
bool wxChoice::Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos,
wxChoice::~wxChoice()
{
- Free();
+ Clear();
}
// ----------------------------------------------------------------------------
// adding/deleting items to/from the list
// ----------------------------------------------------------------------------
-int wxChoice::DoAppend(const wxString& item)
+int wxChoice::DoInsertItems(const wxArrayStringsAdapter& items,
+ unsigned int pos,
+ void **clientData, wxClientDataType type)
{
- int n = (int)SendMessage(GetHwnd(), CB_ADDSTRING, 0, (LPARAM)item.c_str());
- if ( n == CB_ERR )
- {
- wxLogLastError(wxT("SendMessage(CB_ADDSTRING)"));
- }
- else // ok
- {
- // we need to refresh our size in order to have enough space for the
- // newly added items
- if ( !IsFrozen() )
- UpdateVisibleHeight();
- }
+ MSWAllocStorage(items, CB_INITSTORAGE);
- InvalidateBestSize();
- return n;
-}
+ const bool append = pos == GetCount();
-int wxChoice::DoInsert(const wxString& item, int pos)
-{
- wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));
- wxCHECK_MSG((pos>=0) && (pos<=GetCount()), -1, wxT("invalid index"));
+ // use CB_ADDSTRING when appending at the end to make sure the control is
+ // resorted if it has wxCB_SORT style
+ const unsigned msg = append ? CB_ADDSTRING : CB_INSERTSTRING;
- int n = (int)SendMessage(GetHwnd(), CB_INSERTSTRING, pos, (LPARAM)item.c_str());
- if ( n == CB_ERR )
- {
- wxLogLastError(wxT("SendMessage(CB_INSERTSTRING)"));
- }
- else // ok
+ if ( append )
+ pos = 0;
+
+ int n = wxNOT_FOUND;
+ const unsigned numItems = items.GetCount();
+ for ( unsigned i = 0; i < numItems; ++i )
{
- if ( !IsFrozen() )
- UpdateVisibleHeight();
+ n = MSWInsertOrAppendItem(pos, items[i], msg);
+ if ( n == wxNOT_FOUND )
+ return n;
+
+ if ( !append )
+ pos++;
+
+ AssignNewItemClientData(n, clientData, i, type);
}
+ // we need to refresh our size in order to have enough space for the
+ // newly added items
+ if ( !IsFrozen() )
+ UpdateVisibleHeight();
+
InvalidateBestSize();
+
return n;
}
-void wxChoice::Delete(int n)
+void wxChoice::DoDeleteOneItem(unsigned int n)
{
- wxCHECK_RET( n < GetCount(), wxT("invalid item index in wxChoice::Delete") );
-
- if ( HasClientObjectData() )
- {
- delete GetClientObject(n);
- }
+ wxCHECK_RET( IsValid(n), wxT("invalid item index in wxChoice::Delete") );
SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
InvalidateBestSize();
}
-void wxChoice::Clear()
+void wxChoice::DoClear()
{
- Free();
-
SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);
if ( !IsFrozen() )
InvalidateBestSize();
}
-void wxChoice::Free()
-{
- if ( HasClientObjectData() )
- {
- size_t count = GetCount();
- for ( size_t n = 0; n < count; n++ )
- {
- delete GetClientObject(n);
- }
- }
-}
-
// ----------------------------------------------------------------------------
// selection
// ----------------------------------------------------------------------------
int wxChoice::GetSelection() const
+{
+ // if m_lastAcceptedSelection is set, it means that the dropdown is
+ // currently shown and that we want to use the last "permanent" selection
+ // instead of whatever is under the mouse pointer currently
+ //
+ // otherwise, get the selection from the control
+ return m_lastAcceptedSelection == wxID_NONE ? GetCurrentSelection()
+ : m_lastAcceptedSelection;
+}
+
+int wxChoice::GetCurrentSelection() const
{
return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);
}
// string list functions
// ----------------------------------------------------------------------------
-int wxChoice::GetCount() const
+unsigned int wxChoice::GetCount() const
{
- return (int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);
+ return (unsigned int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);
}
-int wxChoice::FindString(const wxString& s) const
+int wxChoice::FindString(const wxString& s, bool bCase) const
{
#if defined(__WATCOMC__) && defined(__WIN386__)
// For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
// wxChoice::Do it the long way instead.
- int count = GetCount();
- for ( int i = 0; i < count; i++ )
+ unsigned int count = GetCount();
+ for ( unsigned int i = 0; i < count; i++ )
{
// as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
- if ( GetString(i).IsSameAs(s, false) )
+ if (GetString(i).IsSameAs(s, bCase))
return i;
}
//passed to SendMessage, so we have to do it ourselves in that case
if ( s.empty() )
{
- int count = GetCount();
- for ( int i = 0; i < count; i++ )
- {
- if ( GetString(i).empty() )
- return i;
- }
-
- return wxNOT_FOUND;
+ unsigned int count = GetCount();
+ for ( unsigned int i = 0; i < count; i++ )
+ {
+ if (GetString(i).empty())
+ return i;
+ }
+
+ return wxNOT_FOUND;
+ }
+ else if (bCase)
+ {
+ // back to base class search for not native search type
+ return wxItemContainerImmutable::FindString( s, bCase );
}
else
{
- int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
- (WPARAM)-1, (LPARAM)s.c_str());
+ int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
+ (WPARAM)-1, (LPARAM)s.wx_str());
- return pos == LB_ERR ? wxNOT_FOUND : pos;
+ return pos == LB_ERR ? wxNOT_FOUND : pos;
}
#endif // Watcom/!Watcom
}
-void wxChoice::SetString(int n, const wxString& s)
+void wxChoice::SetString(unsigned int n, const wxString& s)
{
- wxCHECK_RET( n >= 0 && n < GetCount(),
- wxT("invalid item index in wxChoice::SetString") );
+ wxCHECK_RET( IsValid(n), wxT("invalid item index in wxChoice::SetString") );
// we have to delete and add back the string as there is no way to change a
// string in place
- // we need to preserve the client data
- void *data;
- if ( m_clientDataItemsType != wxClientData_None )
- {
- data = DoGetItemClientData(n);
- }
- else // no client data
- {
- data = NULL;
- }
+ // we need to preserve the client data manually
+ void *oldData = NULL;
+ wxClientData *oldObjData = NULL;
+ if ( HasClientUntypedData() )
+ oldData = GetClientData(n);
+ else if ( HasClientObjectData() )
+ oldObjData = GetClientObject(n);
::SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
- ::SendMessage(GetHwnd(), CB_INSERTSTRING, n, (LPARAM)s.c_str() );
+ ::SendMessage(GetHwnd(), CB_INSERTSTRING, n, (LPARAM)s.wx_str() );
- if ( data )
- {
- DoSetItemClientData(n, data);
- }
- //else: it's already NULL by default
+ // restore the client data
+ if ( oldData )
+ SetClientData(n, oldData);
+ else if ( oldObjData )
+ SetClientObject(n, oldObjData);
InvalidateBestSize();
}
-wxString wxChoice::GetString(int n) const
+wxString wxChoice::GetString(unsigned int n) const
{
int len = (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
// client data
// ----------------------------------------------------------------------------
-void wxChoice::DoSetItemClientData( int n, void* clientData )
+void wxChoice::DoSetItemClientData(unsigned int n, void* clientData)
{
if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA,
n, (LPARAM)clientData) == CB_ERR )
}
}
-void* wxChoice::DoGetItemClientData( int n ) const
+void* wxChoice::DoGetItemClientData(unsigned int n) const
{
LPARAM rc = SendMessage(GetHwnd(), CB_GETITEMDATA, n, 0);
if ( rc == CB_ERR )
return (void *)rc;
}
-void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
-{
- DoSetItemClientData(n, clientData);
-}
-
-wxClientData* wxChoice::DoGetItemClientObject( int n ) const
-{
- return (wxClientData *)DoGetItemClientData(n);
-}
-
// ----------------------------------------------------------------------------
// wxMSW specific helpers
// ----------------------------------------------------------------------------
wxControl::DoSetSize(x, y, width, height, sizeFlags);
- // I'm commenting this out since the code appears to make choices
- // and comboxes too high when they have associated sizers. I'm sure this
- // is not the end of the story, which is why I'm leaving it #if'ed out for
- // now. JACS.
+ // If we're storing a pending size, make sure we store
+ // the original size for reporting back to the app.
+ if (m_pendingSize != wxDefaultSize)
+ m_pendingSize = wxSize(width, heightOrig);
+
+ // This solution works on XP, but causes choice/combobox lists to be
+ // too short on W2K and earlier.
#if 0
- // if the height specified for the visible part of the control is
- // different from the current one, we need to change it separately
- // as it is not affected by normal WM_SETSIZE
- if ( height != wxDefaultCoord )
+ int widthCurrent, heightCurrent;
+ DoGetSize(&widthCurrent, &heightCurrent);
+
+ // the height which we must pass to Windows should be the total height of
+ // the control including the drop down list while the height given to us
+ // is, of course, just the height of the permanently visible part of it
+ if ( height != wxDefaultCoord && height != heightCurrent )
+ {
+ // don't make the drop down list too tall, arbitrarily limit it to 40
+ // items max and also don't leave it empty
+ unsigned int nItems = GetCount();
+ if ( !nItems )
+ nItems = 9;
+ else if ( nItems > 24 )
+ nItems = 24;
+
+ // add space for the drop down list
+ const int hItem = SendMessage(GetHwnd(), CB_GETITEMHEIGHT, 0, 0);
+ height += hItem*(nItems + 1);
+ }
+ else // keep the same height as now
{
- const int delta = heightOrig - GetSize().y;
- if ( delta )
+ // normally wxWindow::DoSetSize() checks if we set the same size as the
+ // window already has and does nothing in this case, but for us the
+ // check fails as the size we pass to it includes the dropdown while
+ // the size returned by our GetSize() does not, so test if the size
+ // didn't really change ourselves here
+ if ( width == wxDefaultCoord || width == widthCurrent )
{
- int h = ::SendMessage(GetHwnd(), CB_GETITEMHEIGHT, (WPARAM)-1, 0);
- SendMessage(GetHwnd(), CB_SETITEMHEIGHT, (WPARAM)-1, h + delta);
+ // size doesn't change, what about position?
+ int xCurrent, yCurrent;
+ DoGetPosition(&xCurrent, &yCurrent);
+ const bool defMeansUnchanged = !(sizeFlags & wxSIZE_ALLOW_MINUS_ONE);
+ if ( ((x == wxDefaultCoord && defMeansUnchanged) || x == xCurrent)
+ &&
+ ((y == wxDefaultCoord && defMeansUnchanged) || y == yCurrent) )
+ {
+ // nothing changes, nothing to do
+ return;
+ }
+ }
+
+ // We cannot pass wxDefaultCoord as height to wxControl. wxControl uses
+ // wxGetWindowRect() to determine the current height of the combobox,
+ // and then again sets the combobox's height to that value. Unfortunately,
+ // wxGetWindowRect doesn't include the dropdown list's height (at least
+ // on Win2K), so this would result in a combobox with dropdown height of
+ // 1 pixel. We have to determine the default height ourselves and call
+ // wxControl with that value instead.
+ //
+ // Also notice that sometimes CB_GETDROPPEDCONTROLRECT seems to return
+ // wildly incorrect values (~32000) which looks like a bug in it, just
+ // ignore them in this case
+ RECT r;
+ if ( ::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT, 0, (LPARAM) &r)
+ && r.bottom < 30000 )
+ {
+ height = heightCurrent + r.bottom - r.top;
}
}
-#else
- wxUnusedVar(heightOrig);
+
+ wxControl::DoSetSize(x, y, width, height, sizeFlags);
#endif
}
{
// find the widest string
int wChoice = 0;
- const size_t nItems = GetCount();
- for ( size_t i = 0; i < nItems; i++ )
+ const unsigned int nItems = GetCount();
+ for ( unsigned int i = 0; i < nItems; i++ )
{
int wLine;
GetTextExtent(GetString(i), &wLine, NULL);
bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
{
- if ( param != CBN_SELCHANGE)
+ /*
+ The native control provides a great variety in the events it sends in
+ the different selection scenarios (undoubtedly for greater amusement of
+ the programmers using it). For the reference, here are the cases when
+ the final selection is accepted (things are quite interesting when it
+ is cancelled too):
+
+ A. Selecting with just the arrows without opening the dropdown:
+ 1. CBN_SELENDOK
+ 2. CBN_SELCHANGE
+
+ B. Opening dropdown with F4 and selecting with arrows:
+ 1. CBN_DROPDOWN
+ 2. many CBN_SELCHANGE while changing selection in the list
+ 3. CBN_SELENDOK
+ 4. CBN_CLOSEUP
+
+ C. Selecting with the mouse:
+ 1. CBN_DROPDOWN
+ -- no intermediate CBN_SELCHANGEs --
+ 2. CBN_SELENDOK
+ 3. CBN_CLOSEUP
+ 4. CBN_SELCHANGE
+
+ Admire the different order of messages in all of those cases, it must
+ surely have taken a lot of effort to Microsoft developers to achieve
+ such originality.
+ */
+ switch ( param )
{
- // "selection changed" is the only event we're after
- return false;
- }
+ case CBN_DROPDOWN:
+ // we use this value both because we don't want to track selection
+ // using CB_GETCURSEL while the dropdown is opened and because we
+ // need to reset the selection back to it if it's eventually
+ // cancelled by user
+ m_lastAcceptedSelection = GetCurrentSelection();
+ if ( m_lastAcceptedSelection == -1 )
+ {
+ // no current selection so no need to restore it later (this
+ // happens when opening a combobox containing text not from its
+ // list of items and we shouldn't erase this text)
+ m_lastAcceptedSelection = wxID_NONE;
+ }
+ break;
- int n = GetSelection();
- if (n > -1)
- {
- wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
- event.SetInt(n);
- event.SetEventObject(this);
- event.SetString(GetStringSelection());
- if ( HasClientObjectData() )
- event.SetClientObject( GetClientObject(n) );
- else if ( HasClientUntypedData() )
- event.SetClientData( GetClientData(n) );
- ProcessCommand(event);
+ case CBN_CLOSEUP:
+ // if the selection was accepted by the user, it should have been
+ // reset to wxID_NONE by CBN_SELENDOK, otherwise the selection was
+ // cancelled and we must restore the old one
+ if ( m_lastAcceptedSelection != wxID_NONE )
+ {
+ SetSelection(m_lastAcceptedSelection);
+ m_lastAcceptedSelection = wxID_NONE;
+ }
+ break;
+
+ case CBN_SELENDOK:
+ // reset it to prevent CBN_CLOSEUP from undoing the selection (it's
+ // ok to reset it now as GetCurrentSelection() will now return the
+ // same thing anyhow)
+ m_lastAcceptedSelection = wxID_NONE;
+
+ {
+ const int n = GetSelection();
+
+ wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
+ event.SetInt(n);
+ event.SetEventObject(this);
+
+ if ( n > -1 )
+ {
+ event.SetString(GetStringSelection());
+ InitCommandEventWithItems(event, n);
+ }
+
+ ProcessCommand(event);
+ }
+ break;
+
+ // don't handle CBN_SELENDCANCEL: just leave m_lastAcceptedSelection
+ // valid and the selection will be undone in CBN_CLOSEUP above
+
+ // don't handle CBN_SELCHANGE neither, we don't want to generate events
+ // while the dropdown is opened -- but do add it if we ever need this
+
+ default:
+ return false;
}
return true;
}
#endif // wxUSE_CHOICE && !(__SMARTPHONE__ && __WXWINCE__)
-
projects / wxWidgets.git / blobdiff