]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/odcombo.cpp
Return optimal label width from DrawHeaderButton
[wxWidgets.git] / src / generic / odcombo.cpp
index a568dd57840f4c36fd96b083506f37597caefc36..575641d93dc2e1b2e61e690ea4ace8f6ba34c7f8 100644 (file)
@@ -41,6 +41,8 @@
 // implementation
 // ============================================================================
 
+// time in milliseconds before partial completion buffer drops
+#define wxODCB_PARTIAL_COMPLETION_TIME 1000
 
 // ----------------------------------------------------------------------------
 // wxVListBoxComboPopup is a wxVListBox customized to act as a popup control
@@ -58,12 +60,14 @@ END_EVENT_TABLE()
 void wxVListBoxComboPopup::Init()
 {
     m_widestWidth = 0;
-    m_avgCharWidth = 0;
-    m_baseImageWidth = 0;
+    m_widestItem = -1;
+    m_widthsDirty = false;
+    m_findWidest = false;
     m_itemHeight = 0;
     m_value = -1;
     m_itemHover = -1;
     m_clientDataItemsType = wxClientData_None;
+    m_partialCompletionString = wxEmptyString;
 }
 
 bool wxVListBoxComboPopup::Create(wxWindow* parent)
@@ -103,7 +107,13 @@ void wxVListBoxComboPopup::PaintComboControl( wxDC& dc, const wxRect& rect )
 {
     if ( !(m_combo->GetWindowStyle() & wxODCB_STD_CONTROL_PAINT) )
     {
-        OnDrawBg(dc,rect,m_value,wxODCB_PAINTING_CONTROL);
+        int flags = wxODCB_PAINTING_CONTROL;
+
+        if ( m_combo->ShouldDrawFocus() )
+            flags |= wxODCB_PAINTING_SELECTED;
+
+        OnDrawBg(dc, rect, m_value, flags);
+
         if ( m_value >= 0 )
         {
             OnDrawItem(dc,rect,m_value,wxODCB_PAINTING_CONTROL);
@@ -161,6 +171,9 @@ void wxVListBoxComboPopup::OnDrawBg( wxDC& dc,
     wxASSERT_MSG( combo->IsKindOf(CLASSINFO(wxOwnerDrawnComboBox)),
                   wxT("you must subclass wxVListBoxComboPopup for drawing and measuring methods") );
 
+    if ( IsCurrent((size_t)item) && !(flags & wxODCB_PAINTING_CONTROL) )
+        flags |= wxODCB_PAINTING_SELECTED;
+
     combo->OnDrawBackground(dc,rect,item,flags);
 }
 
@@ -182,6 +195,8 @@ void wxVListBoxComboPopup::OnDrawItem( wxDC& dc, const wxRect& rect, int item, i
 
 void wxVListBoxComboPopup::DismissWithEvent()
 {
+    StopPartialCompletion();
+
     int selection = wxVListBox::GetSelection();
 
     Dismiss();
@@ -195,7 +210,7 @@ void wxVListBoxComboPopup::DismissWithEvent()
     m_value = selection;
 
     if ( valStr != m_combo->GetValue() )
-        m_combo->SetValue(valStr);
+        m_combo->SetValueWithEvent(valStr);
 
     SendComboBoxEvent(selection);
 }
@@ -222,26 +237,82 @@ void wxVListBoxComboPopup::SendComboBoxEvent( int selection )
 }
 
 // returns true if key was consumed
-bool wxVListBoxComboPopup::HandleKey( int keycode, bool saturate )
+bool wxVListBoxComboPopup::HandleKey( int keycode, bool saturate, wxChar unicode )
 {
     int value = m_value;
     int itemCount = GetCount();
+    int comboStyle = m_combo->GetWindowStyle();
+
+    // this is the character equivalent of the code
+    wxChar keychar=0;
+    if ((keycode >= WXK_SPACE) && (keycode <=255) && (keycode != WXK_DELETE) && wxIsprint(keycode))
+    {
+        keychar = (wxChar)keycode;
+    }
+    else if (unicode>0)
+    {
+        keychar = unicode;
+    }
 
     if ( keycode == WXK_DOWN || keycode == WXK_RIGHT )
     {
         value++;
+        StopPartialCompletion();
     }
     else if ( keycode == WXK_UP || keycode == WXK_LEFT )
     {
         value--;
+        StopPartialCompletion();
     }
     else if ( keycode == WXK_PAGEDOWN )
     {
         value+=10;
+        StopPartialCompletion();
     }
     else if ( keycode == WXK_PAGEUP )
     {
         value-=10;
+        StopPartialCompletion();
+    }
+    else if ( comboStyle & wxCB_READONLY )
+    {
+        // Try partial completion
+
+        // find the new partial completion string
+#if wxUSE_TIMER
+        if (m_partialCompletionTimer.IsRunning())
+            m_partialCompletionString+=wxString(keychar);
+        else
+#endif // wxUSE_TIMER
+            m_partialCompletionString=wxString(keychar);
+
+        // now search through the values to see if this is found
+        int found = -1;
+        unsigned int length=m_partialCompletionString.length();
+        int i;
+        for (i=0; i<itemCount; i++)
+        {
+            wxString item=GetString(i);
+            if (( item.length() >= length) && (!  m_partialCompletionString.CmpNoCase(item.Left(length))))
+            {
+                found=i;
+                break;
+            }
+        }
+
+        if (found<0)
+        {
+            StopPartialCompletion();
+            ::wxBell();
+            return true; // to stop the first value being set
+        }
+        else
+        {
+            value=i;
+#if wxUSE_TIMER
+            m_partialCompletionTimer.Start(wxODCB_PARTIAL_COMPLETION_TIME, true);
+#endif // wxUSE_TIMER
+        }
     }
     else
         return false;
@@ -276,6 +347,15 @@ bool wxVListBoxComboPopup::HandleKey( int keycode, bool saturate )
     return true;
 }
 
+// stop partial completion
+void wxVListBoxComboPopup::StopPartialCompletion()
+{
+    m_partialCompletionString = wxEmptyString;
+#if wxUSE_TIMER
+    m_partialCompletionTimer.Stop();
+#endif // wxUSE_TIMER
+}
+
 void wxVListBoxComboPopup::OnComboDoubleClick()
 {
     // Cycle on dclick (disable saturation to allow true cycling).
@@ -288,7 +368,13 @@ void wxVListBoxComboPopup::OnComboDoubleClick()
 void wxVListBoxComboPopup::OnComboKeyEvent( wxKeyEvent& event )
 {
     // Saturated key movement on
-    if ( !HandleKey(event.GetKeyCode(),true) )
+    if ( !HandleKey(event.GetKeyCode(),true,
+#if wxUSE_UNICODE
+        event.GetUnicodeKey()
+#else
+        0
+#endif
+        ) )
         event.Skip();
 }
 
@@ -300,12 +386,30 @@ void wxVListBoxComboPopup::OnPopup()
 
 void wxVListBoxComboPopup::OnMouseMove(wxMouseEvent& event)
 {
+    event.Skip();
+
     // Move selection to cursor if it is inside the popup
-    int itemHere = GetItemAtPosition(event.GetPosition());
-    if ( itemHere >= 0 )
-        wxVListBox::SetSelection(itemHere);
 
-    event.Skip();
+    int y = event.GetPosition().y;
+    int fromBottom = GetClientSize().y - y;
+
+    // Since in any case we need to find out if the last item is only
+    // partially visible, we might just as well replicate the HitTest
+    // loop here.
+    const size_t lineMax = GetVisibleEnd();
+    for ( size_t line = GetVisibleBegin(); line < lineMax; line++ )
+    {
+        y -= OnGetLineHeight(line);
+        if ( y < 0 )
+        {
+            // Only change selection if item is fully visible
+            if ( (y + fromBottom) >= 0 )
+            {
+                wxVListBox::SetSelection((int)line);
+                return;
+            }
+        }
+    }
 }
 
 void wxVListBoxComboPopup::OnLeftClick(wxMouseEvent& WXUNUSED(event))
@@ -315,35 +419,37 @@ void wxVListBoxComboPopup::OnLeftClick(wxMouseEvent& WXUNUSED(event))
 
 void wxVListBoxComboPopup::OnKey(wxKeyEvent& event)
 {
+    // Hide popup if certain key or key combination was pressed
+    if ( m_combo->IsKeyPopupToggle(event) )
+    {
+        StopPartialCompletion();
+        Dismiss();
+    }
+    else if ( event.AltDown() )
+    {
+        // On both wxGTK and wxMSW, pressing Alt down seems to
+        // completely freeze things in popup (ie. arrow keys and
+        // enter won't work).
+        return;
+    }
     // Select item if ENTER is pressed
-    if ( event.GetKeyCode() == WXK_RETURN || event.GetKeyCode() == WXK_NUMPAD_ENTER )
+    else if ( event.GetKeyCode() == WXK_RETURN || event.GetKeyCode() == WXK_NUMPAD_ENTER )
     {
         DismissWithEvent();
     }
-    // Hide popup if ESC is pressed
-    else if ( event.GetKeyCode() == WXK_ESCAPE )
-        Dismiss();
     else
-        event.Skip();
-}
-
-void wxVListBoxComboPopup::CheckWidth( int pos )
-{
-    wxCoord x = OnMeasureItemWidth(pos);
-
-    if ( x < 0 )
-    {
-        if ( !m_useFont.Ok() )
-            m_useFont = m_combo->GetFont();
-
-        wxCoord y;
-        m_combo->GetTextExtent(m_strings[pos], &x, &y, 0, 0, &m_useFont);
-        x += 4;
-    }
-
-    if ( m_widestWidth < x )
     {
-        m_widestWidth = x;
+        int comboStyle = m_combo->GetWindowStyle();
+        int keycode = event.GetKeyCode();
+        // Process partial completion key codes here, but not the arrow keys as the base class will do that for us
+        if ((comboStyle & wxCB_READONLY) &&
+            (keycode >= WXK_SPACE) && (keycode <=255) && (keycode != WXK_DELETE) && wxIsprint(keycode))
+        {
+            OnComboKeyEvent(event);
+            SetSelection(m_value); // ensure the highlight bar moves
+        }
+        else
+            event.Skip();
     }
 }
 
@@ -358,12 +464,11 @@ void wxVListBoxComboPopup::Insert( const wxString& item, int pos )
     }
 
     m_strings.Insert(item,pos);
+    m_widths.Insert(-1,pos);
+    m_widthsDirty = true;
 
     if ( IsCreated() )
         wxVListBox::SetItemCount( wxVListBox::GetItemCount()+1 );
-
-    // Calculate width
-    CheckWidth(pos);
 }
 
 int wxVListBoxComboPopup::Append(const wxString& item)
@@ -397,6 +502,10 @@ void wxVListBoxComboPopup::Clear()
     wxASSERT(m_combo);
 
     m_strings.Empty();
+    m_widths.Empty();
+
+    m_widestWidth = 0;
+    m_widestItem = -1;
 
     ClearClientDatas();
 
@@ -427,6 +536,8 @@ void wxVListBoxComboPopup::SetItemClientData( unsigned int n,
 
     m_clientDatas.SetCount(n+1,NULL);
     m_clientDatas[n] = clientData;
+
+    ItemWidthChanged(n);
 }
 
 void* wxVListBoxComboPopup::GetItemClientData(unsigned int n) const
@@ -449,9 +560,21 @@ void wxVListBoxComboPopup::Delete( unsigned int item )
     }
 
     m_strings.RemoveAt(item);
+    m_widths.RemoveAt(item);
+
+    if ( (int)item == m_widestItem )
+        m_findWidest = true;
+
+    int sel = GetSelection();
 
     if ( IsCreated() )
         wxVListBox::SetItemCount( wxVListBox::GetItemCount()-1 );
+
+    // Fix selection
+    if ( (int)item < sel )
+        SetSelection(sel-1);
+    else if ( (int)item == sel )
+        SetSelection(wxNOT_FOUND);
 }
 
 int wxVListBoxComboPopup::FindString(const wxString& s, bool bCase) const
@@ -472,6 +595,7 @@ wxString wxVListBoxComboPopup::GetString( int item ) const
 void wxVListBoxComboPopup::SetString( int item, const wxString& str )
 {
     m_strings[item] = str;
+    ItemWidthChanged(item);
 }
 
 wxString wxVListBoxComboPopup::GetStringValue() const
@@ -507,10 +631,101 @@ void wxVListBoxComboPopup::SetStringValue( const wxString& value )
         wxVListBox::SetSelection(index);
 }
 
+void wxVListBoxComboPopup::CalcWidths()
+{
+    bool doFindWidest = m_findWidest;
+
+    // Measure items with dirty width.
+    if ( m_widthsDirty )
+    {
+        unsigned int i;
+        unsigned int n = m_widths.GetCount();
+        int dirtyHandled = 0;
+        wxArrayInt& widths = m_widths;
+
+        // I think using wxDC::GetTextExtent is faster than
+        // wxWindow::GetTextExtent (assuming same dc is used
+        // for all calls, as we do here).
+        wxClientDC dc(m_combo);
+        dc.SetFont(m_useFont);
+
+        for ( i=0; i<n; i++ )
+        {
+            if ( widths[i] < 0 )
+            {
+                wxCoord x = OnMeasureItemWidth(i);
+
+                if ( x < 0 )
+                {
+                    const wxString& text = m_strings[i];
+
+                    // To make sure performance won't suck in extreme scenarios,
+                    // we'll estimate length after some arbitrary number of items
+                    // have been checked precily.
+                    if ( dirtyHandled < 1024 )
+                    {
+                        wxCoord y;
+                        dc.GetTextExtent(text, &x, &y, 0, 0);
+                        x += 4;
+                    }
+                    else
+                    {
+                        x = text.length() * (dc.GetCharWidth()+1);
+                    }
+                }
+
+                widths[i] = x;
+
+                if ( x >= m_widestWidth )
+                {
+                    m_widestWidth = x;
+                    m_widestItem = (int)i;
+                }
+                else if ( (int)i == m_widestItem )
+                {
+                    // Width of previously widest item has been decreased, so
+                    // we'll have to check all to find current widest item.
+                    doFindWidest = true;
+                }
+
+                dirtyHandled++;
+            }
+        }
+
+        m_widthsDirty = false;
+    }
+
+    if ( doFindWidest )
+    {
+        unsigned int i;
+        unsigned int n = m_widths.GetCount();
+
+        int bestWidth = -1;
+        int bestIndex = -1;
+
+        for ( i=0; i<n; i++ )
+        {
+            int w = m_widths[i];
+            if ( w > bestWidth )
+            {
+                bestIndex = (int)i;
+                bestWidth = w;
+            }
+        }
+
+        m_widestWidth = bestWidth;
+        m_widestItem = bestIndex;
+
+        m_findWidest = false;
+    }
+}
+
 wxSize wxVListBoxComboPopup::GetAdjustedSize( int minWidth, int prefHeight, int maxHeight )
 {
     int height = 250;
 
+    maxHeight -= 2;  // Must take borders into account
+
     if ( m_strings.GetCount() )
     {
         if ( prefHeight > 0 )
@@ -530,13 +745,14 @@ wxSize wxVListBoxComboPopup::GetAdjustedSize( int minWidth, int prefHeight, int
             // NB: Calculations that take variable height into account
             //     are unnecessary.
             int fih = GetLineHeight(0);
-            int shown = height/fih;
-            height = shown * fih;
+            height -= height % fih;
         }
     }
     else
         height = 50;
 
+    CalcWidths();
+
     // Take scrollbar into account in width calculations
     int widestWidth = m_widestWidth + wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
     return wxSize(minWidth > widestWidth ? minWidth : widestWidth,
@@ -554,9 +770,11 @@ void wxVListBoxComboPopup::Populate( const wxArrayString& choices )
     {
         const wxString& item = choices.Item(i);
         m_strings.Add(item);
-        CheckWidth(i);
     }
 
+    m_widths.SetCount(n,-1);
+    m_widthsDirty = true;
+
     if ( IsCreated() )
         wxVListBox::SetItemCount(n);
 
@@ -583,7 +801,6 @@ IMPLEMENT_DYNAMIC_CLASS2(wxOwnerDrawnComboBox, wxComboCtrl, wxControlWithItems)
 
 void wxOwnerDrawnComboBox::Init()
 {
-    m_popupInterface = NULL;
 }
 
 bool wxOwnerDrawnComboBox::Create(wxWindow *parent,
@@ -661,26 +878,24 @@ bool wxOwnerDrawnComboBox::Create(wxWindow *parent,
 wxOwnerDrawnComboBox::~wxOwnerDrawnComboBox()
 {
     if ( m_popupInterface )
-        m_popupInterface->ClearClientDatas();
+        GetVListBoxComboPopup()->ClearClientDatas();
 }
 
-void wxOwnerDrawnComboBox::SetPopupControl( wxComboPopup* popup )
+void wxOwnerDrawnComboBox::DoSetPopupControl(wxComboPopup* popup)
 {
     if ( !popup )
     {
         popup = new wxVListBoxComboPopup();
     }
 
-    wxComboCtrl::SetPopupControl(popup);
+    wxComboCtrl::DoSetPopupControl(popup);
 
     wxASSERT(popup);
-    m_popupInterface = (wxVListBoxComboPopup*) popup;
 
     // Add initial choices to the wxVListBox
-    if ( !m_popupInterface->GetCount() )
+    if ( !GetVListBoxComboPopup()->GetCount() )
     {
-        //m_popupInterface->Populate(m_initChs.GetCount(),m_initChs.GetStrings());
-        m_popupInterface->Populate(m_initChs);
+        GetVListBoxComboPopup()->Populate(m_initChs);
         m_initChs.Clear();
     }
 }
@@ -693,7 +908,7 @@ void wxOwnerDrawnComboBox::Clear()
 {
     EnsurePopupControl();
 
-    m_popupInterface->Clear();
+    GetVListBoxComboPopup()->Clear();
 
     SetValue(wxEmptyString);
 }
@@ -705,31 +920,42 @@ void wxOwnerDrawnComboBox::Delete(unsigned int n)
     if ( GetSelection() == (int) n )
         SetValue(wxEmptyString);
 
-    m_popupInterface->Delete(n);
+    GetVListBoxComboPopup()->Delete(n);
 }
 
 unsigned int wxOwnerDrawnComboBox::GetCount() const
 {
-    wxASSERT_MSG( m_popupInterface, wxT("no popup interface") );
-    return m_popupInterface->GetCount();
+    if ( !m_popupInterface )
+        return m_initChs.GetCount();
+
+    return GetVListBoxComboPopup()->GetCount();
 }
 
 wxString wxOwnerDrawnComboBox::GetString(unsigned int n) const
 {
     wxCHECK_MSG( IsValid(n), wxEmptyString, _T("invalid index in wxOwnerDrawnComboBox::GetString") );
-    return m_popupInterface->GetString(n);
+
+    if ( !m_popupInterface )
+        return m_initChs.Item(n);
+
+    return GetVListBoxComboPopup()->GetString(n);
 }
 
 void wxOwnerDrawnComboBox::SetString(unsigned int n, const wxString& s)
 {
+    EnsurePopupControl();
+
     wxCHECK_RET( IsValid(n), _T("invalid index in wxOwnerDrawnComboBox::SetString") );
-    m_popupInterface->SetString(n,s);
+
+    GetVListBoxComboPopup()->SetString(n,s);
 }
 
 int wxOwnerDrawnComboBox::FindString(const wxString& s, bool bCase) const
 {
-    wxASSERT_MSG( m_popupInterface, wxT("no popup interface") );
-    return m_popupInterface->FindString(s, bCase);
+    if ( !m_popupInterface )
+        return m_initChs.Index(s, bCase);
+
+    return GetVListBoxComboPopup()->FindString(s, bCase);
 }
 
 void wxOwnerDrawnComboBox::Select(int n)
@@ -738,11 +964,11 @@ void wxOwnerDrawnComboBox::Select(int n)
 
     wxCHECK_RET( (n == wxNOT_FOUND) || IsValid(n), _T("invalid index in wxOwnerDrawnComboBox::Select") );
 
-    m_popupInterface->SetSelection(n);
+    GetVListBoxComboPopup()->SetSelection(n);
 
     wxString str;
     if ( n >= 0 )
-        str = m_popupInterface->GetString(n);
+        str = GetVListBoxComboPopup()->GetString(n);
 
     // Refresh text portion in control
     if ( m_text )
@@ -755,15 +981,18 @@ void wxOwnerDrawnComboBox::Select(int n)
 
 int wxOwnerDrawnComboBox::GetSelection() const
 {
-    wxASSERT_MSG( m_popupInterface, wxT("no popup interface") );
-    return m_popupInterface->GetSelection();
+    if ( !m_popupInterface )
+        return m_initChs.Index(m_valueString);
+
+    return GetVListBoxComboPopup()->GetSelection();
 }
 
 int wxOwnerDrawnComboBox::DoAppend(const wxString& item)
 {
     EnsurePopupControl();
     wxASSERT(m_popupInterface);
-    return m_popupInterface->Append(item);
+
+    return GetVListBoxComboPopup()->Append(item);
 }
 
 int wxOwnerDrawnComboBox::DoInsert(const wxString& item, unsigned int pos)
@@ -773,7 +1002,7 @@ int wxOwnerDrawnComboBox::DoInsert(const wxString& item, unsigned int pos)
     wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));
     wxCHECK_MSG(IsValidInsert(pos), -1, wxT("invalid index"));
 
-    m_popupInterface->Insert(item,pos);
+    GetVListBoxComboPopup()->Insert(item,pos);
 
     return pos;
 }
@@ -781,13 +1010,16 @@ int wxOwnerDrawnComboBox::DoInsert(const wxString& item, unsigned int pos)
 void wxOwnerDrawnComboBox::DoSetItemClientData(unsigned int n, void* clientData)
 {
     EnsurePopupControl();
-    m_popupInterface->SetItemClientData(n,clientData,m_clientDataItemsType);
+
+    GetVListBoxComboPopup()->SetItemClientData(n,clientData,m_clientDataItemsType);
 }
 
 void* wxOwnerDrawnComboBox::DoGetItemClientData(unsigned int n) const
 {
-    wxASSERT_MSG( m_popupInterface, wxT("no popup interface") );
-    return m_popupInterface->GetItemClientData(n);
+    if ( !m_popupInterface )
+        return NULL;
+
+    return GetVListBoxComboPopup()->GetItemClientData(n);
 }
 
 void wxOwnerDrawnComboBox::DoSetItemClientObject(unsigned int n, wxClientData* clientData)
@@ -817,7 +1049,7 @@ void wxOwnerDrawnComboBox::OnDrawItem( wxDC& dc,
     }
     else
     {
-        dc.DrawText( m_popupInterface->GetString(item), rect.x + 2, rect.y );
+        dc.DrawText( GetVListBoxComboPopup()->GetString(item), rect.x + 2, rect.y );
     }
 }
 
@@ -831,17 +1063,25 @@ wxCoord wxOwnerDrawnComboBox::OnMeasureItemWidth( size_t WXUNUSED(item) ) const
     return -1;
 }
 
-void wxOwnerDrawnComboBox::OnDrawBackground(wxDC& dc, const wxRect& rect, int item, int flags) const
+void wxOwnerDrawnComboBox::OnDrawBackground(wxDC& dc,
+                                            const wxRect& rect,
+                                            int WXUNUSED(item),
+                                            int flags) const
 {
-    // we need to render selected and current items differently
-    if ( m_popupInterface->IsCurrent((size_t)item) )
+    // We need only to explicitly draw background for items
+    // that should have selected background. Also, call PrepareBackground
+    // always when painting the control so that clipping is done properly.
+
+    if ( (flags & wxODCB_PAINTING_SELECTED) ||
+         ((flags & wxODCB_PAINTING_CONTROL) && HasFlag(wxCB_READONLY)) )
     {
-        DrawFocusBackground(dc,
-                            rect,
-                            (flags&wxODCB_PAINTING_CONTROL?0:wxCONTROL_ISSUBMENU) |
-                            wxCONTROL_SELECTED);
+        int bgFlags = wxCONTROL_SELECTED;
+
+        if ( !(flags & wxODCB_PAINTING_CONTROL) )
+            bgFlags |= wxCONTROL_ISSUBMENU;
+
+        PrepareBackground(dc, rect, bgFlags);
     }
-    //else: do nothing for the normal items
 }
 
 #endif // wxUSE_ODCOMBOBOX