Add backend descriptions for all backends to the documentation.

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

diff --git a/src/generic/infobar.cpp b/src/generic/infobar.cpp
index e23f356255f169f158aac73db87a12e55ff47427..76001a4a17e9df3035c16c1a588e55ff348f2f00 100644 (file)
--- a/src/generic/infobar.cpp
+++ b/src/generic/infobar.cpp
@@ -3,7 +3,7 @@
 // Purpose:     generic wxInfoBar implementation
 // Author:      Vadim Zeitlin
 // Created:     2009-07-28
 // Purpose:     generic wxInfoBar implementation
 // Author:      Vadim Zeitlin
 // Created:     2009-07-28

-// RCS-ID:      $Id: wxhead.cpp,v 1.10 2009-06-29 10:23:04 zeitlin Exp $
+// RCS-ID:      $Id$

 // Copyright:   (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////


@@ -25,24 +25,54 @@
 
 #if wxUSE_INFOBAR
 
 
 #if wxUSE_INFOBAR
 

+#include "wx/infobar.h"
+

 #ifndef WX_PRECOMP
     #include "wx/bmpbuttn.h"
     #include "wx/button.h"
 #ifndef WX_PRECOMP
     #include "wx/bmpbuttn.h"
     #include "wx/button.h"

+    #include "wx/dcmemory.h"

     #include "wx/settings.h"
     #include "wx/statbmp.h"
     #include "wx/stattext.h"
     #include "wx/settings.h"
     #include "wx/statbmp.h"
     #include "wx/stattext.h"

+    #include "wx/sizer.h"

 #endif // WX_PRECOMP
 
 #endif // WX_PRECOMP
 

-#include "wx/infobar.h"
-

 #include "wx/artprov.h"
 #include "wx/artprov.h"

+#include "wx/renderer.h"

 #include "wx/scopeguard.h"
 #include "wx/scopeguard.h"

-#include "wx/sizer.h"

 
 BEGIN_EVENT_TABLE(wxInfoBarGeneric, wxInfoBarBase)
     EVT_BUTTON(wxID_ANY, wxInfoBarGeneric::OnButton)
 END_EVENT_TABLE()
 
 
 BEGIN_EVENT_TABLE(wxInfoBarGeneric, wxInfoBarBase)
     EVT_BUTTON(wxID_ANY, wxInfoBarGeneric::OnButton)
 END_EVENT_TABLE()
 

+// ----------------------------------------------------------------------------
+// local helpers
+// ----------------------------------------------------------------------------
+
+namespace
+{
+
+#ifdef wxHAS_DRAW_TITLE_BAR_BITMAP
+
+wxBitmap
+GetCloseButtonBitmap(wxWindow *win,
+                     const wxSize& size,
+                     const wxColour& colBg,
+                     int flags = 0)
+{
+    wxBitmap bmp(size);
+    wxMemoryDC dc(bmp);
+    dc.SetBackground(colBg);
+    dc.Clear();
+    wxRendererNative::Get().
+        DrawTitleBarBitmap(win, dc, size, wxTITLEBAR_BUTTON_CLOSE, flags);
+    return bmp;
+}
+
+#endif // wxHAS_DRAW_TITLE_BAR_BITMAP
+
+} // anonymous namespace
+

 // ============================================================================
 // implementation
 // ============================================================================
 // ============================================================================
 // implementation
 // ============================================================================


@@ -53,8 +83,8 @@ void wxInfoBarGeneric::Init()
     m_text = NULL;
     m_button = NULL;
 
     m_text = NULL;
     m_button = NULL;
 

-    m_showEffect = wxSHOW_EFFECT_SLIDE_TO_BOTTOM;
-    m_hideEffect = wxSHOW_EFFECT_SLIDE_TO_TOP;
+    m_showEffect =
+    m_hideEffect = wxSHOW_EFFECT_MAX;

 
     // use default effect duration
     m_effectDuration = 0;
 
     // use default effect duration
     m_effectDuration = 0;


@@ -69,7 +99,8 @@ bool wxInfoBarGeneric::Create(wxWindow *parent, wxWindowID winid)
         return false;
 
     // use special, easy to notice, colours
         return false;
 
     // use special, easy to notice, colours

-    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOBK));
+    const wxColour colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_INFOBK);
+    SetBackgroundColour(colBg);

     SetOwnForegroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOTEXT));
 
     // create the controls: icon, text and the button to dismiss the
     SetOwnForegroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOTEXT));
 
     // create the controls: icon, text and the button to dismiss the


@@ -80,16 +111,31 @@ bool wxInfoBarGeneric::Create(wxWindow *parent, wxWindowID winid)
 
     m_text = new wxStaticText(this, wxID_ANY, "");
 
 
     m_text = new wxStaticText(this, wxID_ANY, "");
 

+#ifdef wxHAS_DRAW_TITLE_BAR_BITMAP
+    const wxSize sizeBmp = wxArtProvider::GetSizeHint(wxART_BUTTON);
+    wxBitmap bmp = GetCloseButtonBitmap(this, sizeBmp, colBg);
+#else // !wxHAS_DRAW_TITLE_BAR_BITMAP
+    wxBitmap bmp = wxArtProvider::GetBitmap(wxART_CLOSE, wxART_BUTTON);
+#endif // wxHAS_DRAW_TITLE_BAR_BITMAP

     m_button = new wxBitmapButton
                    (
                     this,
                     wxID_ANY,
     m_button = new wxBitmapButton
                    (
                     this,
                     wxID_ANY,

-                    wxArtProvider::GetBitmap(wxART_CLOSE, wxART_MENU),
+                    bmp,

                     wxDefaultPosition,
                     wxDefaultSize,
                     wxBORDER_NONE
                    );
                     wxDefaultPosition,
                     wxDefaultSize,
                     wxBORDER_NONE
                    );

-    m_button->SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOBK));
+
+#ifdef wxHAS_DRAW_TITLE_BAR_BITMAP
+    m_button->SetBitmapPressed(
+        GetCloseButtonBitmap(this, sizeBmp, colBg, wxCONTROL_PRESSED));
+
+    m_button->SetBitmapCurrent(
+        GetCloseButtonBitmap(this, sizeBmp, colBg, wxCONTROL_CURRENT));
+#endif // wxHAS_DRAW_TITLE_BAR_BITMAP
+
+    m_button->SetBackgroundColour(colBg);

     m_button->SetToolTip(_("Hide this notification message."));
 
     // center the text inside the sizer with an icon to the left of it and a
     m_button->SetToolTip(_("Hide this notification message."));
 
     // center the text inside the sizer with an icon to the left of it and a


@@ -119,61 +165,78 @@ bool wxInfoBarGeneric::SetFont(const wxFont& font)
     return true;
 }
 
     return true;
 }
 

-void wxInfoBarGeneric::UpdateParent()
+wxInfoBarGeneric::BarPlacement wxInfoBarGeneric::GetBarPlacement() const

 {
 {

-    wxWindow * const parent = wxGetTopLevelParent(GetParent());
-    parent->Layout();
+    wxSizer * const sizer = GetContainingSizer();
+    if ( !sizer )
+        return BarPlacement_Unknown;
+
+    // FIXME-VC6: can't compare "const wxInfoBarGeneric *" and "wxWindow *",
+    //            so need this workaround
+    wxWindow * const self = const_cast<wxInfoBarGeneric *>(this);
+    const wxSizerItemList& siblings = sizer->GetChildren();
+    if ( siblings.GetFirst()->GetData()->GetWindow() == self )
+        return BarPlacement_Top;
+    else if ( siblings.GetLast()->GetData()->GetWindow() == self )
+        return BarPlacement_Bottom;
+    else
+        return BarPlacement_Unknown;

 }
 
 }
 

-void wxInfoBarGeneric::ChangeParentBackground()
+wxShowEffect wxInfoBarGeneric::GetShowEffect() const

 {
 {

-    wxWindow * const parent = GetParent();
-    m_origParentBgCol = parent->GetBackgroundColour();
+    if ( m_showEffect != wxSHOW_EFFECT_MAX )
+        return m_showEffect;

 
 

-    wxSizer * const sizer = GetContainingSizer();
-    if ( !sizer )
-        return;
-
-    wxWindow *sibling = NULL;
-    for ( wxSizerItemList::compatibility_iterator
-            node = sizer->GetChildren().GetFirst();
-            node;
-            node = node->GetNext() )
+    switch ( GetBarPlacement() )

     {
     {

-        if ( node->GetData()->GetWindow() == this )
-        {
-            // find the next window following us
-            for ( node = node->GetNext();
-                  node;
-                  node = node->GetNext() )
-            {
-                wxSizerItem * const item = node->GetData();
-                if ( item->IsWindow() )
-                {
-                    sibling = item->GetWindow();
-                    break;
-                }
-            }
+        case BarPlacement_Top:
+            return wxSHOW_EFFECT_SLIDE_TO_BOTTOM;

 
 

-            break;
-        }
+        case BarPlacement_Bottom:
+            return wxSHOW_EFFECT_SLIDE_TO_TOP;
+
+        default:
+            wxFAIL_MSG( "unknown info bar placement" );
+            // fall through
+
+        case BarPlacement_Unknown:
+            return wxSHOW_EFFECT_NONE;

     }
     }

+}
+
+wxShowEffect wxInfoBarGeneric::GetHideEffect() const
+{
+    if ( m_hideEffect != wxSHOW_EFFECT_MAX )
+        return m_hideEffect;

 
 

-    if ( sibling )
-        parent->SetOwnBackgroundColour(sibling->GetBackgroundColour());
+    switch ( GetBarPlacement() )
+    {
+        case BarPlacement_Top:
+            return wxSHOW_EFFECT_SLIDE_TO_TOP;
+
+        case BarPlacement_Bottom:
+            return wxSHOW_EFFECT_SLIDE_TO_BOTTOM;
+
+        default:
+            wxFAIL_MSG( "unknown info bar placement" );
+            // fall through
+
+        case BarPlacement_Unknown:
+            return wxSHOW_EFFECT_NONE;
+    }

 }
 
 }
 

-void wxInfoBarGeneric::RestoreParentBackground()
+void wxInfoBarGeneric::UpdateParent()

 {
 {

-    GetParent()->SetOwnBackgroundColour(m_origParentBgCol);
+    wxWindow * const parent = GetParent();
+    parent->Layout();

 }
 
 void wxInfoBarGeneric::DoHide()
 {
 }
 
 void wxInfoBarGeneric::DoHide()
 {

-    ChangeParentBackground();
-    wxON_BLOCK_EXIT_THIS0( wxInfoBarGeneric::RestoreParentBackground );
+    HideWithEffect(GetHideEffect(), GetEffectDuration());

 
 

-    HideWithEffect(m_hideEffect, m_effectDuration);

     UpdateParent();
 }
 
     UpdateParent();
 }
 


@@ -189,12 +252,6 @@ void wxInfoBarGeneric::DoShow()
     // without really showing it
     wxWindowBase::Show();
 
     // without really showing it
     wxWindowBase::Show();
 

-    // an extra hack: we want the temporarily uncovered area in which we're
-    // going to expand to look like part of this sibling for a better effect so
-    // temporarily change the background of our parent to the same colour
-    ChangeParentBackground();
-    wxON_BLOCK_EXIT_THIS0( wxInfoBarGeneric::RestoreParentBackground );
-

     // adjust the parent layout to account for us
     UpdateParent();
 
     // adjust the parent layout to account for us
     UpdateParent();
 


@@ -204,7 +261,7 @@ void wxInfoBarGeneric::DoShow()
 
 
     // finally do really show the window.
 
 
     // finally do really show the window.

-    ShowWithEffect(m_showEffect, m_effectDuration);
+    ShowWithEffect(GetShowEffect(), GetEffectDuration());

 }
 
 void wxInfoBarGeneric::ShowMessage(const wxString& msg, int flags)
 }
 
 void wxInfoBarGeneric::ShowMessage(const wxString& msg, int flags)


@@ -219,7 +276,7 @@ void wxInfoBarGeneric::ShowMessage(const wxString& msg, int flags)
     {
         m_icon->SetBitmap(wxArtProvider::GetBitmap(
                             wxArtProvider::GetMessageBoxIconId(flags),
     {
         m_icon->SetBitmap(wxArtProvider::GetBitmap(
                             wxArtProvider::GetMessageBoxIconId(flags),

-                          wxART_MENU));
+                          wxART_BUTTON));

         m_icon->Show();
     }
 
         m_icon->Show();
     }
 


@@ -257,8 +314,14 @@ void wxInfoBarGeneric::AddButton(wxWindowID btnid, const wxString& label)
         m_button->Hide();
     }
 
         m_button->Hide();
     }
 

-    sizer->Add(new wxButton(this, btnid, label),
-               wxSizerFlags().Centre().DoubleBorder());
+    wxButton * const button = new wxButton(this, btnid, label);
+
+#ifdef __WXMAC__
+    // smaller buttons look better in the (narrow) info bar under OS X
+    button->SetWindowVariant(wxWINDOW_VARIANT_SMALL);
+#endif // __WXMAC__
+
+    sizer->Add(button, wxSizerFlags().Centre().DoubleBorder());

 }
 
 void wxInfoBarGeneric::RemoveButton(wxWindowID btnid)
 }
 
 void wxInfoBarGeneric::RemoveButton(wxWindowID btnid)