Remove some out of date comments.

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

diff --git a/src/generic/srchctlg.cpp b/src/generic/srchctlg.cpp
index f9ac1a41ddcb4cfefc65bb51ea9b7caa14fbb2fd..d0efcd17b308f97a2ed004eed13b3192be5900c0 100644 (file)
--- a/src/generic/srchctlg.cpp
+++ b/src/generic/srchctlg.cpp
@@ -5,7 +5,7 @@
 // Created:     2006-02-19
 // RCS-ID:      $Id$
 // Copyright:   Vince Harron
 // Created:     2006-02-19
 // RCS-ID:      $Id$
 // Copyright:   Vince Harron

-// License:     wxWindows licence
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 // For compilers that support precompilation, includes "wx.h".
 ///////////////////////////////////////////////////////////////////////////////
 
 // For compilers that support precompilation, includes "wx.h".


@@ -50,55 +50,6 @@ static const wxCoord ICON_MARGIN = 0;
 static const wxCoord ICON_OFFSET = 0;
 #endif
 
 static const wxCoord ICON_OFFSET = 0;
 #endif
 

-// ----------------------------------------------------------------------------
-// TODO: These functions or something like them should probably be made
-// public.  There are similar functions in src/aui/dockart.cpp...
-
-static double wxBlendColour(double fg, double bg, double alpha)
-{
-    double result = bg + (alpha * (fg - bg));
-    if (result < 0.0)
-        result = 0.0;
-    if (result > 255)
-        result = 255;
-    return result;
-}
-
-static wxColor wxStepColour(const wxColor& c, int ialpha)
-{
-    if (ialpha == 100)
-        return c;
-
-    double r = c.Red(), g = c.Green(), b = c.Blue();
-    double bg;
-
-    // ialpha is 0..200 where 0 is completely black
-    // and 200 is completely white and 100 is the same
-    // convert that to normal alpha 0.0 - 1.0
-    ialpha = wxMin(ialpha, 200);
-    ialpha = wxMax(ialpha, 0);
-    double alpha = ((double)(ialpha - 100.0))/100.0;
-
-    if (ialpha > 100)
-    {
-        // blend with white
-        bg = 255.0;
-        alpha = 1.0 - alpha;  // 0 = transparent fg; 1 = opaque fg
-    }
-     else
-    {
-        // blend with black
-        bg = 0.0;
-        alpha = 1.0 + alpha;  // 0 = transparent fg; 1 = opaque fg
-    }
-
-    r = wxBlendColour(r, bg, alpha);
-    g = wxBlendColour(g, bg, alpha);
-    b = wxBlendColour(b, bg, alpha);
-
-    return wxColour((unsigned char)r, (unsigned char)g, (unsigned char)b);
-}
-

 #define LIGHT_STEP 160
 
 // ----------------------------------------------------------------------------
 #define LIGHT_STEP 160
 
 // ----------------------------------------------------------------------------


@@ -110,28 +61,32 @@ class wxSearchTextCtrl : public wxTextCtrl
 public:
     wxSearchTextCtrl(wxSearchCtrl *search, const wxString& value, int style)
         : wxTextCtrl(search, wxID_ANY, value, wxDefaultPosition, wxDefaultSize,
 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;
     {
         m_search = search;

-        m_defaultFG = GetForegroundColour();
+
+        SetHint(_("Search"));

 
         // remove the default minsize, the searchctrl will have one instead
         SetSizeHints(wxDefaultCoord,wxDefaultCoord);
     }
 
 
         // remove the default minsize, the searchctrl will have one instead
         SetSizeHints(wxDefaultCoord,wxDefaultCoord);
     }
 

-    void SetDescriptiveText(const wxString& text)
+
+    // provide access to the base class protected methods to wxSearchCtrl which
+    // needs to forward to them
+    void DoSetValue(const wxString& value, int flags)

     {
     {

-        if ( GetValue() == m_descriptiveText )
-        {
-            ChangeValue(wxEmptyString);
-        }
+        wxTextCtrl::DoSetValue(value, flags);
+    }

 
 

-        m_descriptiveText = text;
+    bool DoLoadFile(const wxString& file, int fileType)
+    {
+        return wxTextCtrl::DoLoadFile(file, fileType);

     }
 
     }
 

-    wxString GetDescriptiveText() const
+    bool DoSaveFile(const wxString& file, int fileType)

     {
     {

-        return m_descriptiveText;
+        return wxTextCtrl::DoSaveFile(file, fileType);

     }
 
 protected:
     }
 
 protected:


@@ -159,30 +114,8 @@ protected:
         m_search->GetEventHandler()->ProcessEvent(event);
     }
 
         m_search->GetEventHandler()->ProcessEvent(event);
     }
 

-    void OnIdle(wxIdleEvent& WXUNUSED(event))
-    {
-        if ( IsEmpty() && !(wxWindow::FindFocus() == this) )
-        {
-            ChangeValue(m_descriptiveText);
-            SetInsertionPoint(0);
-            SetForegroundColour(wxStepColour(m_defaultFG, LIGHT_STEP));
-        }
-    }
-
-    void OnFocus(wxFocusEvent& event)
-    {
-        event.Skip();
-        if ( GetValue() == m_descriptiveText )
-        {
-            ChangeValue(wxEmptyString);
-            SetForegroundColour(m_defaultFG);
-        }
-    }
-

 private:
     wxSearchCtrl* m_search;
 private:
     wxSearchCtrl* m_search;

-    wxString      m_descriptiveText;
-    wxColour      m_defaultFG;

 
     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };


@@ -192,8 +125,6 @@ BEGIN_EVENT_TABLE(wxSearchTextCtrl, wxTextCtrl)
     EVT_TEXT_ENTER(wxID_ANY, wxSearchTextCtrl::OnText)
     EVT_TEXT_URL(wxID_ANY, wxSearchTextCtrl::OnTextUrl)
     EVT_TEXT_MAXLEN(wxID_ANY, wxSearchTextCtrl::OnText)
     EVT_TEXT_ENTER(wxID_ANY, wxSearchTextCtrl::OnText)
     EVT_TEXT_URL(wxID_ANY, wxSearchTextCtrl::OnTextUrl)
     EVT_TEXT_MAXLEN(wxID_ANY, wxSearchTextCtrl::OnText)

-    EVT_IDLE(wxSearchTextCtrl::OnIdle)
-    EVT_SET_FOCUS(wxSearchTextCtrl::OnFocus)

 END_EVENT_TABLE()
 
 // ----------------------------------------------------------------------------
 END_EVENT_TABLE()
 
 // ----------------------------------------------------------------------------


@@ -212,6 +143,13 @@ public:
 
     void SetBitmapLabel(const wxBitmap& label) { m_bmp = label; }
 
 
     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
 
 protected:
     wxSize DoGetBestSize() const


@@ -224,6 +162,14 @@ protected:
         wxCommandEvent event(m_eventType, m_search->GetId());
         event.SetEventObject(m_search);
 
         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();
         GetEventHandler()->ProcessEvent(event);
 
         m_search->SetFocus();


@@ -334,15 +280,13 @@ bool wxSearchCtrl::Create(wxWindow *parent, wxWindowID id,
 #else
     style |= wxBORDER_SIMPLE;
 #endif
 #else
     style |= wxBORDER_SIMPLE;
 #endif

-    if ( !wxTextCtrlBase::Create(parent, id, pos, size, style, validator, name) )
+    if ( !wxSearchCtrlBaseBaseClass::Create(parent, id, pos, size,
+                                            style, validator, name) )

     {
         return false;
     }
 
     {
         return false;
     }
 

-    m_text = new wxSearchTextCtrl(this, value, style & ~wxBORDER_MASK);
-    m_text->SetDescriptiveText(_("Search"));
-
-    wxSize sizeText = m_text->GetBestSize();
+    m_text = new wxSearchTextCtrl(this, value, style);

 
     m_searchButton = new wxSearchButton(this,
                                         wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN,
 
     m_searchButton = new wxSearchButton(this,
                                         wxEVT_COMMAND_SEARCHCTRL_SEARCH_BTN,


@@ -458,12 +402,12 @@ bool wxSearchCtrl::IsCancelButtonVisible() const
 
 void wxSearchCtrl::SetDescriptiveText(const wxString& text)
 {
 
 void wxSearchCtrl::SetDescriptiveText(const wxString& text)
 {

-    m_text->SetDescriptiveText(text);
+    m_text->SetHint(text);

 }
 
 wxString wxSearchCtrl::GetDescriptiveText() const
 {
 }
 
 wxString wxSearchCtrl::GetDescriptiveText() const
 {

-    return m_text->GetDescriptiveText();
+    return m_text->GetHint();

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -515,6 +459,8 @@ void wxSearchCtrl::LayoutControls(int x, int y, int width, int height)
     y += BORDER;
     width -= horizontalBorder*2;
     height -= BORDER*2;
     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);
 
     wxSize sizeSearch(0,0);
     wxSize sizeCancel(0,0);


@@ -540,7 +486,8 @@ void wxSearchCtrl::LayoutControls(int x, int y, int width, int height)
         searchMargin = 0;
         cancelMargin = 0;
     }
         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
 
 
     // position the subcontrols inside the client area
 


@@ -557,19 +504,10 @@ void wxSearchCtrl::LayoutControls(int x, int y, int width, int height)
 // accessors
 // ---------
 
 // accessors
 // ---------
 

-wxString wxSearchCtrl::GetValue() const
-{
-    wxString value = m_text->GetValue();
-    if (value == m_text->GetDescriptiveText())
-        return wxEmptyString;
-    else
-        return value;
-}
-void wxSearchCtrl::SetValue(const wxString& value)
+wxString wxSearchCtrl::DoGetValue() const

 {
 {

-    m_text->SetValue(value);
+    return m_text->GetValue();

 }
 }

-

 wxString wxSearchCtrl::GetRange(long from, long to) const
 {
     return m_text->GetRange(from, to);
 wxString wxSearchCtrl::GetRange(long from, long to) const
 {
     return m_text->GetRange(from, to);


@@ -791,7 +729,7 @@ long wxSearchCtrl::GetInsertionPoint() const
 {
     return m_text->GetInsertionPoint();
 }
 {
     return m_text->GetInsertionPoint();
 }

-wxTextPos wxSearchCtrl::GetLastPosition() const
+long wxSearchCtrl::GetLastPosition() const

 {
     return m_text->GetLastPosition();
 }
 {
     return m_text->GetLastPosition();
 }


@@ -825,7 +763,7 @@ bool wxSearchCtrl::SetFont(const wxFont& font)
 void wxSearchCtrl::SetSearchBitmap( const wxBitmap& bitmap )
 {
     m_searchBitmap = bitmap;
 void wxSearchCtrl::SetSearchBitmap( const wxBitmap& bitmap )
 {
     m_searchBitmap = bitmap;

-    m_searchBitmapUser = bitmap.Ok();
+    m_searchBitmapUser = bitmap.IsOk();

     if ( m_searchBitmapUser )
     {
         if ( m_searchButton && !HasMenu() )
     if ( m_searchBitmapUser )
     {
         if ( m_searchButton && !HasMenu() )


@@ -845,7 +783,7 @@ void wxSearchCtrl::SetSearchBitmap( const wxBitmap& bitmap )
 void wxSearchCtrl::SetSearchMenuBitmap( const wxBitmap& bitmap )
 {
     m_searchMenuBitmap = bitmap;
 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 )
     if ( m_searchMenuBitmapUser )
     {
         if ( m_searchButton && m_menu )


@@ -865,7 +803,7 @@ void wxSearchCtrl::SetSearchMenuBitmap( const wxBitmap& bitmap )
 void wxSearchCtrl::SetCancelBitmap( const wxBitmap& bitmap )
 {
     m_cancelBitmap = bitmap;
 void wxSearchCtrl::SetCancelBitmap( const wxBitmap& bitmap )
 {
     m_cancelBitmap = bitmap;

-    m_cancelBitmapUser = bitmap.Ok();
+    m_cancelBitmapUser = bitmap.IsOk();

     if ( m_cancelBitmapUser )
     {
         if ( m_cancelButton )
     if ( m_cancelBitmapUser )
     {
         if ( m_cancelButton )


@@ -899,9 +837,17 @@ wxTextCtrl& operator<<(const wxChar c);
 
 void wxSearchCtrl::DoSetValue(const wxString& value, int flags)
 {
 
 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
 }
 
 // do the window-specific processing after processing the update event


@@ -936,7 +882,7 @@ static int GetMultiplier()
 wxBitmap wxSearchCtrl::RenderSearchBitmap( int x, int y, bool renderDrop )
 {
     wxColour bg = GetBackgroundColour();
 wxBitmap wxSearchCtrl::RenderSearchBitmap( int x, int y, bool renderDrop )
 {
     wxColour bg = GetBackgroundColour();

-    wxColour fg = wxStepColour(GetForegroundColour(), LIGHT_STEP-20);
+    wxColour fg = GetForegroundColour().ChangeLightness(LIGHT_STEP-20);

 
     //===============================================================================
     // begin drawing code
 
     //===============================================================================
     // begin drawing code


@@ -1041,7 +987,7 @@ wxBitmap wxSearchCtrl::RenderSearchBitmap( int x, int y, bool renderDrop )
 wxBitmap wxSearchCtrl::RenderCancelBitmap( int x, int y )
 {
     wxColour bg = GetBackgroundColour();
 wxBitmap wxSearchCtrl::RenderCancelBitmap( int x, int y )
 {
     wxColour bg = GetBackgroundColour();

-    wxColour fg = wxStepColour(GetForegroundColour(), LIGHT_STEP);
+    wxColour fg = GetForegroundColour().ChangeLightness(LIGHT_STEP);

 
     //===============================================================================
     // begin drawing code
 
     //===============================================================================
     // begin drawing code


@@ -1137,7 +1083,7 @@ void wxSearchCtrl::RecalcBitmaps()
     if ( !m_searchBitmapUser )
     {
         if (
     if ( !m_searchBitmapUser )
     {
         if (

-            !m_searchBitmap.Ok() ||
+            !m_searchBitmap.IsOk() ||

             m_searchBitmap.GetHeight() != bitmapHeight ||
             m_searchBitmap.GetWidth() != bitmapWidth
             )
             m_searchBitmap.GetHeight() != bitmapHeight ||
             m_searchBitmap.GetWidth() != bitmapWidth
             )


@@ -1155,7 +1101,7 @@ void wxSearchCtrl::RecalcBitmaps()
     if ( !m_searchMenuBitmapUser )
     {
         if (
     if ( !m_searchMenuBitmapUser )
     {
         if (

-            !m_searchMenuBitmap.Ok() ||
+            !m_searchMenuBitmap.IsOk() ||

             m_searchMenuBitmap.GetHeight() != bitmapHeight ||
             m_searchMenuBitmap.GetWidth() != bitmapWidth
             )
             m_searchMenuBitmap.GetHeight() != bitmapHeight ||
             m_searchMenuBitmap.GetWidth() != bitmapWidth
             )


@@ -1173,12 +1119,12 @@ void wxSearchCtrl::RecalcBitmaps()
     if ( !m_cancelBitmapUser )
     {
         if (
     if ( !m_cancelBitmapUser )
     {
         if (

-            !m_cancelBitmap.Ok() ||
+            !m_cancelBitmap.IsOk() ||

             m_cancelBitmap.GetHeight() != bitmapHeight ||
             m_cancelBitmap.GetWidth() != bitmapHeight
             )
         {
             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
             m_cancelButton->SetBitmapLabel(m_cancelBitmap);
         }
         // else this bitmap was set by user, don't alter