src/generic/infobar.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/generic/infobar.cpp
   3 // Purpose:     generic wxInfoBar implementation
   4 // Author:      Vadim Zeitlin
   5 // Created:     2009-07-28
   6 // RCS-ID:      $Id: wxhead.cpp,v 1.10 2009-06-29 10:23:04 zeitlin Exp $
   7 // Copyright:   (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 // ============================================================================
  12 // declarations
  13 // ============================================================================
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 // for compilers that support precompilation, includes "wx.h".
  20 #include "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23     #pragma hdrstop
  24 #endif
  25
  26 #if wxUSE_INFOBAR
  27
  28 #ifndef WX_PRECOMP
  29     #include "wx/bmpbuttn.h"
  30     #include "wx/button.h"
  31     #include "wx/settings.h"
  32     #include "wx/statbmp.h"
  33     #include "wx/stattext.h"
  34 #endif // WX_PRECOMP
  35
  36 #include "wx/infobar.h"
  37
  38 #include "wx/artprov.h"
  39 #include "wx/renderer.h"
  40 #include "wx/scopeguard.h"
  41 #include "wx/sizer.h"
  42
  43 BEGIN_EVENT_TABLE(wxInfoBarGeneric, wxInfoBarBase)
  44     EVT_BUTTON(wxID_ANY, wxInfoBarGeneric::OnButton)
  45 END_EVENT_TABLE()
  46
  47 // ----------------------------------------------------------------------------
  48 // local helpers
  49 // ----------------------------------------------------------------------------
  50
  51 namespace
  52 {
  53
  54 #ifdef wxHAS_DRAW_TITLE_BAR_BITMAP
  55
  56 wxBitmap
  57 GetCloseButtonBitmap(wxWindow *win,
  58                      const wxSize& size,
  59                      const wxColour& colBg,
  60                      int flags = 0)
  61 {
  62     wxBitmap bmp(size);
  63     wxMemoryDC dc(bmp);
  64     dc.SetBackground(colBg);
  65     dc.Clear();
  66     wxRendererNative::Get().
  67         DrawTitleBarBitmap(win, dc, size, wxTITLEBAR_BUTTON_CLOSE, flags);
  68     return bmp;
  69 }
  70
  71 #endif // wxHAS_DRAW_TITLE_BAR_BITMAP
  72
  73 } // anonymous namespace
  74
  75 // ============================================================================
  76 // implementation
  77 // ============================================================================
  78
  79 void wxInfoBarGeneric::Init()
  80 {
  81     m_icon = NULL;
  82     m_text = NULL;
  83     m_button = NULL;
  84
  85     m_showEffect = wxSHOW_EFFECT_SLIDE_TO_BOTTOM;
  86     m_hideEffect = wxSHOW_EFFECT_SLIDE_TO_TOP;
  87
  88     // use default effect duration
  89     m_effectDuration = 0;
  90 }
  91
  92 bool wxInfoBarGeneric::Create(wxWindow *parent, wxWindowID winid)
  93 {
  94     // calling Hide() before Create() ensures that we're created initially
  95     // hidden
  96     Hide();
  97     if ( !wxWindow::Create(parent, winid) )
  98         return false;
  99
 100     // use special, easy to notice, colours
 101     const wxColour colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_INFOBK);
 102     SetBackgroundColour(colBg);
 103     SetOwnForegroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_INFOTEXT));
 104
 105     // create the controls: icon, text and the button to dismiss the
 106     // message.
 107
 108     // the icon is not shown unless it's assigned a valid bitmap
 109     m_icon = new wxStaticBitmap(this, wxID_ANY, wxNullBitmap);
 110
 111     m_text = new wxStaticText(this, wxID_ANY, "");
 112
 113 #ifdef wxHAS_DRAW_TITLE_BAR_BITMAP
 114     const wxSize sizeBmp = wxArtProvider::GetSizeHint(wxART_FRAME_ICON);
 115     wxBitmap bmp = GetCloseButtonBitmap(this, sizeBmp, colBg);
 116 #else // !wxHAS_DRAW_TITLE_BAR_BITMAP
 117     wxBitmap bmp = wxArtProvider::GetBitmap(wxART_CLOSE, wxART_MENU);
 118 #endif // wxHAS_DRAW_TITLE_BAR_BITMAP
 119     m_button = new wxBitmapButton
 120                    (
 121                     this,
 122                     wxID_ANY,
 123                     bmp,
 124                     wxDefaultPosition,
 125                     wxDefaultSize,
 126                     wxBORDER_NONE
 127                    );
 128
 129 #ifdef wxHAS_DRAW_TITLE_BAR_BITMAP
 130     m_button->SetBitmapPressed(
 131         GetCloseButtonBitmap(this, sizeBmp, colBg, wxCONTROL_PRESSED));
 132
 133     m_button->SetBitmapCurrent(
 134         GetCloseButtonBitmap(this, sizeBmp, colBg, wxCONTROL_CURRENT));
 135 #endif // wxHAS_DRAW_TITLE_BAR_BITMAP
 136
 137     m_button->SetBackgroundColour(colBg);
 138     m_button->SetToolTip(_("Hide this notification message."));
 139
 140     // center the text inside the sizer with an icon to the left of it and a
 141     // button at the very right
 142     //
 143     // NB: AddButton() relies on the button being the last control in the sizer
 144     //     and being preceded by a spacer
 145     wxSizer * const sizer = new wxBoxSizer(wxHORIZONTAL);
 146     sizer->Add(m_icon, wxSizerFlags().Centre().Border());
 147     sizer->Add(m_text, wxSizerFlags().Centre());
 148     sizer->AddStretchSpacer();
 149     sizer->Add(m_button, wxSizerFlags().Centre().Border());
 150     SetSizer(sizer);
 151
 152     return true;
 153 }
 154
 155 bool wxInfoBarGeneric::SetFont(const wxFont& font)
 156 {
 157     if ( !wxInfoBarBase::SetFont(font) )
 158         return false;
 159
 160     // check that we're not called before Create()
 161     if ( m_text )
 162         m_text->SetFont(font);
 163
 164     return true;
 165 }
 166
 167 void wxInfoBarGeneric::UpdateParent()
 168 {
 169     wxWindow * const parent = wxGetTopLevelParent(GetParent());
 170     parent->Layout();
 171 }
 172
 173 void wxInfoBarGeneric::ChangeParentBackground()
 174 {
 175     wxWindow * const parent = GetParent();
 176     m_origParentBgCol = parent->GetBackgroundColour();
 177
 178     wxSizer * const sizer = GetContainingSizer();
 179     if ( !sizer )
 180         return;
 181
 182     wxWindow *sibling = NULL;
 183     for ( wxSizerItemList::compatibility_iterator
 184             node = sizer->GetChildren().GetFirst();
 185             node;
 186             node = node->GetNext() )
 187     {
 188         if ( node->GetData()->GetWindow() == this )
 189         {
 190             // find the next window following us
 191             for ( node = node->GetNext();
 192                   node;
 193                   node = node->GetNext() )
 194             {
 195                 wxSizerItem * const item = node->GetData();
 196                 if ( item->IsWindow() )
 197                 {
 198                     sibling = item->GetWindow();
 199                     break;
 200                 }
 201             }
 202
 203             break;
 204         }
 205     }
 206
 207     if ( sibling )
 208         parent->SetOwnBackgroundColour(sibling->GetBackgroundColour());
 209 }
 210
 211 void wxInfoBarGeneric::RestoreParentBackground()
 212 {
 213     GetParent()->SetOwnBackgroundColour(m_origParentBgCol);
 214 }
 215
 216 void wxInfoBarGeneric::DoHide()
 217 {
 218     ChangeParentBackground();
 219     wxON_BLOCK_EXIT_THIS0( wxInfoBarGeneric::RestoreParentBackground );
 220
 221     HideWithEffect(m_hideEffect, m_effectDuration);
 222     UpdateParent();
 223 }
 224
 225 void wxInfoBarGeneric::DoShow()
 226 {
 227     // re-layout the parent first so that the window expands into an already
 228     // unoccupied by the other controls area: for this we need to change our
 229     // internal visibility flag to force Layout() to take us into account (an
 230     // alternative solution to this hack would be to temporarily set
 231     // wxRESERVE_SPACE_EVEN_IF_HIDDEN flag but it's not really batter)
 232
 233     // just change the internal flag indicating that the window is visible,
 234     // without really showing it
 235     wxWindowBase::Show();
 236
 237     // an extra hack: we want the temporarily uncovered area in which we're
 238     // going to expand to look like part of this sibling for a better effect so
 239     // temporarily change the background of our parent to the same colour
 240     ChangeParentBackground();
 241     wxON_BLOCK_EXIT_THIS0( wxInfoBarGeneric::RestoreParentBackground );
 242
 243     // adjust the parent layout to account for us
 244     UpdateParent();
 245
 246     // reset the flag back before really showing the window or it wouldn't be
 247     // shown at all because it would believe itself already visible
 248     wxWindowBase::Show(false);
 249
 250
 251     // finally do really show the window.
 252     ShowWithEffect(m_showEffect, m_effectDuration);
 253 }
 254
 255 void wxInfoBarGeneric::ShowMessage(const wxString& msg, int flags)
 256 {
 257     // first update the controls
 258     const int icon = flags & wxICON_MASK;
 259     if ( !icon || (icon == wxICON_NONE) )
 260     {
 261         m_icon->Hide();
 262     }
 263     else // do show an icon
 264     {
 265         m_icon->SetBitmap(wxArtProvider::GetBitmap(
 266                             wxArtProvider::GetMessageBoxIconId(flags),
 267                           wxART_MENU));
 268         m_icon->Show();
 269     }
 270
 271     // notice the use of EscapeMnemonics() to ensure that "&" come through
 272     // correctly
 273     m_text->SetLabel(wxControl::EscapeMnemonics(msg));
 274
 275
 276     // then show this entire window if not done yet
 277     if ( !IsShown() )
 278     {
 279         DoShow();
 280     }
 281     else // we're already shown
 282     {
 283         // just update the layout to correspond to the new message
 284         Layout();
 285     }
 286 }
 287
 288 void wxInfoBarGeneric::Dismiss()
 289 {
 290     DoHide();
 291 }
 292
 293 void wxInfoBarGeneric::AddButton(wxWindowID btnid, const wxString& label)
 294 {
 295     wxSizer * const sizer = GetSizer();
 296     wxCHECK_RET( sizer, "must be created first" );
 297
 298     // user-added buttons replace the standard close button so remove it if we
 299     // hadn't done it yet
 300     if ( sizer->Detach(m_button) )
 301     {
 302         m_button->Hide();
 303     }
 304
 305     wxButton * const button = new wxButton(this, btnid, label);
 306
 307 #ifdef __WXMAC__
 308     // smaller buttons look better in the (narrow) info bar under OS X
 309     button->SetWindowVariant(wxWINDOW_VARIANT_SMALL);
 310 #endif // __WXMAC__
 311
 312     sizer->Add(button, wxSizerFlags().Centre().DoubleBorder());
 313 }
 314
 315 void wxInfoBarGeneric::RemoveButton(wxWindowID btnid)
 316 {
 317     wxSizer * const sizer = GetSizer();
 318     wxCHECK_RET( sizer, "must be created first" );
 319
 320     // iterate over the sizer items in reverse order to find the last added
 321     // button with this id (ids of all buttons should be unique anyhow but if
 322     // they are repeated removing the last added one probably makes more sense)
 323     const wxSizerItemList& items = sizer->GetChildren();
 324     for ( wxSizerItemList::compatibility_iterator node = items.GetLast();
 325           node != items.GetFirst();
 326           node = node->GetPrevious() )
 327     {
 328         const wxSizerItem * const item = node->GetData();
 329
 330         // if we reached the spacer separating the buttons from the text
 331         // preceding them without finding our button, it must mean it's not
 332         // there at all
 333         if ( item->IsSpacer() )
 334         {
 335             wxFAIL_MSG( wxString::Format("button with id %d not found", btnid) );
 336             return;
 337         }
 338
 339         // check if we found our button
 340         if ( item->GetWindow()->GetId() == btnid )
 341         {
 342             delete item->GetWindow();
 343             break;
 344         }
 345     }
 346
 347     // check if there are any custom buttons left
 348     if ( sizer->GetChildren().GetLast()->GetData()->IsSpacer() )
 349     {
 350         // if the last item is the spacer, none are left so restore the
 351         // standard close button
 352         sizer->Add(m_button, wxSizerFlags().Centre().DoubleBorder());
 353         m_button->Show();
 354     }
 355 }
 356
 357 void wxInfoBarGeneric::OnButton(wxCommandEvent& WXUNUSED(event))
 358 {
 359     DoHide();
 360 }
 361
 362 #endif // wxUSE_INFOBAR