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