cleaned Harm's new wxHTML help code

[wxWidgets.git] / src / msw / choice.cpp

diff --git a/src/msw/choice.cpp b/src/msw/choice.cpp
index 850211d0dd21810d63ea816e993c1642f36545ca..c6a9f7909f1286279a058759f7965290cddc90df 100644 (file)
--- a/src/msw/choice.cpp
+++ b/src/msw/choice.cpp
@@ -2,349 +2,332 @@
 // Name:        choice.cpp
 // Purpose:     wxChoice
 // Author:      Julian Smart
 // Name:        choice.cpp
 // Purpose:     wxChoice
 // Author:      Julian Smart

-// Modified by:
+// Modified by: Vadim Zeitlin to derive from wxChoiceBase

 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem

-// Licence:    wxWindows license
+// Licence:     wxWindows license

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+

 #ifdef __GNUG__
 #ifdef __GNUG__

-#pragma implementation "choice.h"
+    #pragma implementation "choice.h"

 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #ifndef WX_PRECOMP
 #endif
 
 #ifndef WX_PRECOMP

-#include "wx/choice.h"
+    #include "wx/choice.h"
+    #include "wx/utils.h"
+    #include "wx/log.h"

 #endif
 
 #include "wx/msw/private.h"
 
 #if !USE_SHARED_LIBRARY
 #endif
 
 #include "wx/msw/private.h"
 
 #if !USE_SHARED_LIBRARY

-IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControl)
+    IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControl)

 #endif
 
 #endif
 

-bool wxChoice::MSWCommand(const WXUINT param, const WXWORD WXUNUSED(id))
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// creation
+// ----------------------------------------------------------------------------
+
+bool wxChoice::Create(wxWindow *parent,
+                      wxWindowID id,
+                      const wxPoint& pos,
+                      const wxSize& size,
+                      int n, const wxString choices[],
+                      long style,
+                      const wxValidator& validator,
+                      const wxString& name)

 {
 {

-  if (param == CBN_SELCHANGE)
-  {
-    wxCommandEvent event(wxEVENT_TYPE_CHOICE_COMMAND, m_windowId);
-    event.SetInt(GetSelection());
-    event.SetEventObject(this);
-    event.SetString(copystring(GetStringSelection()));
-    ProcessCommand(event);
-    delete[] event.GetString();
+    if ( !CreateControl(parent, id, pos, size, style, validator, name) )
+        return FALSE;
+
+    long msStyle = WS_CHILD | CBS_DROPDOWNLIST | WS_TABSTOP | WS_VISIBLE | WS_HSCROLL | WS_VSCROLL;
+    if ( style & wxCB_SORT )
+        msStyle |= CBS_SORT;
+
+    // the experience shows that wxChoice vs. wxComboBox distinction confuses
+    // quite a few people - try to help them
+    wxASSERT_MSG( !(style & wxCB_DROPDOWN) &&
+                  !(style & wxCB_READONLY) &&
+                  !(style & wxCB_SIMPLE),
+                  wxT("this style flag is ignored by wxChoice, you "
+                     "probably want to use a wxComboBox") );
+
+    if ( !MSWCreateControl(wxT("COMBOBOX"), msStyle) )
+        return FALSE;
+
+    for ( int i = 0; i < n; i++ )
+    {
+        Append(choices[i]);
+    }
+
+    SetSize(pos.x, pos.y, size.x, size.y);
+

     return TRUE;
     return TRUE;

-  }
-  else return FALSE;

 }
 
 }
 

-bool wxChoice::Create(wxWindow *parent, const wxWindowID id,
-           const wxPoint& pos,
-           const wxSize& size,
-                  const int n, const wxString choices[],
-                  const long style,
-           const wxValidator& validator,
-           const wxString& name)
+wxChoice::~wxChoice()

 {
 {

-  SetName(name);
-  SetValidator(validator);
-  if (parent) parent->AddChild(this);
-  SetBackgroundColour(parent->GetDefaultBackgroundColour()) ;
-  SetForegroundColour(parent->GetDefaultForegroundColour()) ;
-  no_strings = n;
-
-  m_windowStyle = style;
-
-  if ( id == -1 )
-       m_windowId = (int)NewControlId();
-  else
-       m_windowId = id;
-
-  int x = pos.x;
-  int y = pos.y;
-  int width = size.x;
-  int height = size.y;
-
-  long msStyle = WS_CHILD | CBS_DROPDOWNLIST | WS_HSCROLL | WS_VSCROLL
-                   | WS_TABSTOP | WS_VISIBLE;
-  if (m_windowStyle & wxCB_SORT)
-    msStyle |= CBS_SORT;
-
-  bool want3D;
-  WXDWORD exStyle = Determine3DEffects(WS_EX_CLIENTEDGE, &want3D) ;
-
-  // Even with extended styles, need to combine with WS_BORDER
-  // for them to look right.
-  if (want3D || (m_windowStyle & wxSIMPLE_BORDER) || (m_windowStyle & wxRAISED_BORDER) ||
-       (m_windowStyle & wxSUNKEN_BORDER) || (m_windowStyle & wxDOUBLE_BORDER))
-    msStyle |= WS_BORDER;
-
-  HWND wx_combo = CreateWindowEx(exStyle, "COMBOBOX", NULL,
-                   msStyle,
-                   0, 0, 0, 0, (HWND) parent->GetHWND(), (HMENU)m_windowId,
-                   wxGetInstance(), NULL);
-/*
-#if CTL3D
-  if (want3D)
-  {
-    m_useCtl3D = TRUE;
-    Ctl3dSubclassCtl(wx_combo); // Does CTL3D affect the combobox? I think not.
-  }
-#endif
-*/
+    Free();
+}

 
 

-  m_hWnd = (WXHWND) wx_combo;
+// ----------------------------------------------------------------------------
+// adding/deleting items to/from the list
+// ----------------------------------------------------------------------------

 
 

-  // Subclass again for purposes of dialog editing mode
-  SubclassWin((WXHWND) wx_combo);
+int wxChoice::DoAppend(const wxString& item)
+{
+    int n = (int)SendMessage(GetHwnd(), CB_ADDSTRING, 0, (LONG)item.c_str());
+    if ( n == CB_ERR )
+    {
+        wxLogLastError("SendMessage(CB_ADDSTRING)");
+    }

 
 

-  SetFont(* parent->GetFont());
+    return n;
+}

 
 

-  int i;
-  for (i = 0; i < n; i++)
-    SendMessage(wx_combo, CB_INSERTSTRING, i, (LONG)(const char *)choices[i]);
-  SendMessage(wx_combo, CB_SETCURSEL, i, 0);
+void wxChoice::Delete(int n)
+{
+    wxCHECK_RET( n < GetCount(), wxT("invalid item index in wxChoice::Delete") );

 
 

-  SetSize(x, y, width, height);
+    if ( HasClientObjectData() )
+    {
+        delete GetClientObject(n);
+    }

 
 

-  return TRUE;
+    SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);

 }
 
 }
 

-void wxChoice::Append(const wxString& item)
+void wxChoice::Clear()

 {
 {

-  SendMessage((HWND) GetHWND(), CB_ADDSTRING, 0, (LONG)(const char *)item);
+    Free();

 
 

-  no_strings ++;
+    SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);

 }
 
 }
 

-void wxChoice::Delete(const int n)
+void wxChoice::Free()

 {
 {

-  no_strings = (int)SendMessage((HWND) GetHWND(), CB_DELETESTRING, n, 0);
+    if ( HasClientObjectData() )
+    {
+        size_t count = GetCount();
+        for ( size_t n = 0; n < count; n++ )
+        {
+            delete GetClientObject(n);
+        }
+    }

 }
 
 }
 

-void wxChoice::Clear(void)
-{
-  SendMessage((HWND) GetHWND(), CB_RESETCONTENT, 0, 0);
+// ----------------------------------------------------------------------------
+// selection
+// ----------------------------------------------------------------------------

 
 

-  no_strings = 0;
+int wxChoice::GetSelection() const
+{
+    return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);

 }
 
 }
 

-
-int wxChoice::GetSelection(void) const
+void wxChoice::SetSelection(int n)

 {
 {

-  return (int)SendMessage((HWND) GetHWND(), CB_GETCURSEL, 0, 0);
+    SendMessage(GetHwnd(), CB_SETCURSEL, n, 0);

 }
 
 }
 

-void wxChoice::SetSelection(const int n)
+// ----------------------------------------------------------------------------
+// string list functions
+// ----------------------------------------------------------------------------
+
+int wxChoice::GetCount() const

 {
 {

-  SendMessage((HWND) GetHWND(), CB_SETCURSEL, n, 0);
+    return (int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);

 }
 
 int wxChoice::FindString(const wxString& s) const
 {
 #if defined(__WATCOMC__) && defined(__WIN386__)
 }
 
 int wxChoice::FindString(const wxString& s) const
 {
 #if defined(__WATCOMC__) && defined(__WIN386__)

-  // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
-  // Do it the long way instead.
-  char buf[512];
-  for (int i = 0; i < Number(); i++)
-  {
-    int len = (int)SendMessage((HWND) GetHWND(), CB_GETLBTEXT, i, (LPARAM)(LPSTR)buf);
-    buf[len] = 0;
-    if (strcmp(buf, (const char *)s) == 0)
-      return i;
-  }
-  return -1;
-#else
- int pos = (int)SendMessage((HWND) GetHWND(), CB_FINDSTRINGEXACT, (WPARAM)-1, (LPARAM)(LPSTR)(const char *)s);
- if (pos == LB_ERR)
-   return -1;
- else
-   return pos;
-#endif
+    // 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++ )
+    {
+        // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
+        if ( GetString(i).IsSameAs(s, FALSE) )
+            return i;
+    }
+
+    return wxNOT_FOUND;
+#else // !Watcom
+    int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
+                               (WPARAM)-1, (LPARAM)s.c_str());
+
+    return pos == LB_ERR ? wxNOT_FOUND : pos;
+#endif // Watcom/!Watcom

 }
 
 }
 

-wxString wxChoice::GetString(const int n) const
+void wxChoice::SetString(int n, const wxString& s)

 {
 {

-  int len = (int)SendMessage((HWND) GetHWND(), CB_GETLBTEXT, n, (long)wxBuffer);
-  wxBuffer[len] = 0;
-  return wxString(wxBuffer);
+    wxFAIL_MSG(wxT("not implemented"));
+
+#if 0 // should do this, but no Insert() so far
+    Delete(n);
+    Insert(n + 1, s);
+#endif

 }
 
 }
 

-void wxChoice::SetSize(const int x, const int y, const int width, const int height, const int sizeFlags)
+wxString wxChoice::GetString(int n) const

 {
 {

-  int currentX, currentY;
-  GetPosition(&currentX, &currentY);
-
-  int x1 = x;
-  int y1 = y;
-  int w1 = width;
-  int h1 = height;
-
-  if (x == -1 || (sizeFlags & wxSIZE_ALLOW_MINUS_ONE))
-    x1 = currentX;
-  if (y == -1 || (sizeFlags & wxSIZE_ALLOW_MINUS_ONE))
-    y1 = currentY;
-
-  // If we're prepared to use the existing size, then...
-  if (width == -1 && height == -1 && ((sizeFlags & wxSIZE_AUTO) != wxSIZE_AUTO))
-  {
-    GetSize(&w1, &h1);
-  }
-
-  int cx; // button font dimensions
-  int cy;
-  wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
-
-  float control_width, control_height;
-
-  // Ignore height parameter because height doesn't
-  // mean 'initially displayed' height, it refers to the
-  // drop-down menu as well. The wxWindows interpretation
-  // is different; also, getting the size returns the
-  // _displayed_ size (NOT the drop down menu size)
-  // so setting-getting-setting size would not work.
-  h1 = -1;
-
-  // Deal with default size (using -1 values)
-  if (width <= 0)
-  {
-    // Find the longest string
-    if (no_strings == 0)
-      control_width = (float)100.0;
-    else
-    {
-      float len, ht;
-      float longest = (float)0.0;
-      int i;
-      for (i = 0; i < no_strings; i++)
-      {
-        wxString str(GetString(i));
-        GetTextExtent(str, &len, &ht, NULL, NULL,GetFont());
-        if ( len > longest) longest = len;
-      }
-
-      control_width = (float)(int)(longest + cx*5);
+    size_t len = (size_t)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
+    wxString str;
+    if (len) {
+        if ( ::SendMessage(GetHwnd(), CB_GETLBTEXT, n,
+                           (LPARAM)str.GetWriteBuf(len)) == CB_ERR ) {
+            wxLogLastError("SendMessage(CB_GETLBTEXT)");
+        }
+        str.UngetWriteBuf();

     }
     }

-  }
-
-  // Choice drop-down list depends on number of items (limited to 10)
-  if (h1 <= 0)
-  {
-    if (no_strings == 0)
-      h1 = (int)(EDIT_CONTROL_FACTOR*cy*10.0);
-    else h1 = (int)(EDIT_CONTROL_FACTOR*cy*(wxMin(10, no_strings) + 1));
-  }
-
-  // If non-default width...
-  if (width >= 0)
-    control_width = (float)width;
-
-  control_height = (float)h1;
-
-  // Calculations may have made text size too small
-  if (control_height <= 0)
-    control_height = (float)(int)(cy*EDIT_CONTROL_FACTOR) ;
-
-  if (control_width <= 0)
-    control_width = (float)100.0;
-
-  MoveWindow((HWND) GetHWND(), x1, y1,
-                              (int)control_width, (int)control_height, TRUE);
-
-/*
-#if WXWIN_COMPATIBILITY
-  GetEventHandler()->OldOnSize(width, height);
-#else
-  wxSizeEvent event(wxSize(width, height), m_windowId);
-  event.eventObject = this;
-  GetEventHandler()->ProcessEvent(event);
-#endif
-*/
+
+    return str;

 }
 
 }
 

-WXHBRUSH wxChoice::OnCtlColor(const WXHDC pDC, const WXHWND pWnd, const WXUINT nCtlColor,
-                       WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
+// ----------------------------------------------------------------------------
+// client data
+// ----------------------------------------------------------------------------
+
+void wxChoice::DoSetItemClientData( int n, void* clientData )

 {
 {

-       return 0;
+    if ( SendMessage(GetHwnd(), CB_SETITEMDATA, n, (LPARAM)clientData) == CB_ERR )
+    {
+        wxLogLastError(wxT("CB_SETITEMDATA"));
+    }

 }
 
 }
 

-long wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+void* wxChoice::DoGetItemClientData( int n ) const

 {
 {

-    switch (nMsg)
+    LPARAM rc = SendMessage(GetHwnd(), CB_GETITEMDATA, n, 0);
+    if ( rc == CB_ERR )

     {
     {

-/*
-      case WM_GETDLGCODE:
-      {
-        if (GetWindowStyleFlag() & wxPROCESS_ENTER)
-          return DLGC_WANTALLKEYS;
-        break;
-      }
-*/
-/*
-      case WM_CHAR: // Always an ASCII character
-      {
-        if (wParam == VK_RETURN)
-        {
-          wxCommandEvent event(wxEVENT_TYPE_TEXT_ENTER_COMMAND);
-          event.commandString = ((wxTextCtrl *)item)->GetValue();
-          event.eventObject = item;
-          item->ProcessCommand(event);
-          return FALSE;
-        }
-        break;
-      }
-*/
-      case WM_LBUTTONUP:
-      {
-        int x = (int)LOWORD(lParam);
-        int y = (int)HIWORD(lParam);
+        wxLogLastError(wxT("CB_GETITEMDATA"));

 
 

-       // Ok, this is truly weird, but if a panel with a wxChoice loses the
-       // focus, then you get a *fake* WM_LBUTTONUP message
-       // with x = 65535 and y = 65535.
-       // Filter out this nonsense.
-       if (x == 65535 && y == 65535)
-         return Default();
-       break;
-      }
+        // unfortunately, there is no way to return an error code to the user
+        rc = (LPARAM) NULL;

     }
 
     }
 

-  return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
+    return (void *)rc;
+}
+
+void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
+{
+    DoSetItemClientData(n, clientData);
+}
+
+wxClientData* wxChoice::DoGetItemClientObject( int n ) const
+{
+    return (wxClientData *)DoGetItemClientData(n);

 }
 
 }
 

-wxString wxChoice::GetStringSelection (void) const
+// ----------------------------------------------------------------------------
+// wxMSW specific helpers
+// ----------------------------------------------------------------------------
+
+void wxChoice::DoSetSize(int x, int y,
+                         int width, int height,
+                         int sizeFlags)

 {
 {

-  int sel = GetSelection ();
-  if (sel > -1)
-    return wxString(this->GetString (sel));
-  else
-    return wxString("");
+    // Ignore height parameter because height doesn't mean 'initially
+    // displayed' height, it refers to the drop-down menu as well. The
+    // wxWindows interpretation is different; also, getting the size returns
+    // the _displayed_ size (NOT the drop down menu size) so
+    // setting-getting-setting size would not work.
+    wxControl::DoSetSize(x, y, width, -1, sizeFlags);

 }
 
 }
 

-bool wxChoice::SetStringSelection (const wxString& s)
+wxSize wxChoice::DoGetBestSize()

 {
 {

-  int sel = FindString (s);
-  if (sel > -1)
+    // find the widest string
+    int wLine;
+    int wChoice = 0;
+    int nItems = GetCount();
+    for ( int i = 0; i < nItems; i++ )

     {
     {

-      SetSelection (sel);
-      return TRUE;
+        wxString str(GetString(i));
+        GetTextExtent(str, &wLine, NULL);
+        if ( wLine > wChoice )
+            wChoice = wLine;

     }
     }

-  else
-    return FALSE;
+
+    // give it some reasonable default value if there are no strings in the
+    // list
+    if ( wChoice == 0 )
+        wChoice = 100;
+
+    // the combobox should be larger than the widest string
+    int cx, cy;
+    wxGetCharSize(GetHWND(), &cx, &cy, &GetFont());
+
+    wChoice += 5*cx;
+
+    // Choice drop-down list depends on number of items (limited to 10)
+    size_t nStrings = nItems == 0 ? 10 : wxMin(10, nItems) + 1;
+    int hChoice = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)*nStrings;
+
+    return wxSize(wChoice, hChoice);

 }
 
 }
 

-void wxChoice::Command(wxCommandEvent & event)
+long wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)

 {
 {

-  SetSelection (event.GetInt());
-  ProcessCommand (event);
+    if ( nMsg == WM_LBUTTONUP )
+    {
+        int x = (int)LOWORD(lParam);
+        int y = (int)HIWORD(lParam);
+
+        // Ok, this is truly weird, but if a panel with a wxChoice loses the
+        // focus, then you get a *fake* WM_LBUTTONUP message with x = 65535 and
+        // y = 65535. Filter out this nonsense.
+        //
+        // VZ: I'd like to know how to reproduce this please...
+        if ( x == 65535 && y == 65535 )
+            return 0;
+    }
+
+    return wxWindow::MSWWindowProc(nMsg, wParam, lParam);

 }
 
 }
 

+bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
+{
+    if ( param != CBN_SELCHANGE)
+    {
+        // "selection changed" is the only event we're after
+        return FALSE;
+    }

 
 

+    int n = GetSelection();
+    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);
+
+    return TRUE;
+}