]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/odcombo.cpp
Improved handling of anchors in wxHTML: scroll to better position (patch #11406).
[wxWidgets.git] / src / generic / odcombo.cpp
index 969d674f1d3a4a4d7b679cf2baf1e832445d152d..83dc7cbb95bcbacbd954b03fd78209f31947b59a 100644 (file)
@@ -33,6 +33,7 @@
     #include "wx/dcclient.h"
     #include "wx/settings.h"
     #include "wx/dialog.h"
+    #include "wx/textctrl.h"
 #endif
 
 #include "wx/combo.h"
@@ -41,6 +42,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
@@ -65,6 +68,7 @@ void wxVListBoxComboPopup::Init()
     m_value = -1;
     m_itemHover = -1;
     m_clientDataItemsType = wxClientData_None;
+    m_partialCompletionString = wxEmptyString;
 }
 
 bool wxVListBoxComboPopup::Create(wxWindow* parent)
@@ -104,10 +108,16 @@ 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);
+            OnDrawItem(dc,rect,m_value,flags);
             return;
         }
     }
@@ -120,13 +130,20 @@ void wxVListBoxComboPopup::OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) co
     // TODO: Maybe this code could be moved to wxVListBox::OnPaint?
     dc.SetFont(m_useFont);
 
+    int flags = 0;
+
     // Set correct text colour for selected items
     if ( wxVListBox::GetSelection() == (int) n )
+    {
         dc.SetTextForeground( wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT) );
+        flags |= wxODCB_PAINTING_SELECTED;
+    }
     else
+    {
         dc.SetTextForeground( wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT) );
+    }
 
-    OnDrawItem(dc,rect,(int)n,0);
+    OnDrawItem(dc,rect,(int)n,flags);
 }
 
 wxCoord wxVListBoxComboPopup::OnMeasureItem(size_t n) const
@@ -162,6 +179,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);
 }
 
@@ -183,20 +203,21 @@ void wxVListBoxComboPopup::OnDrawItem( wxDC& dc, const wxRect& rect, int item, i
 
 void wxVListBoxComboPopup::DismissWithEvent()
 {
+    StopPartialCompletion();
+
     int selection = wxVListBox::GetSelection();
 
     Dismiss();
 
-    wxString valStr;
     if ( selection != wxNOT_FOUND )
-        valStr = m_strings[selection];
+        m_stringValue = m_strings[selection];
     else
-        valStr = wxEmptyString;
+        m_stringValue = wxEmptyString;
 
-    m_value = selection;
+    if ( m_stringValue != m_combo->GetValue() )
+        m_combo->SetValueWithEvent(m_stringValue);
 
-    if ( valStr != m_combo->GetValue() )
-        m_combo->SetValue(valStr);
+    m_value = selection;
 
     SendComboBoxEvent(selection);
 }
@@ -223,26 +244,92 @@ 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 )
 {
+    const int itemCount = GetCount();
+
+    // keys do nothing in the empty control and returning immediately avoids
+    // using invalid indices below
+    if ( !itemCount )
+        return false;
+
     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_START )
+    {
+        if ( unicode > 0 )
+        {
+            if ( wxIsprint(unicode) )
+                keychar = unicode;
+        }
+        else if ( wxIsprint(keycode) )
+        {
+            keychar = (wxChar) keycode;
+        }
+    }
 
     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 ( keychar && (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;
@@ -277,6 +364,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).
@@ -289,7 +385,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();
 }
 
@@ -314,7 +416,7 @@ void wxVListBoxComboPopup::OnMouseMove(wxMouseEvent& event)
     const size_t lineMax = GetVisibleEnd();
     for ( size_t line = GetVisibleBegin(); line < lineMax; line++ )
     {
-        y -= OnGetLineHeight(line);
+        y -= OnGetRowHeight(line);
         if ( y < 0 )
         {
             // Only change selection if item is fully visible
@@ -334,16 +436,38 @@ 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();
+    {
+        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();
+    }
 }
 
 void wxVListBoxComboPopup::Insert( const wxString& item, int pos )
@@ -357,6 +481,9 @@ void wxVListBoxComboPopup::Insert( const wxString& item, int pos )
     }
 
     m_strings.Insert(item,pos);
+    if ( (int)m_clientDatas.size() >= pos )
+        m_clientDatas.Insert(NULL, pos);
+
     m_widths.Insert(-1,pos);
     m_widthsDirty = true;
 
@@ -377,7 +504,7 @@ int wxVListBoxComboPopup::Append(const wxString& item)
 
         for ( i=0; i<strings.GetCount(); i++ )
         {
-            if ( item.Cmp(strings.Item(i)) < 0 )
+            if ( item.CmpNoCase(strings.Item(i)) < 0 )
             {
                 pos = (int)i;
                 break;
@@ -427,7 +554,6 @@ void wxVListBoxComboPopup::SetItemClientData( unsigned int n,
     // It should be sufficient to update this variable only here
     m_clientDataItemsType = clientDataItemsType;
 
-    m_clientDatas.SetCount(n+1,NULL);
     m_clientDatas[n] = clientData;
 
     ItemWidthChanged(n);
@@ -458,8 +584,16 @@ void wxVListBoxComboPopup::Delete( unsigned int 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
@@ -485,9 +619,7 @@ void wxVListBoxComboPopup::SetString( int item, const wxString& str )
 
 wxString wxVListBoxComboPopup::GetStringValue() const
 {
-    if ( m_value >= 0 )
-        return m_strings[m_value];
-    return wxEmptyString;
+    return m_stringValue;
 }
 
 void wxVListBoxComboPopup::SetSelection( int item )
@@ -497,6 +629,11 @@ void wxVListBoxComboPopup::SetSelection( int item )
 
     m_value = item;
 
+    if ( item >= 0 )
+        m_stringValue = m_strings[item];
+    else
+        m_stringValue = wxEmptyString;
+
     if ( IsCreated() )
         wxVListBox::SetSelection(item);
 }
@@ -510,42 +647,17 @@ void wxVListBoxComboPopup::SetStringValue( const wxString& value )
 {
     int index = m_strings.Index(value);
 
-    m_value = index;
+    m_stringValue = value;
 
-    if ( index >= -1 && index < (int)wxVListBox::GetItemCount() )
+    if ( index >= 0 && index < (int)wxVListBox::GetItemCount() )
+    {
         wxVListBox::SetSelection(index);
+        m_value = index;
+    }
 }
 
-wxSize wxVListBoxComboPopup::GetAdjustedSize( int minWidth, int prefHeight, int maxHeight )
+void wxVListBoxComboPopup::CalcWidths()
 {
-    int height = 250;
-
-    if ( m_strings.GetCount() )
-    {
-        if ( prefHeight > 0 )
-            height = prefHeight;
-
-        if ( height > maxHeight )
-            height = maxHeight;
-
-        int totalHeight = GetTotalHeight(); // + 3;
-        if ( height >= totalHeight )
-        {
-            height = totalHeight;
-        }
-        else
-        {
-            // Adjust height to a multiple of the height of the first item
-            // NB: Calculations that take variable height into account
-            //     are unnecessary.
-            int fih = GetLineHeight(0);
-            int shown = height/fih;
-            height = shown * fih;
-        }
-    }
-    else
-        height = 50;
-
     bool doFindWidest = m_findWidest;
 
     // Measure items with dirty width.
@@ -631,6 +743,45 @@ wxSize wxVListBoxComboPopup::GetAdjustedSize( int minWidth, int prefHeight, int
 
         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 )
+            height = prefHeight;
+
+        if ( height > maxHeight )
+            height = maxHeight;
+
+        int totalHeight = GetTotalHeight(); // + 3;
+
+        // Take borders into account on Mac or scrollbars always appear
+#if defined(__WXMAC__)
+        totalHeight += 2;
+#endif
+        if ( height >= totalHeight )
+        {
+            height = totalHeight;
+        }
+        else
+        {
+            // Adjust height to a multiple of the height of the first item
+            // NB: Calculations that take variable height into account
+            //     are unnecessary.
+            int fih = GetLineHeight(0);
+            height -= height % fih;
+        }
+    }
+    else
+        height = 50;
+
+    CalcWidths();
 
     // Take scrollbar into account in width calculations
     int widestWidth = m_widestWidth + wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
@@ -676,7 +827,19 @@ BEGIN_EVENT_TABLE(wxOwnerDrawnComboBox, wxComboCtrl)
 END_EVENT_TABLE()
 
 
+#if wxUSE_EXTENDED_RTTI
+IMPLEMENT_DYNAMIC_CLASS2_XTI(wxOwnerDrawnComboBox, wxComboCtrl, wxControlWithItems, "wx/odcombo.h")
+
+wxBEGIN_PROPERTIES_TABLE(wxOwnerDrawnComboBox)
+wxEND_PROPERTIES_TABLE()
+
+wxBEGIN_HANDLERS_TABLE(wxOwnerDrawnComboBox)
+wxEND_HANDLERS_TABLE()
+
+wxCONSTRUCTOR_5( wxOwnerDrawnComboBox , wxWindow* , Parent , wxWindowID , Id , wxString , Value , wxPoint , Position , wxSize , Size )
+#else
 IMPLEMENT_DYNAMIC_CLASS2(wxOwnerDrawnComboBox, wxComboCtrl, wxControlWithItems)
+#endif
 
 void wxOwnerDrawnComboBox::Init()
 {
@@ -783,7 +946,7 @@ void wxOwnerDrawnComboBox::DoSetPopupControl(wxComboPopup* popup)
 // wxOwnerDrawnComboBox item manipulation methods
 // ----------------------------------------------------------------------------
 
-void wxOwnerDrawnComboBox::Clear()
+void wxOwnerDrawnComboBox::DoClear()
 {
     EnsurePopupControl();
 
@@ -792,9 +955,9 @@ void wxOwnerDrawnComboBox::Clear()
     SetValue(wxEmptyString);
 }
 
-void wxOwnerDrawnComboBox::Delete(unsigned int n)
+void wxOwnerDrawnComboBox::DoDeleteOneItem(unsigned int n)
 {
-    wxCHECK_RET( IsValid(n), _T("invalid index in wxOwnerDrawnComboBox::Delete") );
+    wxCHECK_RET( IsValid(n), wxT("invalid index in wxOwnerDrawnComboBox::Delete") );
 
     if ( GetSelection() == (int) n )
         SetValue(wxEmptyString);
@@ -812,7 +975,7 @@ unsigned int wxOwnerDrawnComboBox::GetCount() const
 
 wxString wxOwnerDrawnComboBox::GetString(unsigned int n) const
 {
-    wxCHECK_MSG( IsValid(n), wxEmptyString, _T("invalid index in wxOwnerDrawnComboBox::GetString") );
+    wxCHECK_MSG( IsValid(n), wxEmptyString, wxT("invalid index in wxOwnerDrawnComboBox::GetString") );
 
     if ( !m_popupInterface )
         return m_initChs.Item(n);
@@ -824,7 +987,7 @@ void wxOwnerDrawnComboBox::SetString(unsigned int n, const wxString& s)
 {
     EnsurePopupControl();
 
-    wxCHECK_RET( IsValid(n), _T("invalid index in wxOwnerDrawnComboBox::SetString") );
+    wxCHECK_RET( IsValid(n), wxT("invalid index in wxOwnerDrawnComboBox::SetString") );
 
     GetVListBoxComboPopup()->SetString(n,s);
 }
@@ -841,7 +1004,7 @@ void wxOwnerDrawnComboBox::Select(int n)
 {
     EnsurePopupControl();
 
-    wxCHECK_RET( (n == wxNOT_FOUND) || IsValid(n), _T("invalid index in wxOwnerDrawnComboBox::Select") );
+    wxCHECK_RET( (n == wxNOT_FOUND) || IsValid(n), wxT("invalid index in wxOwnerDrawnComboBox::Select") );
 
     GetVListBoxComboPopup()->SetSelection(n);
 
@@ -866,31 +1029,45 @@ int wxOwnerDrawnComboBox::GetSelection() const
     return GetVListBoxComboPopup()->GetSelection();
 }
 
-int wxOwnerDrawnComboBox::DoAppend(const wxString& item)
+int wxOwnerDrawnComboBox::DoInsertItems(const wxArrayStringsAdapter& items,
+                                        unsigned int pos,
+                                        void **clientData,
+                                        wxClientDataType type)
 {
     EnsurePopupControl();
-    wxASSERT(m_popupInterface);
 
-    return GetVListBoxComboPopup()->Append(item);
-}
+    const unsigned int count = items.GetCount();
 
-int wxOwnerDrawnComboBox::DoInsert(const wxString& item, unsigned int pos)
-{
-    EnsurePopupControl();
+    if ( HasFlag(wxCB_SORT) )
+    {
+        int n = pos;
 
-    wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));
-    wxCHECK_MSG(IsValidInsert(pos), -1, wxT("invalid index"));
+        for ( unsigned int i = 0; i < count; ++i )
+        {
+            n = GetVListBoxComboPopup()->Append(items[i]);
+            AssignNewItemClientData(n, clientData, i, type);
+        }
 
-    GetVListBoxComboPopup()->Insert(item,pos);
+        return n;
+    }
+    else
+    {
+        for ( unsigned int i = 0; i < count; ++i, ++pos )
+        {
+            GetVListBoxComboPopup()->Insert(items[i], pos);
+            AssignNewItemClientData(pos, clientData, i, type);
+        }
 
-    return pos;
+        return pos - 1;
+    }
 }
 
 void wxOwnerDrawnComboBox::DoSetItemClientData(unsigned int n, void* clientData)
 {
     EnsurePopupControl();
 
-    GetVListBoxComboPopup()->SetItemClientData(n,clientData,m_clientDataItemsType);
+    GetVListBoxComboPopup()->SetItemClientData(n, clientData,
+                                               GetClientDataType());
 }
 
 void* wxOwnerDrawnComboBox::DoGetItemClientData(unsigned int n) const
@@ -901,16 +1078,6 @@ void* wxOwnerDrawnComboBox::DoGetItemClientData(unsigned int n) const
     return GetVListBoxComboPopup()->GetItemClientData(n);
 }
 
-void wxOwnerDrawnComboBox::DoSetItemClientObject(unsigned int n, wxClientData* clientData)
-{
-    DoSetItemClientData(n, (void*) clientData);
-}
-
-wxClientData* wxOwnerDrawnComboBox::DoGetItemClientObject(unsigned int n) const
-{
-    return (wxClientData*) DoGetItemClientData(n);
-}
-
 // ----------------------------------------------------------------------------
 // wxOwnerDrawnComboBox item drawing and measuring default implementations
 // ----------------------------------------------------------------------------
@@ -923,7 +1090,7 @@ void wxOwnerDrawnComboBox::OnDrawItem( wxDC& dc,
     if ( flags & wxODCB_PAINTING_CONTROL )
     {
         dc.DrawText( GetValue(),
-                     rect.x + GetTextIndent(),
+                     rect.x + GetMargins().x,
                      (rect.height-dc.GetCharHeight())/2 + rect.y );
     }
     else
@@ -942,17 +1109,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 ( GetVListBoxComboPopup()->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