Add backend descriptions for all backends to the documentation.

[wxWidgets.git] / src / generic / odcombo.cpp

diff --git a/src/generic/odcombo.cpp b/src/generic/odcombo.cpp
index 0df20a054ba433434d484dfb04aad9d644dc36f8..06ca2e58a5ce3f497406b03227999183fe175322 100644 (file)
--- a/src/generic/odcombo.cpp
+++ b/src/generic/odcombo.cpp
@@ -33,6 +33,7 @@
     #include "wx/dcclient.h"
     #include "wx/settings.h"
     #include "wx/dialog.h"
     #include "wx/dcclient.h"
     #include "wx/settings.h"
     #include "wx/dialog.h"

+    #include "wx/textctrl.h"

 #endif
 
 #include "wx/combo.h"
 #endif
 
 #include "wx/combo.h"


@@ -53,6 +54,7 @@
 BEGIN_EVENT_TABLE(wxVListBoxComboPopup, wxVListBox)
     EVT_MOTION(wxVListBoxComboPopup::OnMouseMove)
     EVT_KEY_DOWN(wxVListBoxComboPopup::OnKey)
 BEGIN_EVENT_TABLE(wxVListBoxComboPopup, wxVListBox)
     EVT_MOTION(wxVListBoxComboPopup::OnMouseMove)
     EVT_KEY_DOWN(wxVListBoxComboPopup::OnKey)

+    EVT_CHAR(wxVListBoxComboPopup::OnChar)

     EVT_LEFT_UP(wxVListBoxComboPopup::OnLeftClick)
 END_EVENT_TABLE()
 
     EVT_LEFT_UP(wxVListBoxComboPopup::OnLeftClick)
 END_EVENT_TABLE()
 


@@ -94,6 +96,18 @@ wxVListBoxComboPopup::~wxVListBoxComboPopup()
     Clear();
 }
 
     Clear();
 }
 

+void wxVListBoxComboPopup::SetFocus()
+{
+    // Suppress SetFocus() warning by simply not calling it. This combo popup
+    // has already been designed with the assumption that SetFocus() may not
+    // do anything useful, so it really doesn't need to be called.
+#ifdef __WXMSW__
+    //
+#else
+    wxVListBox::SetFocus();
+#endif
+}
+

 bool wxVListBoxComboPopup::LazyCreate()
 {
     // NB: There is a bug with wxVListBox that can be avoided by creating
 bool wxVListBoxComboPopup::LazyCreate()
 {
     // NB: There is a bug with wxVListBox that can be avoided by creating


@@ -208,16 +222,15 @@ void wxVListBoxComboPopup::DismissWithEvent()
 
     Dismiss();
 
 
     Dismiss();
 

-    wxString valStr;

     if ( selection != wxNOT_FOUND )
     if ( selection != wxNOT_FOUND )

-        valStr = m_strings[selection];
+        m_stringValue = m_strings[selection];

     else
     else

-        valStr = wxEmptyString;
+        m_stringValue = wxEmptyString;

 
 

-    m_value = selection;
+    if ( m_stringValue != m_combo->GetValue() )
+        m_combo->SetValueByUser(m_stringValue);

 
 

-    if ( valStr != m_combo->GetValue() )
-        m_combo->SetValueWithEvent(valStr);
+    m_value = selection;

 
     SendComboBoxEvent(selection);
 }
 
     SendComboBoxEvent(selection);
 }


@@ -244,44 +257,57 @@ void wxVListBoxComboPopup::SendComboBoxEvent( int selection )
 }
 
 // returns true if key was consumed
 }
 
 // returns true if key was consumed

-bool wxVListBoxComboPopup::HandleKey( int keycode, bool saturate, wxChar unicode )
+bool wxVListBoxComboPopup::HandleKey( int keycode, bool saturate, wxChar keychar )

 {
 {

+    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 value = m_value;

-    int itemCount = GetCount();

     int comboStyle = m_combo->GetWindowStyle();
 
     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))
+    if ( keychar > 0 )

     {
     {

-        keychar = (wxChar)keycode;
-    }
-    else if (unicode>0)
-    {
-        keychar = unicode;
+        // we have character equivalent of the keycode; filter out these that
+        // are not printable characters
+        if ( !wxIsprint(keychar) )
+            keychar = 0;

     }
 
     }
 

-    if ( keycode == WXK_DOWN || keycode == WXK_RIGHT )
+    if ( keycode == WXK_DOWN || keycode == WXK_NUMPAD_DOWN || keycode == WXK_RIGHT )

     {
         value++;
         StopPartialCompletion();
     }
     {
         value++;
         StopPartialCompletion();
     }

-    else if ( keycode == WXK_UP || keycode == WXK_LEFT )
+    else if ( keycode == WXK_UP || keycode == WXK_NUMPAD_UP || keycode == WXK_LEFT )

     {
         value--;
         StopPartialCompletion();
     }
     {
         value--;
         StopPartialCompletion();
     }

-    else if ( keycode == WXK_PAGEDOWN )
+    else if ( keycode == WXK_PAGEDOWN || keycode == WXK_NUMPAD_PAGEDOWN )

     {
         value+=10;
         StopPartialCompletion();
     }
     {
         value+=10;
         StopPartialCompletion();
     }

-    else if ( keycode == WXK_PAGEUP )
+    else if ( keycode == WXK_PAGEUP || keycode == WXK_NUMPAD_PAGEUP )

     {
         value-=10;
         StopPartialCompletion();
     }
     {
         value-=10;
         StopPartialCompletion();
     }

-    else if ( comboStyle & wxCB_READONLY )
+    else if ( keycode == WXK_HOME || keycode == WXK_NUMPAD_HOME )
+    {
+        value=0;
+        StopPartialCompletion();
+    }
+    else if ( keycode == WXK_END || keycode == WXK_NUMPAD_END )
+    {
+        value=itemCount-1;
+        StopPartialCompletion();
+    }
+    else if ( keychar && (comboStyle & wxCB_READONLY) )

     {
         // Try partial completion
 
     {
         // Try partial completion
 


@@ -344,10 +370,14 @@ bool wxVListBoxComboPopup::HandleKey( int keycode, bool saturate, wxChar unicode
         // (good for consistency)
         return true;
 
         // (good for consistency)
         return true;
 

-    m_value = value;
-

     if ( value >= 0 )
     if ( value >= 0 )

-        m_combo->SetValue(m_strings[value]);
+        m_combo->ChangeValue(m_strings[value]);
+
+    // The m_combo->SetValue() call above sets m_value to the index of this
+    // string. But if there are more identical string, the index is of the
+    // first occurence, which may be wrong, so set the index explicitly here,
+    // _after_ the SetValue() call.
+    m_value = value;

 
     SendComboBoxEvent(m_value);
 
 
     SendComboBoxEvent(m_value);
 


@@ -375,13 +405,21 @@ void wxVListBoxComboPopup::OnComboDoubleClick()
 void wxVListBoxComboPopup::OnComboKeyEvent( wxKeyEvent& event )
 {
     // Saturated key movement on
 void wxVListBoxComboPopup::OnComboKeyEvent( wxKeyEvent& event )
 {
     // Saturated key movement on

-    if ( !HandleKey(event.GetKeyCode(),true,
+    if ( !HandleKey(event.GetKeyCode(), true) )
+        event.Skip();
+}
+
+void wxVListBoxComboPopup::OnComboCharEvent( wxKeyEvent& event )
+{
+    // unlike in OnComboKeyEvent, wxEVT_CHAR contains meaningful
+    // printable character information, so pass it

 #if wxUSE_UNICODE
 #if wxUSE_UNICODE

-        event.GetUnicodeKey()
+    const wxChar charcode = event.GetUnicodeKey();

 #else
 #else

-        0
+    const wxChar charcode = (wxChar)event.GetKeyCode();

 #endif
 #endif

-        ) )
+
+    if ( !HandleKey(event.GetKeyCode(), true, charcode) )

         event.Skip();
 }
 
         event.Skip();
 }
 


@@ -446,18 +484,31 @@ void wxVListBoxComboPopup::OnKey(wxKeyEvent& event)
     }
     else
     {
     }
     else
     {

-        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))
+        // completion is handled in OnChar() below
+        event.Skip();
+    }
+}
+
+void wxVListBoxComboPopup::OnChar(wxKeyEvent& event)
+{
+    if ( m_combo->GetWindowStyle() & wxCB_READONLY )
+    {
+        // Process partial completion key codes here, but not the arrow keys as
+        // the base class will do that for us
+#if wxUSE_UNICODE
+        const wxChar charcode = event.GetUnicodeKey();
+#else
+        const wxChar charcode = (wxChar)event.GetKeyCode();
+#endif
+        if ( wxIsprint(charcode) )

         {
         {

-            OnComboKeyEvent(event);
+            OnComboCharEvent(event);

             SetSelection(m_value); // ensure the highlight bar moves
             SetSelection(m_value); // ensure the highlight bar moves

+            return; // don't skip the event

         }
         }

-        else
-            event.Skip();

     }
     }

+
+    event.Skip();

 }
 
 void wxVListBoxComboPopup::Insert( const wxString& item, int pos )
 }
 
 void wxVListBoxComboPopup::Insert( const wxString& item, int pos )


@@ -471,7 +522,8 @@ void wxVListBoxComboPopup::Insert( const wxString& item, int pos )
     }
 
     m_strings.Insert(item,pos);
     }
 
     m_strings.Insert(item,pos);

-    m_clientDatas.Insert(NULL, pos);
+    if ( (int)m_clientDatas.size() >= pos )
+        m_clientDatas.Insert(NULL, pos);

 
     m_widths.Insert(-1,pos);
     m_widthsDirty = true;
 
     m_widths.Insert(-1,pos);
     m_widthsDirty = true;


@@ -493,7 +545,7 @@ int wxVListBoxComboPopup::Append(const wxString& item)
 
         for ( i=0; i<strings.GetCount(); i++ )
         {
 
         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;
             {
                 pos = (int)i;
                 break;


@@ -590,6 +642,16 @@ int wxVListBoxComboPopup::FindString(const wxString& s, bool bCase) const
     return m_strings.Index(s, bCase);
 }
 
     return m_strings.Index(s, bCase);
 }
 

+bool wxVListBoxComboPopup::FindItem(const wxString& item, wxString* trueItem)
+{
+    int idx = m_strings.Index(item, false);
+    if ( idx == wxNOT_FOUND )
+        return false;
+    if ( trueItem != NULL )
+        *trueItem = m_strings[idx];
+    return true;
+}
+

 unsigned int wxVListBoxComboPopup::GetCount() const
 {
     return m_strings.GetCount();
 unsigned int wxVListBoxComboPopup::GetCount() const
 {
     return m_strings.GetCount();


@@ -608,9 +670,7 @@ void wxVListBoxComboPopup::SetString( int item, const wxString& str )
 
 wxString wxVListBoxComboPopup::GetStringValue() const
 {
 
 wxString wxVListBoxComboPopup::GetStringValue() const
 {

-    if ( m_value >= 0 )
-        return m_strings[m_value];
-    return wxEmptyString;
+    return m_stringValue;

 }
 
 void wxVListBoxComboPopup::SetSelection( int item )
 }
 
 void wxVListBoxComboPopup::SetSelection( int item )


@@ -620,6 +680,11 @@ void wxVListBoxComboPopup::SetSelection( int item )
 
     m_value = item;
 
 
     m_value = item;
 

+    if ( item >= 0 )
+        m_stringValue = m_strings[item];
+    else
+        m_stringValue = wxEmptyString;
+

     if ( IsCreated() )
         wxVListBox::SetSelection(item);
 }
     if ( IsCreated() )
         wxVListBox::SetSelection(item);
 }


@@ -633,10 +698,13 @@ void wxVListBoxComboPopup::SetStringValue( const wxString& value )
 {
     int index = m_strings.Index(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);
         wxVListBox::SetSelection(index);

+        m_value = index;
+    }

 }
 
 void wxVListBoxComboPopup::CalcWidths()
 }
 
 void wxVListBoxComboPopup::CalcWidths()


@@ -743,6 +811,11 @@ wxSize wxVListBoxComboPopup::GetAdjustedSize( int minWidth, int prefHeight, int
             height = maxHeight;
 
         int totalHeight = GetTotalHeight(); // + 3;
             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;
         if ( height >= totalHeight )
         {
             height = totalHeight;


@@ -792,7 +865,7 @@ void wxVListBoxComboPopup::Populate( const wxArrayString& choices )
 
     // Find initial selection
     wxString strValue = m_combo->GetValue();
 
     // Find initial selection
     wxString strValue = m_combo->GetValue();

-    if ( strValue.length() )
+    if ( !strValue.empty() )

         m_value = m_strings.Index(strValue);
 }
 
         m_value = m_strings.Index(strValue);
 }
 


@@ -804,21 +877,6 @@ void wxVListBoxComboPopup::Populate( const wxArrayString& choices )
 BEGIN_EVENT_TABLE(wxOwnerDrawnComboBox, wxComboCtrl)
 END_EVENT_TABLE()
 
 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()
 {
 }
 void wxOwnerDrawnComboBox::Init()
 {
 }


@@ -930,15 +988,22 @@ void wxOwnerDrawnComboBox::DoClear()
 
     GetVListBoxComboPopup()->Clear();
 
 
     GetVListBoxComboPopup()->Clear();
 

+    // NB: This really needs to be SetValue() instead of ChangeValue(),
+    //     as wxTextEntry API expects an event to be sent.

     SetValue(wxEmptyString);
 }
 
     SetValue(wxEmptyString);
 }
 

+void wxOwnerDrawnComboBox::Clear()
+{
+    DoClear();
+}
+

 void wxOwnerDrawnComboBox::DoDeleteOneItem(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 )
 
     if ( GetSelection() == (int) n )

-        SetValue(wxEmptyString);
+        ChangeValue(wxEmptyString);

 
     GetVListBoxComboPopup()->Delete(n);
 }
 
     GetVListBoxComboPopup()->Delete(n);
 }


@@ -953,7 +1018,7 @@ unsigned int wxOwnerDrawnComboBox::GetCount() const
 
 wxString wxOwnerDrawnComboBox::GetString(unsigned int n) 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);
 
     if ( !m_popupInterface )
         return m_initChs.Item(n);


@@ -965,7 +1030,7 @@ void wxOwnerDrawnComboBox::SetString(unsigned int n, const wxString& s)
 {
     EnsurePopupControl();
 
 {
     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);
 }
 
     GetVListBoxComboPopup()->SetString(n,s);
 }


@@ -982,7 +1047,7 @@ void wxOwnerDrawnComboBox::Select(int n)
 {
     EnsurePopupControl();
 
 {
     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);
 
 
     GetVListBoxComboPopup()->SetSelection(n);
 


@@ -992,7 +1057,7 @@ void wxOwnerDrawnComboBox::Select(int n)
 
     // Refresh text portion in control
     if ( m_text )
 
     // Refresh text portion in control
     if ( m_text )

-        m_text->SetValue( str );
+        m_text->ChangeValue( str );

     else
         m_valueString = str;
 
     else
         m_valueString = str;
 


@@ -1007,6 +1072,11 @@ int wxOwnerDrawnComboBox::GetSelection() const
     return GetVListBoxComboPopup()->GetSelection();
 }
 
     return GetVListBoxComboPopup()->GetSelection();
 }
 

+void wxOwnerDrawnComboBox::GetSelection(long *from, long *to) const
+{
+    wxComboCtrl::GetSelection(from, to);
+}
+

 int wxOwnerDrawnComboBox::DoInsertItems(const wxArrayStringsAdapter& items,
                                         unsigned int pos,
                                         void **clientData,
 int wxOwnerDrawnComboBox::DoInsertItems(const wxArrayStringsAdapter& items,
                                         unsigned int pos,
                                         void **clientData,


@@ -1015,13 +1085,29 @@ int wxOwnerDrawnComboBox::DoInsertItems(const wxArrayStringsAdapter& items,
     EnsurePopupControl();
 
     const unsigned int count = items.GetCount();
     EnsurePopupControl();
 
     const unsigned int count = items.GetCount();

-    for( unsigned int i = 0; i < count; ++i, ++pos )
+
+    if ( HasFlag(wxCB_SORT) )

     {
     {

-        GetVListBoxComboPopup()->Insert(items[i], pos);
-        AssignNewItemClientData(pos, clientData, i, type);
+        int n = pos;
+
+        for ( unsigned int i = 0; i < count; ++i )
+        {
+            n = GetVListBoxComboPopup()->Append(items[i]);
+            AssignNewItemClientData(n, clientData, i, type);
+        }
+
+        return n;

     }
     }

+    else
+    {
+        for ( unsigned int i = 0; i < count; ++i, ++pos )
+        {
+            GetVListBoxComboPopup()->Insert(items[i], pos);
+            AssignNewItemClientData(pos, clientData, i, type);
+        }

 
 

-    return pos - 1;
+        return pos - 1;
+    }

 }
 
 void wxOwnerDrawnComboBox::DoSetItemClientData(unsigned int n, void* clientData)
 }
 
 void wxOwnerDrawnComboBox::DoSetItemClientData(unsigned int n, void* clientData)


@@ -1051,8 +1137,21 @@ void wxOwnerDrawnComboBox::OnDrawItem( wxDC& dc,
 {
     if ( flags & wxODCB_PAINTING_CONTROL )
     {
 {
     if ( flags & wxODCB_PAINTING_CONTROL )
     {

-        dc.DrawText( GetValue(),
-                     rect.x + GetTextIndent(),
+        wxString text;
+
+        if ( !ShouldUseHintText() )
+        {
+            text = GetValue();
+        }
+        else
+        {
+            text = GetHint();
+            wxColour col = wxSystemSettings::GetColour(wxSYS_COLOUR_GRAYTEXT);
+            dc.SetTextForeground(col);
+        }
+
+        dc.DrawText( text,
+                     rect.x + GetMargins().x,

                      (rect.height-dc.GetCharHeight())/2 + rect.y );
     }
     else
                      (rect.height-dc.GetCharHeight())/2 + rect.y );
     }
     else