]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/srchctlg.cpp
Fixed spelling errors, fixes #14021.
[wxWidgets.git] / src / generic / srchctlg.cpp
index 8edf081475bc4d447085167c66849921d386deab..7310b9158a831099ba452fa9c8934170de68486d 100644 (file)
@@ -5,7 +5,7 @@
 // Created:     2006-02-19
 // RCS-ID:      $Id$
 // Copyright:   Vince Harron
-// License:     wxWindows licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // For compilers that support precompilation, includes "wx.h".
@@ -50,6 +50,8 @@ static const wxCoord ICON_MARGIN = 0;
 static const wxCoord ICON_OFFSET = 0;
 #endif
 
+#define LIGHT_STEP 160
+
 // ----------------------------------------------------------------------------
 // wxSearchTextCtrl: text control used by search control
 // ----------------------------------------------------------------------------
@@ -59,14 +61,34 @@ class wxSearchTextCtrl : public wxTextCtrl
 public:
     wxSearchTextCtrl(wxSearchCtrl *search, const wxString& value, int style)
         : wxTextCtrl(search, wxID_ANY, value, wxDefaultPosition, wxDefaultSize,
-                     style | wxNO_BORDER)
+                     (style & ~wxBORDER_MASK) | wxNO_BORDER)
     {
         m_search = search;
 
+        SetHint(_("Search"));
+
         // remove the default minsize, the searchctrl will have one instead
         SetSizeHints(wxDefaultCoord,wxDefaultCoord);
     }
 
+
+    // provide access to the base class protected methods to wxSearchCtrl which
+    // needs to forward to them
+    void DoSetValue(const wxString& value, int flags)
+    {
+        wxTextCtrl::DoSetValue(value, flags);
+    }
+
+    bool DoLoadFile(const wxString& file, int fileType)
+    {
+        return wxTextCtrl::DoLoadFile(file, fileType);
+    }
+
+    bool DoSaveFile(const wxString& file, int fileType)
+    {
+        return wxTextCtrl::DoSaveFile(file, fileType);
+    }
+
 protected:
     void OnText(wxCommandEvent& eventText)
     {
@@ -92,6 +114,32 @@ protected:
         m_search->GetEventHandler()->ProcessEvent(event);
     }
 
+#ifdef __WXMSW__
+    // We increase the text control height to be the same as for the controls
+    // with border as this is what we actually need here because even though
+    // this control itself is borderless, it's inside wxSearchCtrl which does
+    // have the border and so should have the same height as the normal text
+    // entries with border.
+    //
+    // This is a bit ugly and it would arguably be better to use whatever size
+    // the base class version returns and just centre the text vertically in
+    // the search control but I failed to modify the code in LayoutControls()
+    // to do this easily and as there is much in that code I don't understand
+    // (notably what is the logic for buttons sizing?) I prefer to not touch it
+    // at all.
+    virtual wxSize DoGetBestSize() const
+    {
+        const long flags = GetWindowStyleFlag();
+        wxSearchTextCtrl* const self = const_cast<wxSearchTextCtrl*>(this);
+
+        self->SetWindowStyleFlag((flags & ~wxBORDER_MASK) | wxBORDER_DEFAULT);
+        const wxSize size = wxTextCtrl::DoGetBestSize();
+        self->SetWindowStyleFlag(flags);
+
+        return size;
+    }
+#endif // __WXMSW__
+
 private:
     wxSearchCtrl* m_search;
 
@@ -121,6 +169,13 @@ public:
 
     void SetBitmapLabel(const wxBitmap& label) { m_bmp = label; }
 
+    // The buttons in wxSearchCtrl shouldn't accept focus from keyboard because
+    // this would interfere with the usual TAB processing: the user expects
+    // that pressing TAB in the search control should switch focus to the next
+    // control and not give it to the button inside the same control. Besides,
+    // the search button can be already activated by pressing "Enter" so there
+    // is really no reason for it to be able to get focus from keyboard.
+    virtual bool AcceptsFocusFromKeyboard() const { return false; }
 
 protected:
     wxSize DoGetBestSize() const
@@ -133,15 +188,25 @@ protected:
         wxCommandEvent event(m_eventType, m_search->GetId());
         event.SetEventObject(m_search);
 
+        if ( m_eventType == wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN )
+        {
+            // it's convenient to have the string to search for directly in the
+            // event instead of having to retrieve it from the control in the
+            // event handler code later, so provide it here
+            event.SetString(m_search->GetValue());
+        }
+
         GetEventHandler()->ProcessEvent(event);
 
         m_search->SetFocus();
 
+#if wxUSE_MENUS
         if ( m_eventType == wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN )
         {
             // this happens automatically, just like on Mac OS X
             m_search->PopupSearchMenu();
         }
+#endif // wxUSE_MENUS
     }
 
     void OnPaint(wxPaintEvent&)
@@ -203,17 +268,21 @@ wxSearchCtrl::wxSearchCtrl(wxWindow *parent, wxWindowID id,
 
 void wxSearchCtrl::Init()
 {
-    m_text = 0;
-    m_searchButton = 0;
-    m_cancelButton = 0;
-    m_menu = 0;
+    m_text = NULL;
+    m_searchButton = NULL;
+    m_cancelButton = NULL;
+#if wxUSE_MENUS
+    m_menu = NULL;
+#endif // wxUSE_MENUS
 
     m_searchButtonVisible = true;
     m_cancelButtonVisible = false;
 
-    m_searchMenuBitmapUser = false;
     m_searchBitmapUser = false;
     m_cancelBitmapUser = false;
+#if wxUSE_MENUS
+    m_searchMenuBitmapUser = false;
+#endif // wxUSE_MENUS
 }
 
 bool wxSearchCtrl::Create(wxWindow *parent, wxWindowID id,
@@ -224,29 +293,36 @@ bool wxSearchCtrl::Create(wxWindow *parent, wxWindowID id,
             const wxValidator& validator,
             const wxString& name)
 {
+    // force border style for more native appearance
+    style &= ~wxBORDER_MASK;
 #ifdef __WXGTK__
-    if ( !wxTextCtrlBase::Create(parent, id, pos, size, wxSUNKEN_BORDER | style, validator, name) )
+    style |= wxBORDER_SUNKEN;
+#elif defined(__WXMSW__)
+    // Don't set the style explicitly, let GetDefaultBorder() work it out, unless
+    // we will get a sunken border (e.g. on Windows 200) in which case we must
+    // override with a simple border.
+    if (GetDefaultBorder() == wxBORDER_SUNKEN)
+        style |= wxBORDER_SIMPLE;
 #else
-    if ( !wxTextCtrlBase::Create(parent, id, pos, size, wxSIMPLE_BORDER | style, validator, name) )
+    style |= wxBORDER_SIMPLE;
 #endif
+    if ( !wxSearchCtrlBaseBaseClass::Create(parent, id, pos, size,
+                                            style, validator, name) )
     {
         return false;
     }
 
-    m_text = new wxSearchTextCtrl(this, value, style & ~wxBORDER_MASK);
+    m_text = new wxSearchTextCtrl(this, value, style);
 
-    wxSize sizeText = m_text->GetBestSize();
-
-    m_searchButton = new wxSearchButton(this,wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN,m_searchBitmap);
-    m_cancelButton = new wxSearchButton(this,wxEVT_COMMAND_SEARCHCTRL_CANCEL_BTN,m_cancelBitmap);
+    m_searchButton = new wxSearchButton(this,
+                                        wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN,
+                                        m_searchBitmap);
+    m_cancelButton = new wxSearchButton(this,
+                                        wxEVT_COMMAND_SEARCHCTRL_CANCEL_BTN,
+                                        m_cancelBitmap);
 
     SetForegroundColour( m_text->GetForegroundColour() );
-    m_searchButton->SetForegroundColour( m_text->GetForegroundColour() );
-    m_cancelButton->SetForegroundColour( m_text->GetForegroundColour() );
-
     SetBackgroundColour( m_text->GetBackgroundColour() );
-    m_searchButton->SetBackgroundColour( m_text->GetBackgroundColour() );
-    m_cancelButton->SetBackgroundColour( m_text->GetBackgroundColour() );
 
     RecalcBitmaps();
 
@@ -260,11 +336,15 @@ wxSearchCtrl::~wxSearchCtrl()
     delete m_text;
     delete m_searchButton;
     delete m_cancelButton;
+#if wxUSE_MENUS
     delete m_menu;
+#endif // wxUSE_MENUS
 }
 
 
 // search control specific interfaces
+#if wxUSE_MENUS
+
 void wxSearchCtrl::SetMenu( wxMenu* menu )
 {
     if ( menu == m_menu )
@@ -280,12 +360,6 @@ void wxSearchCtrl::SetMenu( wxMenu* menu )
     {
         m_searchButton->SetBitmapLabel(m_searchMenuBitmap);
         m_searchButton->Refresh();
-        if ( !m_searchButtonVisible )
-        {
-            // adding the menu will force the search button to be visible
-            wxRect rect = GetRect();
-            LayoutControls(0, 0, rect.GetWidth(), rect.GetHeight());
-        }
     }
     else if ( !m_menu && hadMenu )
     {
@@ -294,12 +368,9 @@ void wxSearchCtrl::SetMenu( wxMenu* menu )
         {
             m_searchButton->Refresh();
         }
-        else
-        {
-            wxRect rect = GetRect();
-            LayoutControls(0, 0, rect.GetWidth(), rect.GetHeight());
-        }
     }
+    wxRect rect = GetRect();
+    LayoutControls(0, 0, rect.GetWidth(), rect.GetHeight());
 }
 
 wxMenu* wxSearchCtrl::GetMenu()
@@ -307,6 +378,8 @@ wxMenu* wxSearchCtrl::GetMenu()
     return m_menu;
 }
 
+#endif // wxUSE_MENUS
+
 void wxSearchCtrl::ShowSearchButton( bool show )
 {
     if ( m_searchButtonVisible == show )
@@ -348,6 +421,15 @@ bool wxSearchCtrl::IsCancelButtonVisible() const
     return m_cancelButtonVisible;
 }
 
+void wxSearchCtrl::SetDescriptiveText(const wxString& text)
+{
+    m_text->SetHint(text);
+}
+
+wxString wxSearchCtrl::GetDescriptiveText() const
+{
+    return m_text->GetHint();
+}
 
 // ----------------------------------------------------------------------------
 // geometry
@@ -360,7 +442,7 @@ wxSize wxSearchCtrl::DoGetBestSize() const
     wxSize sizeCancel(0,0);
     int searchMargin = 0;
     int cancelMargin = 0;
-    if ( m_searchButtonVisible || m_menu )
+    if ( m_searchButtonVisible || HasMenu() )
     {
         sizeSearch = m_searchButton->GetBestSize();
         searchMargin = MARGIN;
@@ -390,20 +472,22 @@ void wxSearchCtrl::LayoutControls(int x, int y, int width, int height)
 {
     if ( !m_text )
         return;
-    
+
     wxSize sizeText = m_text->GetBestSize();
     // make room for the search menu & clear button
-    int horizontalBorder = 1 + ( sizeText.y - sizeText.y * 14 / 21 ) / 2;
+    int horizontalBorder = ( sizeText.y - sizeText.y * 14 / 21 ) / 2;
     x += horizontalBorder;
     y += BORDER;
     width -= horizontalBorder*2;
     height -= BORDER*2;
+    if (width < 0) width = 0;
+    if (height < 0) height = 0;
 
     wxSize sizeSearch(0,0);
     wxSize sizeCancel(0,0);
     int searchMargin = 0;
     int cancelMargin = 0;
-    if ( m_searchButtonVisible || m_menu )
+    if ( m_searchButtonVisible || HasMenu() )
     {
         sizeSearch = m_searchButton->GetBestSize();
         searchMargin = MARGIN;
@@ -413,7 +497,7 @@ void wxSearchCtrl::LayoutControls(int x, int y, int width, int height)
         sizeCancel = m_cancelButton->GetBestSize();
         cancelMargin = MARGIN;
     }
-    m_searchButton->Show( m_searchButtonVisible || m_menu );
+    m_searchButton->Show( m_searchButtonVisible || HasMenu() );
     m_cancelButton->Show( m_cancelButtonVisible );
 
     if ( sizeSearch.x + sizeCancel.x > width )
@@ -423,32 +507,36 @@ void wxSearchCtrl::LayoutControls(int x, int y, int width, int height)
         searchMargin = 0;
         cancelMargin = 0;
     }
-    wxCoord textWidth = width - sizeSearch.x - sizeCancel.x - searchMargin - cancelMargin;
+    wxCoord textWidth = width - sizeSearch.x - sizeCancel.x - searchMargin - cancelMargin - 1;
+    if (textWidth < 0) textWidth = 0;
 
     // position the subcontrols inside the client area
 
-    m_searchButton->SetSize(x, y + ICON_OFFSET, sizeSearch.x, height);
-    m_text->SetSize( x + sizeSearch.x + searchMargin, 
+    m_searchButton->SetSize(x, y + ICON_OFFSET - 1, sizeSearch.x, height);
+    m_text->SetSize( x + sizeSearch.x + searchMargin,
                      y + ICON_OFFSET - BORDER,
-                     textWidth, 
+                     textWidth,
                      height);
     m_cancelButton->SetSize(x + sizeSearch.x + searchMargin + textWidth + cancelMargin,
-                            y + ICON_OFFSET, sizeCancel.x, height);
+                            y + ICON_OFFSET - 1, sizeCancel.x, height);
 }
 
+wxWindowList wxSearchCtrl::GetCompositeWindowParts() const
+{
+    wxWindowList parts;
+    parts.push_back(m_text);
+    parts.push_back(m_searchButton);
+    parts.push_back(m_cancelButton);
+    return parts;
+}
 
 // accessors
 // ---------
 
-wxString wxSearchCtrl::GetValue() const
+wxString wxSearchCtrl::DoGetValue() const
 {
     return m_text->GetValue();
 }
-void wxSearchCtrl::SetValue(const wxString& value)
-{
-    m_text->SetValue(value);
-}
-
 wxString wxSearchCtrl::GetRange(long from, long to) const
 {
     return m_text->GetRange(from, to);
@@ -670,7 +758,7 @@ long wxSearchCtrl::GetInsertionPoint() const
 {
     return m_text->GetInsertionPoint();
 }
-wxTextPos wxSearchCtrl::GetLastPosition() const
+long wxSearchCtrl::GetLastPosition() const
 {
     return m_text->GetLastPosition();
 }
@@ -691,23 +779,35 @@ void wxSearchCtrl::SetEditable(bool editable)
 
 bool wxSearchCtrl::SetFont(const wxFont& font)
 {
-    bool result = wxSearchCtrlBase::SetFont(font);
-    if ( result && m_text )
-    {
-        result = m_text->SetFont(font);
-    }
+    if ( !wxSearchCtrlBase::SetFont(font) )
+        return false;
+
+    // Recreate the bitmaps as their size may have changed.
+    RecalcBitmaps();
+
+    return true;
+}
+
+bool wxSearchCtrl::SetBackgroundColour(const wxColour& colour)
+{
+    if ( !wxSearchCtrlBase::SetBackgroundColour(colour) )
+        return false;
+
+    // When the background changes, re-render the bitmaps so that the correct
+    // colour shows in their "transparent" area.
     RecalcBitmaps();
-    return result;
+
+    return true;
 }
 
 // search control generic only
 void wxSearchCtrl::SetSearchBitmap( const wxBitmap& bitmap )
 {
     m_searchBitmap = bitmap;
-    m_searchBitmapUser = bitmap.Ok();
+    m_searchBitmapUser = bitmap.IsOk();
     if ( m_searchBitmapUser )
     {
-        if ( m_searchButton && !m_menu )
+        if ( m_searchButton && !HasMenu() )
         {
             m_searchButton->SetBitmapLabel( m_searchBitmap );
         }
@@ -719,10 +819,12 @@ void wxSearchCtrl::SetSearchBitmap( const wxBitmap& bitmap )
     }
 }
 
+#if wxUSE_MENUS
+
 void wxSearchCtrl::SetSearchMenuBitmap( const wxBitmap& bitmap )
 {
     m_searchMenuBitmap = bitmap;
-    m_searchMenuBitmapUser = bitmap.Ok();
+    m_searchMenuBitmapUser = bitmap.IsOk();
     if ( m_searchMenuBitmapUser )
     {
         if ( m_searchButton && m_menu )
@@ -737,10 +839,12 @@ void wxSearchCtrl::SetSearchMenuBitmap( const wxBitmap& bitmap )
     }
 }
 
+#endif // wxUSE_MENUS
+
 void wxSearchCtrl::SetCancelBitmap( const wxBitmap& bitmap )
 {
     m_cancelBitmap = bitmap;
-    m_cancelBitmapUser = bitmap.Ok();
+    m_cancelBitmapUser = bitmap.IsOk();
     if ( m_cancelBitmapUser )
     {
         if ( m_cancelButton )
@@ -774,9 +878,17 @@ wxTextCtrl& operator<<(const wxChar c);
 
 void wxSearchCtrl::DoSetValue(const wxString& value, int flags)
 {
-    m_text->ChangeValue( value );
-    if ( flags & SetValue_SendEvent )
-        SendTextUpdatedEvent();
+    m_text->DoSetValue(value, flags);
+}
+
+bool wxSearchCtrl::DoLoadFile(const wxString& file, int fileType)
+{
+    return m_text->DoLoadFile(file, fileType);
+}
+
+bool wxSearchCtrl::DoSaveFile(const wxString& file, int fileType)
+{
+    return m_text->DoSaveFile(file, fileType);
 }
 
 // do the window-specific processing after processing the update event
@@ -811,7 +923,7 @@ static int GetMultiplier()
 wxBitmap wxSearchCtrl::RenderSearchBitmap( int x, int y, bool renderDrop )
 {
     wxColour bg = GetBackgroundColour();
-    wxColour fg = GetForegroundColour();
+    wxColour fg = GetForegroundColour().ChangeLightness(LIGHT_STEP-20);
 
     //===============================================================================
     // begin drawing code
@@ -892,6 +1004,7 @@ wxBitmap wxSearchCtrl::RenderSearchBitmap( int x, int y, bool renderDrop )
         };
         mem.DrawPolygon(WXSIZEOF(dropPolygon),dropPolygon,multiplier*triangleX,multiplier*triangleY);
     }
+    mem.SelectObject(wxNullBitmap);
 
     //===============================================================================
     // end drawing code
@@ -903,6 +1016,11 @@ wxBitmap wxSearchCtrl::RenderSearchBitmap( int x, int y, bool renderDrop )
         image.Rescale(x,y);
         bitmap = wxBitmap( image );
     }
+    if ( !renderDrop )
+    {
+        // Trim the edge where the arrow would have gone
+        bitmap = bitmap.GetSubBitmap(wxRect(0,0, y,y));
+    }
 
     return bitmap;
 }
@@ -910,7 +1028,7 @@ wxBitmap wxSearchCtrl::RenderSearchBitmap( int x, int y, bool renderDrop )
 wxBitmap wxSearchCtrl::RenderCancelBitmap( int x, int y )
 {
     wxColour bg = GetBackgroundColour();
-    wxColour fg = GetForegroundColour();
+    wxColour fg = GetForegroundColour().ChangeLightness(LIGHT_STEP);
 
     //===============================================================================
     // begin drawing code
@@ -1006,13 +1124,13 @@ void wxSearchCtrl::RecalcBitmaps()
     if ( !m_searchBitmapUser )
     {
         if (
-            !m_searchBitmap.Ok() ||
+            !m_searchBitmap.IsOk() ||
             m_searchBitmap.GetHeight() != bitmapHeight ||
             m_searchBitmap.GetWidth() != bitmapWidth
             )
         {
             m_searchBitmap = RenderSearchBitmap(bitmapWidth,bitmapHeight,false);
-            if ( !m_menu )
+            if ( !HasMenu() )
             {
                 m_searchButton->SetBitmapLabel(m_searchBitmap);
             }
@@ -1020,10 +1138,11 @@ void wxSearchCtrl::RecalcBitmaps()
         // else this bitmap was set by user, don't alter
     }
 
+#if wxUSE_MENUS
     if ( !m_searchMenuBitmapUser )
     {
         if (
-            !m_searchMenuBitmap.Ok() ||
+            !m_searchMenuBitmap.IsOk() ||
             m_searchMenuBitmap.GetHeight() != bitmapHeight ||
             m_searchMenuBitmap.GetWidth() != bitmapWidth
             )
@@ -1036,16 +1155,17 @@ void wxSearchCtrl::RecalcBitmaps()
         }
         // else this bitmap was set by user, don't alter
     }
+#endif // wxUSE_MENUS
 
     if ( !m_cancelBitmapUser )
     {
         if (
-            !m_cancelBitmap.Ok() ||
+            !m_cancelBitmap.IsOk() ||
             m_cancelBitmap.GetHeight() != bitmapHeight ||
             m_cancelBitmap.GetWidth() != bitmapHeight
             )
         {
-            m_cancelBitmap = RenderCancelBitmap(bitmapHeight-BORDER,bitmapHeight-BORDER); // square
+            m_cancelBitmap = RenderCancelBitmap(bitmapHeight-BORDER-1,bitmapHeight-BORDER-1); // square
             m_cancelButton->SetBitmapLabel(m_cancelBitmap);
         }
         // else this bitmap was set by user, don't alter
@@ -1072,6 +1192,8 @@ void wxSearchCtrl::OnSize( wxSizeEvent& WXUNUSED(event) )
     LayoutControls(0, 0, width, height);
 }
 
+#if wxUSE_MENUS
+
 void wxSearchCtrl::PopupSearchMenu()
 {
     if ( m_menu )
@@ -1081,6 +1203,8 @@ void wxSearchCtrl::PopupSearchMenu()
     }
 }
 
+#endif // wxUSE_MENUS
+
 #endif // !wxUSE_NATIVE_SEARCH_CONTROL
 
 #endif // wxUSE_SEARCHCTRL