include/wx/anidecod.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/anidecod.h
   3 // Purpose:     wxANIDecoder, ANI reader for wxImage and wxAnimation
   4 // Author:      Francesco Montorsi
   5 // CVS-ID:      $Id$
   6 // Copyright:   (c) 2006 Francesco Montorsi
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_ANIDECOD_H
  11 #define _WX_ANIDECOD_H
  12
  13 #include "wx/defs.h"
  14
  15 #if wxUSE_STREAMS && (wxUSE_ICO_CUR || wxUSE_GIF)
  16
  17 #include "wx/stream.h"
  18 #include "wx/image.h"
  19 #include "wx/animdecod.h"
  20 #include "wx/dynarray.h"
  21
  22
  23 class /*WXDLLIMPEXP_CORE*/ wxANIFrameInfo;      // private implementation detail
  24
  25 WX_DECLARE_EXPORTED_OBJARRAY(wxANIFrameInfo, wxANIFrameInfoArray);
  26 WX_DECLARE_EXPORTED_OBJARRAY(wxImage, wxImageArray);
  27
  28 // --------------------------------------------------------------------------
  29 // wxANIDecoder class
  30 // --------------------------------------------------------------------------
  31
  32 class WXDLLIMPEXP_CORE wxANIDecoder : public wxAnimationDecoder
  33 {
  34 public:
  35     // constructor, destructor, etc.
  36     wxANIDecoder();
  37     ~wxANIDecoder();
  38
  39
  40     virtual wxSize GetFrameSize(unsigned int frame) const;
  41     virtual wxPoint GetFramePosition(unsigned int frame) const;
  42     virtual wxAnimationDisposal GetDisposalMethod(unsigned int frame) const;
  43     virtual long GetDelay(unsigned int frame) const;
  44     virtual wxColour GetTransparentColour(unsigned int frame) const;
  45
  46     // implementation of wxAnimationDecoder's pure virtuals
  47
  48     virtual bool Load( wxInputStream& stream );
  49
  50     bool ConvertToImage(unsigned int frame, wxImage *image) const;
  51
  52     wxAnimationDecoder *Clone() const
  53         { return new wxANIDecoder; }
  54     wxAnimationType GetType() const
  55         { return wxANIMATION_TYPE_ANI; }
  56
  57 private:
  58     // wxAnimationDecoder pure virtual:
  59     virtual bool DoCanRead( wxInputStream& stream ) const;
  60             // modifies current stream position (see wxAnimationDecoder::CanRead)
  61
  62     // frames stored as wxImage(s): ANI files are meant to be used mostly for animated
  63     // cursors and thus they do not use any optimization to encode differences between
  64     // two frames: they are just a list of images to display sequentially.
  65     wxImageArray m_images;
  66
  67     // the info about each image stored in m_images.
  68     // NB: m_info.GetCount() may differ from m_images.GetCount()!
  69     wxANIFrameInfoArray m_info;
  70
  71     // this is the wxCURHandler used to load the ICON chunk of the ANI files
  72     static wxCURHandler sm_handler;
  73
  74
  75     wxDECLARE_NO_COPY_CLASS(wxANIDecoder);
  76 };
  77
  78
  79 #endif  // wxUSE_STREAMS && (wxUSE_ICO_CUR || wxUSE_GIF)
  80
  81 #endif  // _WX_ANIDECOD_H