X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cbeda384e51acb82e13994cb67ac1714669cae10..404b319a85dadd7decf7a5a5331020520031a41c:/src/msw/choice.cpp?ds=sidebyside diff --git a/src/msw/choice.cpp b/src/msw/choice.cpp index cf5b4e6ef0..30dad609d0 100644 --- a/src/msw/choice.cpp +++ b/src/msw/choice.cpp @@ -30,70 +30,15 @@ #ifndef WX_PRECOMP #include "wx/utils.h" + #include "wx/app.h" #include "wx/log.h" #include "wx/brush.h" #include "wx/settings.h" #endif -#include "wx/msw/private.h" +#include "wx/dynlib.h" -#if wxUSE_EXTENDED_RTTI -WX_DEFINE_FLAGS( wxChoiceStyle ) - -wxBEGIN_FLAGS( wxChoiceStyle ) - // 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) - -wxEND_FLAGS( wxChoiceStyle ) - -IMPLEMENT_DYNAMIC_CLASS_XTI(wxChoice, wxControlWithItems,"wx/choice.h") - -wxBEGIN_PROPERTIES_TABLE(wxChoice) - wxEVENT_PROPERTY( Select , wxEVT_COMMAND_CHOICE_SELECTED , 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 , wxChoiceStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style -wxEND_PROPERTIES_TABLE() - -wxBEGIN_HANDLERS_TABLE(wxChoice) -wxEND_HANDLERS_TABLE() - -wxCONSTRUCTOR_4( wxChoice , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size ) -#else -IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControlWithItems) -#endif -/* - TODO PROPERTIES - selection (long) - content (list) - item -*/ +#include "wx/msw/private.h" // ============================================================================ // implementation @@ -117,8 +62,8 @@ bool wxChoice::Create(wxWindow *parent, wxASSERT_MSG( !(style & wxCB_DROPDOWN) && !(style & wxCB_READONLY) && !(style & wxCB_SIMPLE), - _T("this style flag is ignored by wxChoice, you ") - _T("probably want to use a wxComboBox") ); + wxT("this style flag is ignored by wxChoice, you ") + wxT("probably want to use a wxComboBox") ); return CreateAndInit(parent, id, pos, size, n, choices, style, validator, name); @@ -142,15 +87,8 @@ bool wxChoice::CreateAndInit(wxWindow *parent, return false; - // choice/combobox normally has "white" (depends on colour scheme, of - // course) background rather than inheriting the parent's background - SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW)); - // initialize the controls contents - for ( int i = 0; i < n; i++ ) - { - Append(choices[i]); - } + Append(n, choices); // and now we may finally size the control properly (if needed) SetInitialSize(size); @@ -224,11 +162,66 @@ WXDWORD wxChoice::MSWGetStyle(long style, WXDWORD *exstyle) const return msStyle; } +#ifndef EP_EDITTEXT + #define EP_EDITTEXT 1 + #define ETS_NORMAL 1 +#endif + +wxVisualAttributes +wxChoice::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant)) +{ + // it is important to return valid values for all attributes from here, + // GetXXX() below rely on this + wxVisualAttributes attrs; + + // FIXME: Use better dummy window? + wxWindow* wnd = wxTheApp->GetTopWindow(); + if (!wnd) + return attrs; + + attrs.font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT); + + // there doesn't seem to be any way to get the text colour using themes + // API: TMT_TEXTCOLOR doesn't work neither for EDIT nor COMBOBOX + attrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT); + + // NB: use EDIT, not COMBOBOX (the latter works in XP but not Vista) + attrs.colBg = wnd->MSWGetThemeColour(L"EDIT", + EP_EDITTEXT, + ETS_NORMAL, + ThemeColourBackground, + wxSYS_COLOUR_WINDOW); + + return attrs; +} + wxChoice::~wxChoice() { Clear(); } +bool wxChoice::MSWGetComboBoxInfo(tagCOMBOBOXINFO* info) const +{ + // TODO-Win9x: Get rid of this once we officially drop support for Win9x + // and just call the function directly. +#if wxUSE_DYNLIB_CLASS + typedef BOOL (WINAPI *GetComboBoxInfo_t)(HWND, tagCOMBOBOXINFO*); + static GetComboBoxInfo_t s_pfnGetComboBoxInfo = NULL; + static bool s_triedToLoad = false; + if ( !s_triedToLoad ) + { + s_triedToLoad = true; + wxLoadedDLL dllUser32("user32.dll"); + wxDL_INIT_FUNC(s_pfn, GetComboBoxInfo, dllUser32); + } + + if ( s_pfnGetComboBoxInfo ) + return (*s_pfnGetComboBoxInfo)(GetHwnd(), info) != 0; +#endif // wxUSE_DYNLIB_CLASS + + return false; +} + // ---------------------------------------------------------------------------- // adding/deleting items to/from the list // ---------------------------------------------------------------------------- @@ -265,7 +258,7 @@ int wxChoice::DoInsertItems(const wxArrayStringsAdapter& items, // we need to refresh our size in order to have enough space for the // newly added items if ( !IsFrozen() ) - UpdateVisibleHeight(); + MSWUpdateDropDownHeight(); InvalidateBestSize(); @@ -279,7 +272,7 @@ void wxChoice::DoDeleteOneItem(unsigned int n) SendMessage(GetHwnd(), CB_DELETESTRING, n, 0); if ( !IsFrozen() ) - UpdateVisibleHeight(); + MSWUpdateDropDownHeight(); InvalidateBestSize(); } @@ -289,7 +282,7 @@ void wxChoice::DoClear() SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0); if ( !IsFrozen() ) - UpdateVisibleHeight(); + MSWUpdateDropDownHeight(); InvalidateBestSize(); } @@ -364,7 +357,7 @@ int wxChoice::FindString(const wxString& s, bool bCase) const else { int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT, - (WPARAM)-1, (LPARAM)s.wx_str()); + (WPARAM)-1, wxMSW_CONV_LPARAM(s)); return pos == LB_ERR ? wxNOT_FOUND : pos; } @@ -386,8 +379,12 @@ void wxChoice::SetString(unsigned int n, const wxString& s) else if ( HasClientObjectData() ) oldObjData = GetClientObject(n); + // and also the selection if we're going to delete the item that was + // selected + const bool wasSelected = static_cast(n) == GetSelection(); + ::SendMessage(GetHwnd(), CB_DELETESTRING, n, 0); - ::SendMessage(GetHwnd(), CB_INSERTSTRING, n, (LPARAM)s.wx_str() ); + ::SendMessage(GetHwnd(), CB_INSERTSTRING, n, wxMSW_CONV_LPARAM(s) ); // restore the client data if ( oldData ) @@ -395,6 +392,11 @@ void wxChoice::SetString(unsigned int n, const wxString& s) else if ( oldObjData ) SetClientObject(n, oldObjData); + // and the selection + if ( wasSelected ) + SetSelection(n); + + // the width could have changed so the best size needs to be recomputed InvalidateBestSize(); } @@ -436,7 +438,7 @@ void wxChoice::DoSetItemClientData(unsigned int n, void* clientData) void* wxChoice::DoGetItemClientData(unsigned int n) const { LPARAM rc = SendMessage(GetHwnd(), CB_GETITEMDATA, n, 0); - if ( rc == CB_ERR ) + if ( rc == CB_ERR && GetLastError() != ERROR_SUCCESS ) { wxLogLastError(wxT("CB_GETITEMDATA")); @@ -448,13 +450,45 @@ void* wxChoice::DoGetItemClientData(unsigned int n) const } // ---------------------------------------------------------------------------- -// wxMSW specific helpers +// wxMSW-specific geometry management // ---------------------------------------------------------------------------- -void wxChoice::UpdateVisibleHeight() +namespace +{ + +// there is a difference between the height passed to CB_SETITEMHEIGHT and the +// real height of the combobox; it is probably not constant for all Windows +// versions/settings but right now I don't know how to find what it is so it is +// temporarily hardcoded to its value under XP systems with normal fonts sizes +const int COMBO_HEIGHT_ADJ = 6; + +} // anonymous namespace + +void wxChoice::MSWUpdateVisibleHeight() +{ + if ( m_heightOwn != wxDefaultCoord ) + { + ::SendMessage(GetHwnd(), CB_SETITEMHEIGHT, + (WPARAM)-1, m_heightOwn - COMBO_HEIGHT_ADJ); + } +} + +#if wxUSE_DEFERRED_SIZING +void wxChoice::MSWEndDeferWindowPos() +{ + // we can only set the height of the choice itself now as it is reset to + // default every time the control is resized + MSWUpdateVisibleHeight(); + + wxChoiceBase::MSWEndDeferWindowPos(); +} +#endif // wxUSE_DEFERRED_SIZING + +void wxChoice::MSWUpdateDropDownHeight() { // be careful to not change the width here - DoSetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, GetSize().y, wxSIZE_USE_EXISTING); + DoSetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, GetSize().y, + wxSIZE_USE_EXISTING); } void wxChoice::DoMoveWindow(int x, int y, int width, int height) @@ -477,88 +511,191 @@ void wxChoice::DoMoveWindow(int x, int y, int width, int height) void wxChoice::DoGetSize(int *w, int *h) const { + wxControl::DoGetSize(w, h); + // this is weird: sometimes, the height returned by Windows is clearly the // total height of the control including the drop down list -- but only - // sometimes, and normally it isn't... I have no idea about what to do with - // this - wxControl::DoGetSize(w, h); + // sometimes, and sometimes it isn't so work around this here by using our + // own stored value if we have it + if ( h && m_heightOwn != wxDefaultCoord ) + *h = m_heightOwn; } void wxChoice::DoSetSize(int x, int y, int width, int height, int sizeFlags) { - int heightOrig = height; + const int heightBest = GetBestSize().y; + + // we need the real height below so get the current one if it's not given + if ( height == wxDefaultCoord ) + { + // height not specified, use the same as before + DoGetSize(NULL, &height); + } + else if ( height == heightBest ) + { + // we don't need to manually manage our height, let the system use the + // default one + m_heightOwn = wxDefaultCoord; + } + else // non-default height specified + { + // set our new own height but be careful not to make it too big: the + // native control apparently stores it as a single byte and so setting + // own height to 256 pixels results in default height being used (255 + // is still ok) + m_heightOwn = height; + + if ( m_heightOwn > UCHAR_MAX ) + m_heightOwn = UCHAR_MAX; + // nor too small: see MSWUpdateVisibleHeight() + else if ( m_heightOwn < COMBO_HEIGHT_ADJ ) + m_heightOwn = COMBO_HEIGHT_ADJ; + } + // 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 ) + // is, of course, just the height of the permanently visible part of it so + // add the drop down height to it + + // don't make the drop down list too tall, arbitrarily limit it to 30 + // items max and also don't make it too small if it's currently empty + size_t nItems = GetCount(); + if (!HasFlag(wxCB_SIMPLE)) { - // don't make the drop down list too tall, arbitrarily limit it to 40 - // items max and also don't leave it empty - size_t 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 if ( nItems > 30 ) + nItems = 30; } + + const int hItem = SendMessage(GetHwnd(), CB_GETITEMHEIGHT, 0, 0); + int heightWithItems = 0; + if (!HasFlag(wxCB_SIMPLE)) + // The extra item (" + 1") is required to prevent a vertical + // scrollbar from appearing with comctl32.dll versions earlier + // than 6.0 (such as found in Win2k). + heightWithItems = height + hItem*(nItems + 1); else + heightWithItems = SetHeightSimpleComboBox(nItems); + + + // do resize the native control + wxControl::DoSetSize(x, y, width, heightWithItems, sizeFlags); + + + // make the control itself of the requested height: notice that this + // must be done after changing its size or it has no effect (apparently + // the height is reset to default during the control layout) and that it's + // useless to do it when using the deferred sizing -- in this case it + // will be done from MSWEndDeferWindowPos() +#if wxUSE_DEFERRED_SIZING + if ( m_pendingSize == wxDefaultSize ) { - // 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. - int w, h; - RECT r; - DoGetSize(&w, &h); - if (::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT, 0, (LPARAM) &r) != 0) - { - height = h + r.bottom - r.top; - } + // not using deferred sizing, update it immediately + MSWUpdateVisibleHeight(); } + else // in the middle of deferred sizing + { + // we need to report the size of the visible part of the control back + // in GetSize() and not height stored by DoSetSize() in m_pendingSize + m_pendingSize = wxSize(width, height); + } +#else // !wxUSE_DEFERRED_SIZING + // always update the visible height immediately + MSWUpdateVisibleHeight(); +#endif // wxUSE_DEFERRED_SIZING +} - wxControl::DoSetSize(x, y, width, height, sizeFlags); +wxSize wxChoice::DoGetBestSize() const +{ + // The base version returns the size of the largest string + return GetSizeFromTextSize(wxChoiceBase::DoGetBestSize().x); +} - // 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); +int wxChoice::SetHeightSimpleComboBox(int nItems) const +{ + int cx, cy; + wxGetCharSize( GetHWND(), &cx, &cy, GetFont() ); + int hItem = SendMessage(GetHwnd(), CB_GETITEMHEIGHT, (WPARAM)-1, 0); + return EDIT_HEIGHT_FROM_CHAR_HEIGHT( cy ) * wxMin( wxMax( nItems, 3 ), 6 ) + hItem - 1; } -wxSize wxChoice::DoGetBestSize() const +wxSize wxChoice::DoGetSizeFromTextSize(int xlen, int ylen) const { - // find the widest string - int wChoice = 0; - const unsigned int nItems = GetCount(); - for ( unsigned int i = 0; i < nItems; i++ ) + int cHeight = GetCharHeight(); + + // We are interested in the difference of sizes between the whole control + // and its child part. I.e. arrow, separators, etc. + wxSize tsize(xlen, 0); + + // FIXME-VC6: Only VC6 needs this guard, see WINVER definition in + // include/wx/msw/wrapwin.h +#if defined(WINVER) && WINVER >= 0x0500 + WinStruct info; + if ( MSWGetComboBoxInfo(&info) ) { - int wLine; - GetTextExtent(GetString(i), &wLine, NULL); - if ( wLine > wChoice ) - wChoice = wLine; + tsize.x += info.rcItem.left + info.rcButton.right - info.rcItem.right + + info.rcItem.left + 3; // right and extra margins + } + else // Just use some rough approximation. +#endif // WINVER >= 0x0500 + { + tsize.x += 4*cHeight; } - // give it some reasonable default value if there are no strings in the - // list - if ( wChoice == 0 ) - wChoice = 100; + // set height on our own + if( HasFlag( wxCB_SIMPLE ) ) + tsize.y = SetHeightSimpleComboBox(GetCount()); + else + tsize.y = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cHeight); - // the combobox should be slightly larger than the widest string - wChoice += 5*GetCharWidth(); + // Perhaps the user wants something different from CharHeight + if ( ylen > 0 ) + tsize.IncBy(0, ylen - cHeight); - wxSize best(wChoice, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight())); - CacheBestSize(best); - return best; + return tsize; } +// ---------------------------------------------------------------------------- +// Popup operations +// ---------------------------------------------------------------------------- + +void wxChoice::MSWDoPopupOrDismiss(bool show) +{ + wxASSERT_MSG( !HasFlag(wxCB_SIMPLE), + wxT("can't popup/dismiss the list for simple combo box") ); + + // we *must* set focus to the combobox before showing or hiding the drop + // down as without this we get WM_LBUTTONDOWN messages with invalid HWND + // when hiding it (whether programmatically or manually) resulting in a + // crash when we pass them to IsDialogMessage() + // + // this can be seen in the combo page of the widgets sample under Windows 7 + SetFocus(); + + ::SendMessage(GetHwnd(), CB_SHOWDROPDOWN, show, 0); +} + +bool wxChoice::Show(bool show) +{ + if ( !wxChoiceBase::Show(show) ) + return false; + + // When hiding the combobox, we also need to hide its popup part as it + // doesn't happen automatically. + if ( !show && ::SendMessage(GetHwnd(), CB_GETDROPPEDSTATE, 0, 0) ) + MSWDoPopupOrDismiss(false); + + return true; +} + +// ---------------------------------------------------------------------------- +// MSW message handlers +// ---------------------------------------------------------------------------- + WXLRESULT wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam) { switch ( nMsg ) @@ -603,9 +740,7 @@ bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id)) /* 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): + the programmers using it). Here are the different cases: A. Selecting with just the arrows without opening the dropdown: 1. CBN_SELENDOK @@ -627,6 +762,12 @@ bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id)) 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. + + Additionally, notice that CBN_SELENDCANCEL doesn't seem to actually + cancel anything, if we get CBN_SELCHANGE before it, as it happens in + the case (B), the selection is still accepted. This doesn't make much + sense and directly contradicts MSDN documentation but is how the native + comboboxes behave and so we do the same thing. */ switch ( param ) { @@ -639,44 +780,40 @@ bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id)) break; 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 ) + if ( m_pendingSelection != wxID_NONE ) { - SetSelection(m_lastAcceptedSelection); - m_lastAcceptedSelection = wxID_NONE; + // This can only happen in the case (B), so set the item + // selected in the drop down as our real selection. + SendSelectionChangedEvent(wxEVT_COMMAND_CHOICE_SELECTED); + m_pendingSelection = 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); + // Reset the variables to prevent CBN_CLOSEUP from doing anything, + // it's not needed if we do get CBN_SELENDOK. + m_lastAcceptedSelection = + m_pendingSelection = wxID_NONE; - if ( n > -1 ) - { - event.SetString(GetStringSelection()); - InitCommandEventWithItems(event, n); - } - - ProcessCommand(event); - } + SendSelectionChangedEvent(wxEVT_COMMAND_CHOICE_SELECTED); break; - // don't handle CBN_SELENDCANCEL: just leave m_lastAcceptedSelection - // valid and the selection will be undone in CBN_CLOSEUP above + case CBN_SELCHANGE: + // If we get this event after CBN_SELENDOK, i.e. cases (A) or (C) + // above, we don't have anything to do. But in the case (B) we need + // to remember that the selection should really change once the + // drop down is closed. + if ( m_lastAcceptedSelection != wxID_NONE ) + m_pendingSelection = GetCurrentSelection(); + break; - // 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 + case CBN_SELENDCANCEL: + // Do not reset m_pendingSelection here -- it would make sense but, + // as described above, native controls keep the selection even when + // closing the drop down by pressing Escape or TAB, so conform to + // their behaviour. + m_lastAcceptedSelection = wxID_NONE; + break; default: return false; @@ -687,7 +824,7 @@ bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id)) WXHBRUSH wxChoice::MSWControlColor(WXHDC hDC, WXHWND hWnd) { - if ( !IsEnabled() ) + if ( !IsThisEnabled() ) return MSWControlColorDisabled(hDC); return wxChoiceBase::MSWControlColor(hDC, hWnd);