showing a bevel button for a multiline label (is not multline on the OS level, but...

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

diff --git a/src/msw/choice.cpp b/src/msw/choice.cpp
index 9c7c335392f680ea16ac986d63231d27178dc207..e80ff3b1660d3ea1af5a5cf64c5aecde19611872 100644 (file)
--- a/src/msw/choice.cpp
+++ b/src/msw/choice.cpp
@@ -5,8 +5,8 @@
 // Modified by: Vadim Zeitlin to derive from wxChoiceBase
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Modified by: Vadim Zeitlin to derive from wxChoiceBase
 // Created:     04/01/98
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -17,7 +17,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma implementation "choice.h"
 #endif
 
     #pragma implementation "choice.h"
 #endif
 


@@ -28,17 +28,75 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_CHOICE
+

 #ifndef WX_PRECOMP
     #include "wx/choice.h"
     #include "wx/utils.h"
     #include "wx/log.h"
 #ifndef WX_PRECOMP
     #include "wx/choice.h"
     #include "wx/utils.h"
     #include "wx/log.h"

+    #include "wx/brush.h"
+    #include "wx/settings.h"

 #endif
 
 #include "wx/msw/private.h"
 
 #endif
 
 #include "wx/msw/private.h"
 

-#if !USE_SHARED_LIBRARY
-    IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControl)
+#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, wxControl,"wx/choice.h")
+
+wxBEGIN_PROPERTIES_TABLE(wxChoice)
+       wxEVENT_PROPERTY( Select , wxEVT_COMMAND_CHOICE_SELECTED , wxCommandEvent )
+
+    wxPROPERTY( Font , wxFont , SetFont , GetFont  , , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+    wxPROPERTY_COLLECTION( Choices , wxArrayString , wxString , AppendString , GetStrings , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+       wxPROPERTY( Selection ,int, SetSelection, GetSelection, , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+    wxPROPERTY_FLAGS( WindowStyle , wxChoiceStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , , 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, wxControl)

 #endif
 #endif

+/*
+       TODO PROPERTIES
+               selection (long)
+               content (list)
+                       item
+*/

 
 // ============================================================================
 // implementation
 
 // ============================================================================
 // implementation


@@ -57,34 +115,113 @@ bool wxChoice::Create(wxWindow *parent,
                       const wxValidator& validator,
                       const wxString& name)
 {
                       const wxValidator& validator,
                       const wxString& name)
 {

-    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
+    // 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),
     // 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") );
+                  _T("this style flag is ignored by wxChoice, you ")
+                  _T("probably want to use a wxComboBox") );

 
 

-    if ( !MSWCreateControl(wxT("COMBOBOX"), msStyle) )
+    return CreateAndInit(parent, id, pos, size, n, choices, style,
+                         validator, name);
+}
+
+bool wxChoice::CreateAndInit(wxWindow *parent,
+                             wxWindowID id,
+                             const wxPoint& pos,
+                             const wxSize& sizeOrig,
+                             int n, const wxString choices[],
+                             long style,
+                             const wxValidator& validator,
+                             const wxString& name)
+{
+    // this is a bit hackish but we want to prevent MSWCreateControl() from
+    // calling SetBestSize() (which it would do if any of the size components
+    // is not given) because it wouldn't calculate it correctly if we have any
+    // strings as they're not yet added to the control when it is called
+    //
+    // so: if we have any strings, we fudge the size parameter so that
+    // SetBestSize() is not called by MSWCreateControl() but then we do call it
+    // manually below
+    bool autoSize = false;
+    wxSize size = sizeOrig;
+    if ( n )
+    {
+        if ( size.x < 0 )
+        {
+            size.x = 1;
+            autoSize = true;
+        }
+        if ( size.y < 0 )
+        {
+            size.y = 1;
+            autoSize = true;
+        }
+    }
+
+    // initialize wxControl
+    if ( !CreateControl(parent, id, pos, size, style, validator, name) )
+        return FALSE;
+
+    // now create the real HWND
+    if ( !MSWCreateControl(wxT("COMBOBOX"), _T(""), pos, size) )

         return FALSE;
 
         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]);
     }
 
     for ( int i = 0; i < n; i++ )
     {
         Append(choices[i]);
     }
 

-    SetSize(pos.x, pos.y, size.x, size.y);
+    // and now we may finally size the control properly (if needed)
+    if ( autoSize )
+    {
+        SetBestSize(sizeOrig);
+    }

 
     return TRUE;
 }
 
 
     return TRUE;
 }
 

+bool wxChoice::Create(wxWindow *parent,
+                      wxWindowID id,
+                      const wxPoint& pos,
+                      const wxSize& size,
+                      const wxArrayString& choices,
+                      long style,
+                      const wxValidator& validator,
+                      const wxString& name)
+{
+    wxCArrayString chs(choices);
+    return Create(parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
+                  style, validator, name);
+}
+
+WXDWORD wxChoice::MSWGetStyle(long style, WXDWORD *exstyle) const
+{
+    // we never have an external border
+    WXDWORD msStyle = wxControl::MSWGetStyle
+                      (
+                        (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
+                      );
+
+    // WS_CLIPSIBLINGS is useful with wxChoice and doesn't seem to result in
+    // any problems
+    msStyle |= WS_CLIPSIBLINGS;
+
+    // wxChoice-specific styles
+    msStyle |= CBS_DROPDOWNLIST | WS_HSCROLL | WS_VSCROLL;
+    if ( style & wxCB_SORT )
+        msStyle |= CBS_SORT;
+
+    return msStyle;
+}
+

 wxChoice::~wxChoice()
 {
     Free();
 wxChoice::~wxChoice()
 {
     Free();


@@ -96,10 +233,34 @@ wxChoice::~wxChoice()
 
 int wxChoice::DoAppend(const wxString& item)
 {
 
 int wxChoice::DoAppend(const wxString& item)
 {

-    int n = (int)SendMessage(GetHwnd(), CB_ADDSTRING, 0, (LONG)item.c_str());
+    int n = (int)SendMessage(GetHwnd(), CB_ADDSTRING, 0, (LPARAM)item.c_str());

     if ( n == CB_ERR )
     {
     if ( n == CB_ERR )
     {

-        wxLogLastError("SendMessage(CB_ADDSTRING)");
+        wxLogLastError(wxT("SendMessage(CB_ADDSTRING)"));
+    }
+    else // ok
+    {
+        // we need to refresh our size in order to have enough space for the
+        // newly added items
+        UpdateVisibleHeight();
+    }
+
+    return n;
+}
+
+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"));
+
+    int n = (int)SendMessage(GetHwnd(), CB_INSERTSTRING, pos, (LPARAM)item.c_str());
+    if ( n == CB_ERR )
+    {
+        wxLogLastError(wxT("SendMessage(CB_INSERTSTRING)"));
+    }
+    else // ok
+    {
+        UpdateVisibleHeight();

     }
 
     return n;
     }
 
     return n;


@@ -115,6 +276,8 @@ void wxChoice::Delete(int n)
     }
 
     SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
     }
 
     SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);

+
+    UpdateVisibleHeight();

 }
 
 void wxChoice::Clear()
 }
 
 void wxChoice::Clear()


@@ -122,6 +285,8 @@ void wxChoice::Clear()
     Free();
 
     SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);
     Free();
 
     SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);

+
+    UpdateVisibleHeight();

 }
 
 void wxChoice::Free()
 }
 
 void wxChoice::Free()


@@ -183,24 +348,50 @@ int wxChoice::FindString(const wxString& s) const
 
 void wxChoice::SetString(int n, const wxString& s)
 {
 
 void wxChoice::SetString(int n, const wxString& s)
 {

-    wxFAIL_MSG(wxT("not implemented"));
+    wxCHECK_RET( n >= 0 && n < GetCount(),
+                 wxT("invalid item index in wxChoice::SetString") );

 
 

-#if 0 // should do this, but no Insert() so far
-    Delete(n);
-    Insert(n + 1, s);
-#endif
+    // 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;
+    }
+
+    ::SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
+    ::SendMessage(GetHwnd(), CB_INSERTSTRING, n, (LPARAM)s.c_str() );
+
+    if ( data )
+    {
+        DoSetItemClientData(n, data);
+    }
+    //else: it's already NULL by default

 }
 
 wxString wxChoice::GetString(int n) const
 {
 }
 
 wxString wxChoice::GetString(int n) const
 {

-    size_t len = (size_t)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
+    int len = (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
+

     wxString str;
     wxString str;

-    if (len) {
-        if ( ::SendMessage(GetHwnd(), CB_GETLBTEXT, n,
-                           (LPARAM)str.GetWriteBuf(len)) == CB_ERR ) {
-            wxLogLastError("SendMessage(CB_GETLBTEXT)");
+    if ( len != CB_ERR && len > 0 )
+    {
+        if ( ::SendMessage
+               (
+                GetHwnd(),
+                CB_GETLBTEXT,
+                n,
+                (LPARAM)(wxChar *)wxStringBuffer(str, len)
+               ) == CB_ERR )
+        {
+            wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));

         }
         }

-        str.UngetWriteBuf();

     }
 
     return str;
     }
 
     return str;


@@ -212,7 +403,8 @@ wxString wxChoice::GetString(int n) const
 
 void wxChoice::DoSetItemClientData( int n, void* clientData )
 {
 
 void wxChoice::DoSetItemClientData( int n, void* clientData )
 {

-    if ( SendMessage(GetHwnd(), CB_SETITEMDATA, n, (LPARAM)clientData) == CB_ERR )
+    if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA,
+                       n, (LPARAM)clientData) == CB_ERR )

     {
         wxLogLastError(wxT("CB_SETITEMDATA"));
     }
     {
         wxLogLastError(wxT("CB_SETITEMDATA"));
     }


@@ -246,28 +438,88 @@ wxClientData* wxChoice::DoGetItemClientObject( int n ) const
 // wxMSW specific helpers
 // ----------------------------------------------------------------------------
 
 // wxMSW specific helpers
 // ----------------------------------------------------------------------------
 

+void wxChoice::UpdateVisibleHeight()
+{
+    // be careful to not change the width here
+    DoSetSize(-1, -1, -1, GetSize().y, wxSIZE_USE_EXISTING);
+}
+
+void wxChoice::DoMoveWindow(int x, int y, int width, int height)
+{
+    // here is why this is necessary: if the width is negative, the combobox
+    // window proc makes the window of the size width*height instead of
+    // interpreting height in the usual manner (meaning the height of the drop
+    // down list - usually the height specified in the call to MoveWindow()
+    // will not change the height of combo box per se)
+    //
+    // this behaviour is not documented anywhere, but this is just how it is
+    // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
+    // the check, constraints/sizers using combos may break the height
+    // constraint will have not at all the same value as expected
+    if ( width < 0 )
+        return;
+
+    wxControl::DoMoveWindow(x, y, width, height);
+}
+
+void wxChoice::DoGetSize(int *w, int *h) const
+{
+    // 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);
+}
+

 void wxChoice::DoSetSize(int x, int y,
                          int width, int height,
                          int sizeFlags)
 {
 void wxChoice::DoSetSize(int x, int y,
                          int width, int height,
                          int sizeFlags)
 {

-    // 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);
+    int heightOrig = height;
+
+    // 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 != -1 )
+    {
+        // 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 > 39 )
+            nItems = 39;
+
+        // add space for the drop down list
+        const int hItem = SendMessage(GetHwnd(), CB_GETITEMHEIGHT, 0, 0);
+        height += hItem*(nItems + 1);
+    }
+
+    wxControl::DoSetSize(x, y, width, height, sizeFlags);
+
+    // 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 != -1 )
+    {
+        const int delta = heightOrig - GetSize().y;
+        if ( delta )
+        {
+            int h = ::SendMessage(GetHwnd(), CB_GETITEMHEIGHT, (WPARAM)-1, 0);
+            SendMessage(GetHwnd(), CB_SETITEMHEIGHT, (WPARAM)-1, h + delta);
+        }
+    }

 }
 
 }
 

-wxSize wxChoice::DoGetBestSize()
+wxSize wxChoice::DoGetBestSize() const

 {
     // find the widest string
 {
     // find the widest string

-    int wLine;

     int wChoice = 0;
     int wChoice = 0;

-    int nItems = GetCount();
-    for ( int i = 0; i < nItems; i++ )
+    const size_t nItems = GetCount();
+    for ( size_t i = 0; i < nItems; i++ )

     {
     {

-        wxString str(GetString(i));
-        GetTextExtent(str, &wLine, NULL);
+        int wLine;
+        GetTextExtent(GetString(i), &wLine, NULL);

         if ( wLine > wChoice )
             wChoice = wLine;
     }
         if ( wLine > wChoice )
             wChoice = wLine;
     }


@@ -277,20 +529,13 @@ wxSize wxChoice::DoGetBestSize()
     if ( wChoice == 0 )
         wChoice = 100;
 
     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;
+    // the combobox should be slightly larger than the widest string
+    wChoice += 5*GetCharWidth();

 
 

-    return wxSize(wChoice, hChoice);
+    return wxSize(wChoice, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));

 }
 
 }
 

-long wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
+WXLRESULT wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)

 {
     if ( nMsg == WM_LBUTTONUP )
     {
 {
     if ( nMsg == WM_LBUTTONUP )
     {


@@ -317,12 +562,41 @@ bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
         return FALSE;
     }
 
         return FALSE;
     }
 

-    wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
-    event.SetInt(GetSelection());
-    event.SetEventObject(this);
-    event.SetString(GetStringSelection());
-    ProcessCommand(event);
+    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);
+    }

 
     return TRUE;
 }
 
 
     return TRUE;
 }
 

+WXHBRUSH wxChoice::OnCtlColor(WXHDC pDC, WXHWND WXUNUSED(pWnd), WXUINT WXUNUSED(nCtlColor),
+                               WXUINT WXUNUSED(message),
+                               WXWPARAM WXUNUSED(wParam),
+                               WXLPARAM WXUNUSED(lParam)
+     )
+{
+    HDC hdc = (HDC)pDC;
+    wxColour colBack = GetBackgroundColour();
+
+    if (!IsEnabled())
+        colBack = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE);
+
+    ::SetBkColor(hdc, wxColourToRGB(colBack));
+    ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
+
+    wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);
+
+    return (WXHBRUSH)brush->GetResourceHandle();
+}
+
+#endif // wxUSE_CHOICE