src/msw/choice.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        choice.cpp
   3 // Purpose:     wxChoice
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin to derive from wxChoiceBase
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "choice.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/choice.h"
  33     #include "wx/utils.h"
  34     #include "wx/log.h"
  35 #endif
  36
  37 #include "wx/msw/private.h"
  38
  39 #if !USE_SHARED_LIBRARY
  40     IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControl)
  41 #endif
  42
  43 // ============================================================================
  44 // implementation
  45 // ============================================================================
  46
  47 // ----------------------------------------------------------------------------
  48 // creation
  49 // ----------------------------------------------------------------------------
  50
  51 bool wxChoice::Create(wxWindow *parent,
  52                       wxWindowID id,
  53                       const wxPoint& pos,
  54                       const wxSize& size,
  55                       int n, const wxString choices[],
  56                       long style,
  57                       const wxValidator& validator,
  58                       const wxString& name)
  59 {
  60     if ( !CreateControl(parent, id, pos, size, style, validator, name) )
  61         return FALSE;
  62
  63     long msStyle = WS_CHILD | CBS_DROPDOWNLIST | WS_TABSTOP | WS_VISIBLE | WS_HSCROLL | WS_VSCROLL;
  64     if ( style & wxCB_SORT )
  65         msStyle |= CBS_SORT;
  66
  67     // the experience shows that wxChoice vs. wxComboBox distinction confuses
  68     // quite a few people - try to help them
  69     wxASSERT_MSG( !(style & wxCB_DROPDOWN) &&
  70                   !(style & wxCB_READONLY) &&
  71                   !(style & wxCB_SIMPLE),
  72                   wxT("this style flag is ignored by wxChoice, you "
  73                      "probably want to use a wxComboBox") );
  74
  75     if ( !MSWCreateControl(wxT("COMBOBOX"), msStyle) )
  76         return FALSE;
  77
  78     for ( int i = 0; i < n; i++ )
  79     {
  80         Append(choices[i]);
  81     }
  82
  83     SetSize(pos.x, pos.y, size.x, size.y);
  84
  85     return TRUE;
  86 }
  87
  88 wxChoice::~wxChoice()
  89 {
  90     Free();
  91 }
  92
  93 // ----------------------------------------------------------------------------
  94 // adding/deleting items to/from the list
  95 // ----------------------------------------------------------------------------
  96
  97 int wxChoice::DoAppend(const wxString& item)
  98 {
  99     int n = (int)SendMessage(GetHwnd(), CB_ADDSTRING, 0, (LONG)item.c_str());
 100     if ( n == CB_ERR )
 101     {
 102         wxLogLastError("SendMessage(CB_ADDSTRING)");
 103     }
 104
 105     return n;
 106 }
 107
 108 void wxChoice::Delete(int n)
 109 {
 110     wxCHECK_RET( n < GetCount(), wxT("invalid item index in wxChoice::Delete") );
 111
 112     if ( HasClientObjectData() )
 113     {
 114         delete GetClientObject(n);
 115     }
 116
 117     SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
 118 }
 119
 120 void wxChoice::Clear()
 121 {
 122     Free();
 123
 124     SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);
 125 }
 126
 127 void wxChoice::Free()
 128 {
 129     if ( HasClientObjectData() )
 130     {
 131         size_t count = GetCount();
 132         for ( size_t n = 0; n < count; n++ )
 133         {
 134             delete GetClientObject(n);
 135         }
 136     }
 137 }
 138
 139 // ----------------------------------------------------------------------------
 140 // selection
 141 // ----------------------------------------------------------------------------
 142
 143 int wxChoice::GetSelection() const
 144 {
 145     return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);
 146 }
 147
 148 void wxChoice::SetSelection(int n)
 149 {
 150     SendMessage(GetHwnd(), CB_SETCURSEL, n, 0);
 151 }
 152
 153 // ----------------------------------------------------------------------------
 154 // string list functions
 155 // ----------------------------------------------------------------------------
 156
 157 int wxChoice::GetCount() const
 158 {
 159     return (int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);
 160 }
 161
 162 int wxChoice::FindString(const wxString& s) const
 163 {
 164 #if defined(__WATCOMC__) && defined(__WIN386__)
 165     // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
 166     // wxChoice::Do it the long way instead.
 167     int count = GetCount();
 168     for ( int i = 0; i < count; i++ )
 169     {
 170         // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
 171         if ( GetString(i).IsSameAs(s, FALSE) )
 172             return i;
 173     }
 174
 175     return wxNOT_FOUND;
 176 #else // !Watcom
 177     int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
 178                                (WPARAM)-1, (LPARAM)s.c_str());
 179
 180     return pos == LB_ERR ? wxNOT_FOUND : pos;
 181 #endif // Watcom/!Watcom
 182 }
 183
 184 void wxChoice::SetString(int n, const wxString& s)
 185 {
 186     wxFAIL_MSG(wxT("not implemented"));
 187
 188 #if 0 // should do this, but no Insert() so far
 189     Delete(n);
 190     Insert(n + 1, s);
 191 #endif
 192 }
 193
 194 wxString wxChoice::GetString(int n) const
 195 {
 196     size_t len = (size_t)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
 197     wxString str;
 198     if (len) {
 199         if ( ::SendMessage(GetHwnd(), CB_GETLBTEXT, n,
 200                            (LPARAM)str.GetWriteBuf(len)) == CB_ERR ) {
 201             wxLogLastError("SendMessage(CB_GETLBTEXT)");
 202         }
 203         str.UngetWriteBuf();
 204     }
 205
 206     return str;
 207 }
 208
 209 // ----------------------------------------------------------------------------
 210 // client data
 211 // ----------------------------------------------------------------------------
 212
 213 void wxChoice::DoSetItemClientData( int n, void* clientData )
 214 {
 215     if ( SendMessage(GetHwnd(), CB_SETITEMDATA, n, (LPARAM)clientData) == CB_ERR )
 216     {
 217         wxLogLastError(wxT("CB_SETITEMDATA"));
 218     }
 219 }
 220
 221 void* wxChoice::DoGetItemClientData( int n ) const
 222 {
 223     LPARAM rc = SendMessage(GetHwnd(), CB_GETITEMDATA, n, 0);
 224     if ( rc == CB_ERR )
 225     {
 226         wxLogLastError(wxT("CB_GETITEMDATA"));
 227
 228         // unfortunately, there is no way to return an error code to the user
 229         rc = (LPARAM) NULL;
 230     }
 231
 232     return (void *)rc;
 233 }
 234
 235 void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
 236 {
 237     DoSetItemClientData(n, clientData);
 238 }
 239
 240 wxClientData* wxChoice::DoGetItemClientObject( int n ) const
 241 {
 242     return (wxClientData *)DoGetItemClientData(n);
 243 }
 244
 245 // ----------------------------------------------------------------------------
 246 // wxMSW specific helpers
 247 // ----------------------------------------------------------------------------
 248
 249 void wxChoice::DoSetSize(int x, int y,
 250                          int width, int height,
 251                          int sizeFlags)
 252 {
 253     // Ignore height parameter because height doesn't mean 'initially
 254     // displayed' height, it refers to the drop-down menu as well. The
 255     // wxWindows interpretation is different; also, getting the size returns
 256     // the _displayed_ size (NOT the drop down menu size) so
 257     // setting-getting-setting size would not work.
 258     wxControl::DoSetSize(x, y, width, -1, sizeFlags);
 259 }
 260
 261 wxSize wxChoice::DoGetBestSize()
 262 {
 263     // find the widest string
 264     int wLine;
 265     int wChoice = 0;
 266     int nItems = GetCount();
 267     for ( int i = 0; i < nItems; i++ )
 268     {
 269         wxString str(GetString(i));
 270         GetTextExtent(str, &wLine, NULL);
 271         if ( wLine > wChoice )
 272             wChoice = wLine;
 273     }
 274
 275     // give it some reasonable default value if there are no strings in the
 276     // list
 277     if ( wChoice == 0 )
 278         wChoice = 100;
 279
 280     // the combobox should be larger than the widest string
 281     int cx, cy;
 282     wxGetCharSize(GetHWND(), &cx, &cy, &GetFont());
 283
 284     wChoice += 5*cx;
 285
 286     // Choice drop-down list depends on number of items (limited to 10)
 287     size_t nStrings = nItems == 0 ? 10 : wxMin(10, nItems) + 1;
 288     int hChoice = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)*nStrings;
 289
 290     return wxSize(wChoice, hChoice);
 291 }
 292
 293 long wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
 294 {
 295     if ( nMsg == WM_LBUTTONUP )
 296     {
 297         int x = (int)LOWORD(lParam);
 298         int y = (int)HIWORD(lParam);
 299
 300         // Ok, this is truly weird, but if a panel with a wxChoice loses the
 301         // focus, then you get a *fake* WM_LBUTTONUP message with x = 65535 and
 302         // y = 65535. Filter out this nonsense.
 303         //
 304         // VZ: I'd like to know how to reproduce this please...
 305         if ( x == 65535 && y == 65535 )
 306             return 0;
 307     }
 308
 309     return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
 310 }
 311
 312 bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
 313 {
 314     if ( param != CBN_SELCHANGE)
 315     {
 316         // "selection changed" is the only event we're after
 317         return FALSE;
 318     }
 319
 320     int n = GetSelection();
 321     if (n > -1)
 322     {
 323         wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
 324         event.SetInt(n);
 325         event.SetEventObject(this);
 326         event.SetString(GetStringSelection());
 327         if ( HasClientObjectData() )
 328             event.SetClientObject( GetClientObject(n) );
 329         else if ( HasClientUntypedData() )
 330             event.SetClientData( GetClientData(n) );
 331         ProcessCommand(event);
 332     }
 333
 334     return TRUE;
 335 }
 336