include/wx/generic/animate.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/animate.h
   3 // Purpose:     wxAnimation and wxAnimationCtrl
   4 // Author:      Julian Smart and Guillermo Rodriguez Garcia
   5 // Modified by: Francesco Montorsi
   6 // Created:     13/8/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Guillermo Rodriguez Garcia
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GENERIC_ANIMATEH__
  13 #define _WX_GENERIC_ANIMATEH__
  14
  15 #include "wx/bitmap.h"
  16
  17 // ----------------------------------------------------------------------------
  18 // wxAnimation
  19 // ----------------------------------------------------------------------------
  20
  21 WX_DECLARE_LIST_WITH_DECL(wxAnimationDecoder, wxAnimationDecoderList, class WXDLLIMPEXP_ADV);
  22
  23 class WXDLLIMPEXP_ADV wxAnimation : public wxAnimationBase
  24 {
  25 public:
  26     wxAnimation() {}
  27     wxAnimation(const wxString &name, wxAnimationType type = wxANIMATION_TYPE_ANY)
  28         { LoadFile(name, type); }
  29
  30     virtual bool IsOk() const
  31         { return m_refData != NULL; }
  32
  33     virtual unsigned int GetFrameCount() const;
  34     virtual int GetDelay(unsigned int i) const;
  35     virtual wxImage GetFrame(unsigned int i) const;
  36     virtual wxSize GetSize() const;
  37
  38     virtual bool LoadFile(const wxString& filename,
  39                           wxAnimationType type = wxANIMATION_TYPE_ANY);
  40     virtual bool Load(wxInputStream& stream,
  41                       wxAnimationType type = wxANIMATION_TYPE_ANY);
  42
  43     // extended interface used by the generic implementation of wxAnimationCtrl
  44     wxPoint GetFramePosition(unsigned int frame) const;
  45     wxSize GetFrameSize(unsigned int frame) const;
  46     wxAnimationDisposal GetDisposalMethod(unsigned int frame) const;
  47     wxColour GetTransparentColour(unsigned int frame) const;
  48     wxColour GetBackgroundColour() const;
  49
  50 protected:
  51     static wxAnimationDecoderList sm_handlers;
  52
  53 public:
  54     static inline wxAnimationDecoderList& GetHandlers() { return sm_handlers; }
  55     static void AddHandler(wxAnimationDecoder *handler);
  56     static void InsertHandler(wxAnimationDecoder *handler);
  57     static const wxAnimationDecoder *FindHandler( wxAnimationType animType );
  58
  59     static void CleanUpHandlers();
  60     static void InitStandardHandlers();
  61
  62     DECLARE_DYNAMIC_CLASS(wxAnimation)
  63 };
  64
  65
  66 // ----------------------------------------------------------------------------
  67 // wxAnimationCtrl
  68 // ----------------------------------------------------------------------------
  69
  70 class WXDLLIMPEXP_ADV wxAnimationCtrl: public wxAnimationCtrlBase
  71 {
  72 public:
  73     wxAnimationCtrl() { Init(); }
  74     wxAnimationCtrl(wxWindow *parent,
  75                     wxWindowID id,
  76                     const wxAnimation& anim = wxNullAnimation,
  77                     const wxPoint& pos = wxDefaultPosition,
  78                     const wxSize& size = wxDefaultSize,
  79                     long style = wxAC_DEFAULT_STYLE,
  80                     const wxString& name = wxAnimationCtrlNameStr)
  81     {
  82         Init();
  83
  84         Create(parent, id, anim, pos, size, style, name);
  85     }
  86
  87     void Init();
  88
  89     bool Create(wxWindow *parent, wxWindowID id,
  90                 const wxAnimation& anim = wxNullAnimation,
  91                 const wxPoint& pos = wxDefaultPosition,
  92                 const wxSize& size = wxDefaultSize,
  93                 long style = wxAC_DEFAULT_STYLE,
  94                 const wxString& name = wxAnimationCtrlNameStr);
  95
  96     ~wxAnimationCtrl();
  97
  98 public:
  99     virtual bool LoadFile(const wxString& filename, wxAnimationType type = wxANIMATION_TYPE_ANY);
 100
 101     virtual void Stop();
 102     virtual bool Play()
 103         { return Play(true /* looped */); }
 104     virtual bool IsPlaying() const
 105         { return m_isPlaying; }
 106
 107     void SetAnimation(const wxAnimation &animation);
 108     wxAnimation GetAnimation() const
 109         { return m_animation; }
 110
 111     virtual void SetInactiveBitmap(const wxBitmap &bmp);
 112
 113     // override base class method
 114     virtual bool SetBackgroundColour(const wxColour& col);
 115
 116 public:     // event handlers
 117
 118     void OnPaint(wxPaintEvent& event);
 119     void OnTimer(wxTimerEvent& event);
 120     void OnSize(wxSizeEvent& event);
 121
 122 public:     // extended API specific to this implementation of wxAnimateCtrl
 123
 124     // Specify whether the animation's background colour is to be shown (the default),
 125     // or whether the window background should show through
 126     void SetUseWindowBackgroundColour(bool useWinBackground = true)
 127         { m_useWinBackgroundColour = useWinBackground; }
 128     bool IsUsingWindowBackgroundColour() const
 129         { return m_useWinBackgroundColour; }
 130
 131     // This overload of Play() lets you specify if the animation must loop or not
 132     bool Play(bool looped);
 133
 134     // Draw the current frame of the animation into given DC.
 135     // This is fast as current frame is always cached.
 136     void DrawCurrentFrame(wxDC& dc);
 137
 138     // Returns a wxBitmap with the current frame drawn in it
 139     wxBitmap& GetBackingStore()
 140         { return m_backingStore; }
 141
 142 protected:      // internal utilities
 143
 144     // resize this control to fit m_animation
 145     void FitToAnimation();
 146
 147     // Draw the background; use this when e.g. previous frame had wxANIM_TOBACKGROUND disposal.
 148     void DisposeToBackground();
 149     void DisposeToBackground(wxDC& dc);
 150     void DisposeToBackground(wxDC& dc, const wxPoint &pos, const wxSize &sz);
 151
 152     void IncrementalUpdateBackingStore();
 153     bool RebuildBackingStoreUpToFrame(unsigned int);
 154     void DrawFrame(wxDC &dc, unsigned int);
 155
 156     virtual void DisplayStaticImage();
 157     virtual wxSize DoGetBestSize() const;
 158
 159 protected:
 160     unsigned int  m_currentFrame;     // Current frame
 161     bool          m_looped;           // Looped, or not
 162     wxTimer       m_timer;            // The timer
 163     wxAnimation   m_animation;        // The animation
 164
 165     bool          m_isPlaying;        // Is the animation playing?
 166     bool          m_useWinBackgroundColour; // Use animation bg colour or window bg colour?
 167
 168     wxBitmap      m_backingStore;     // The frames are drawn here and then blitted
 169                                       // on the screen
 170
 171 private:
 172     typedef wxAnimationCtrlBase base_type;
 173     DECLARE_DYNAMIC_CLASS(wxAnimationCtrl)
 174     DECLARE_EVENT_TABLE()
 175 };
 176
 177 #endif // _WX_GENERIC_ANIMATEH__