include/wx/infobar.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/infobar.h
   3 // Purpose:     declaration of wxInfoBarBase defining common API of wxInfoBar
   4 // Author:      Vadim Zeitlin
   5 // Created:     2009-07-28
   6 // RCS-ID:      $Id: wxhead.h,v 1.11 2009-06-29 10:23:04 zeitlin Exp $
   7 // Copyright:   (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_INFOBAR_H_
  12 #define _WX_INFOBAR_H_
  13
  14 #include "wx/defs.h"
  15
  16 #if wxUSE_INFOBAR
  17
  18 #include "wx/window.h"
  19
  20 // ----------------------------------------------------------------------------
  21 // wxInfoBar shows non-critical but important information to the user
  22 // ----------------------------------------------------------------------------
  23
  24 class WXDLLIMPEXP_ADV wxInfoBarBase : public wxWindow
  25 {
  26 public:
  27     // real ctors are provided by the derived classes, just notice that unlike
  28     // most of the other windows, info bar is created hidden and must be
  29     // explicitly shown when it is needed (this is done because it is supposed
  30     // to be shown only intermittently and hiding it after creating it from the
  31     // user code would result in flicker)
  32     wxInfoBarBase() { }
  33
  34
  35     // show the info bar with the given message and optionally an icon
  36     virtual void ShowMessage(const wxString& msg, int flags = wxICON_NONE) = 0;
  37
  38     // add an extra button to the bar, near the message
  39     virtual void AddButton(wxWindowID btnid,
  40                            const wxString& label = wxString()) = 0;
  41
  42 private:
  43     wxDECLARE_NO_COPY_CLASS(wxInfoBarBase);
  44 };
  45
  46 // include platform-dependent implementation
  47 //
  48 // TODO-GTK: implement a native version using GtkInfoBar (GTK+ 2.18+)
  49 #include "wx/generic/infobar.h"
  50
  51 #endif // wxUSE_INFOBAR
  52
  53 #endif // _WX_INFOBAR_H_