initial commit
Signed-off-by: Peter Siegmund <mars3142@noreply.mars3142.dev>
This commit is contained in:
248
libs/wxWidgets-3.3.1/include/wx/animate.h
Normal file
248
libs/wxWidgets-3.3.1/include/wx/animate.h
Normal file
@@ -0,0 +1,248 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: wx/animate.h
|
||||
// Purpose: wxAnimation and wxAnimationCtrl
|
||||
// Author: Julian Smart and Guillermo Rodriguez Garcia
|
||||
// Modified by: Francesco Montorsi
|
||||
// Created: 13/8/99
|
||||
// Copyright: (c) Julian Smart and Guillermo Rodriguez Garcia
|
||||
// Licence: wxWindows licence
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
#ifndef _WX_ANIMATE_H_
|
||||
#define _WX_ANIMATE_H_
|
||||
|
||||
#include "wx/defs.h"
|
||||
|
||||
#if wxUSE_ANIMATIONCTRL
|
||||
|
||||
#include "wx/animdecod.h"
|
||||
#include "wx/control.h"
|
||||
#include "wx/timer.h"
|
||||
#include "wx/bmpbndl.h"
|
||||
|
||||
#include <vector>
|
||||
|
||||
class WXDLLIMPEXP_FWD_CORE wxAnimation;
|
||||
class wxAnimationImpl;
|
||||
|
||||
extern WXDLLIMPEXP_DATA_CORE(wxAnimation) wxNullAnimation;
|
||||
extern WXDLLIMPEXP_DATA_CORE(const char) wxAnimationCtrlNameStr[];
|
||||
|
||||
WX_DECLARE_LIST_WITH_DECL(wxAnimationDecoder, wxAnimationDecoderList, class WXDLLIMPEXP_CORE);
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// wxAnimation
|
||||
// ----------------------------------------------------------------------------
|
||||
|
||||
class WXDLLIMPEXP_CORE wxAnimation : public wxObject
|
||||
{
|
||||
public:
|
||||
wxAnimation();
|
||||
explicit wxAnimation(const wxString &name, wxAnimationType type = wxANIMATION_TYPE_ANY);
|
||||
|
||||
#ifdef wxHAS_MEMBER_DEFAULT
|
||||
wxAnimation(const wxAnimation&) = default;
|
||||
wxAnimation& operator=(const wxAnimation&) = default;
|
||||
#endif
|
||||
|
||||
bool IsOk() const;
|
||||
bool IsCompatibleWith(wxClassInfo* ci) const;
|
||||
|
||||
int GetDelay(unsigned int frame) const;
|
||||
unsigned int GetFrameCount() const;
|
||||
wxImage GetFrame(unsigned int frame) const;
|
||||
wxSize GetSize() const;
|
||||
|
||||
bool LoadFile(const wxString& name, wxAnimationType type = wxANIMATION_TYPE_ANY);
|
||||
bool Load(wxInputStream& stream, wxAnimationType type = wxANIMATION_TYPE_ANY);
|
||||
|
||||
// Methods for managing the list of decoders
|
||||
static inline wxAnimationDecoderList& GetHandlers() { return sm_handlers; }
|
||||
static void AddHandler(wxAnimationDecoder *handler);
|
||||
static void InsertHandler(wxAnimationDecoder *handler);
|
||||
static const wxAnimationDecoder *FindHandler( wxAnimationType animType );
|
||||
|
||||
static void CleanUpHandlers();
|
||||
static void InitStandardHandlers();
|
||||
|
||||
protected:
|
||||
wxAnimationImpl* GetImpl() const;
|
||||
|
||||
private:
|
||||
static wxAnimationDecoderList sm_handlers;
|
||||
|
||||
// Ctor used by wxAnimationCtrl::CreateAnimation() only.
|
||||
explicit wxAnimation(wxAnimationImpl* impl);
|
||||
|
||||
// Give it permission to create objects of this class using specific impl
|
||||
// and access our GetImpl().
|
||||
friend class wxAnimationCtrlBase;
|
||||
|
||||
wxDECLARE_DYNAMIC_CLASS(wxAnimation);
|
||||
};
|
||||
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// wxAnimationBundle is one or more animations in different resolutions
|
||||
// ----------------------------------------------------------------------------
|
||||
|
||||
using wxAnimations = std::vector<wxAnimation>;
|
||||
|
||||
// This class is conceptually similar to wxBitmapBundle but much simpler.
|
||||
class WXDLLIMPEXP_CORE wxAnimationBundle
|
||||
{
|
||||
public:
|
||||
// Default ctor, call Add() later.
|
||||
wxAnimationBundle() = default;
|
||||
|
||||
// Implicit ctor for backwards compatibility: this allows to pass a single
|
||||
// wxAnimation to wxAnimationCtrl::SetAnimation(), just as before.
|
||||
wxAnimationBundle(const wxAnimation& anim)
|
||||
{
|
||||
// Allow the animation to be invalid here, also for compatibility.
|
||||
if ( anim.IsOk() )
|
||||
m_animations.push_back(anim);
|
||||
}
|
||||
|
||||
// Another implicit ctor for backwards compatibility: this one allows to
|
||||
// create an animation from the given file.
|
||||
wxAnimationBundle(const wxString& filename,
|
||||
wxAnimationType type = wxANIMATION_TYPE_ANY)
|
||||
{
|
||||
wxAnimation anim(filename, type);
|
||||
if ( anim.IsOk() )
|
||||
m_animations.push_back(anim);
|
||||
}
|
||||
|
||||
wxAnimationBundle(const wxAnimationBundle&) = default;
|
||||
wxAnimationBundle& operator=(const wxAnimationBundle&) = default;
|
||||
|
||||
~wxAnimationBundle() = default;
|
||||
|
||||
|
||||
// Add an animation in another, bigger, size.
|
||||
void Add(const wxAnimation& anim);
|
||||
|
||||
void Add(const wxString& filename,
|
||||
wxAnimationType type = wxANIMATION_TYPE_ANY)
|
||||
{
|
||||
Add(wxAnimation(filename, type));
|
||||
}
|
||||
|
||||
// Check if this bundle contains any animations (if it has any, they must
|
||||
// be valid).
|
||||
bool IsOk() const { return !m_animations.empty(); }
|
||||
|
||||
// Just provide access to all the elements.
|
||||
const wxAnimations& GetAll() const { return m_animations; }
|
||||
|
||||
private:
|
||||
wxAnimations m_animations;
|
||||
};
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// wxAnimationCtrlBase
|
||||
// ----------------------------------------------------------------------------
|
||||
|
||||
// do not autoresize to the animation's size when SetAnimation() is called
|
||||
#define wxAC_NO_AUTORESIZE (0x0010)
|
||||
|
||||
// default style does not include wxAC_NO_AUTORESIZE, that is, the control
|
||||
// auto-resizes by default to fit the new animation when SetAnimation() is called
|
||||
#define wxAC_DEFAULT_STYLE (wxBORDER_NONE)
|
||||
|
||||
class WXDLLIMPEXP_CORE wxAnimationCtrlBase : public wxControl
|
||||
{
|
||||
public:
|
||||
wxAnimationCtrlBase() = default;
|
||||
|
||||
// public API
|
||||
virtual bool LoadFile(const wxString& filename,
|
||||
wxAnimationType type = wxANIMATION_TYPE_ANY) = 0;
|
||||
virtual bool Load(wxInputStream& stream,
|
||||
wxAnimationType type = wxANIMATION_TYPE_ANY) = 0;
|
||||
|
||||
virtual void SetAnimation(const wxAnimationBundle& animations) = 0;
|
||||
wxAnimation GetAnimation() const { return m_animation; }
|
||||
|
||||
virtual bool Play() = 0;
|
||||
virtual void Stop() = 0;
|
||||
|
||||
virtual bool IsPlaying() const = 0;
|
||||
|
||||
virtual void SetInactiveBitmap(const wxBitmapBundle &bmp);
|
||||
|
||||
// always return the original bitmap set in this control
|
||||
wxBitmap GetInactiveBitmap() const
|
||||
{ return m_bmpStatic.GetBitmapFor(this); }
|
||||
|
||||
wxAnimation CreateAnimation() const
|
||||
{ return MakeAnimFromImpl(DoCreateAnimationImpl()); }
|
||||
|
||||
protected:
|
||||
virtual wxAnimationImpl* DoCreateAnimationImpl() const = 0;
|
||||
|
||||
// These methods allow derived classes access to private wxAnimation ctor
|
||||
// and wxAnimation::GetImpl(), respectively.
|
||||
static wxAnimation MakeAnimFromImpl(wxAnimationImpl* impl)
|
||||
{ return wxAnimation(impl); }
|
||||
|
||||
wxAnimationImpl* GetAnimImpl() const
|
||||
{ return m_animation.GetImpl(); }
|
||||
|
||||
// All animations that we have.
|
||||
wxAnimations m_animations;
|
||||
|
||||
// The animation being currently used, possibly invalid/empty.
|
||||
wxAnimation m_animation;
|
||||
|
||||
// the inactive bitmap as it was set by the user
|
||||
wxBitmapBundle m_bmpStatic;
|
||||
|
||||
// the inactive bitmap currently shown in the control
|
||||
// (may differ in the size from m_bmpStatic)
|
||||
wxBitmap m_bmpStaticReal;
|
||||
|
||||
// updates m_bmpStaticReal from m_bmpStatic if needed
|
||||
virtual void UpdateStaticImage();
|
||||
|
||||
// called by SetInactiveBitmap
|
||||
virtual void DisplayStaticImage() = 0;
|
||||
};
|
||||
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// include the platform-specific version of the wxAnimationCtrl class
|
||||
// ----------------------------------------------------------------------------
|
||||
|
||||
#if defined(__WXGTK__) && !defined(__WXUNIVERSAL__)
|
||||
#include "wx/gtk/animate.h"
|
||||
|
||||
#define wxHAS_NATIVE_ANIMATIONCTRL
|
||||
#else
|
||||
#include "wx/generic/animate.h"
|
||||
|
||||
class WXDLLIMPEXP_ADV wxAnimationCtrl : public wxGenericAnimationCtrl
|
||||
{
|
||||
public:
|
||||
wxAnimationCtrl()
|
||||
: wxGenericAnimationCtrl()
|
||||
{}
|
||||
wxAnimationCtrl(wxWindow *parent,
|
||||
wxWindowID id,
|
||||
const wxAnimation& anim = wxNullAnimation,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = wxAC_DEFAULT_STYLE,
|
||||
const wxString& name = wxASCII_STR(wxAnimationCtrlNameStr))
|
||||
: wxGenericAnimationCtrl(parent, id, anim, pos, size, style, name)
|
||||
{}
|
||||
|
||||
private:
|
||||
wxDECLARE_DYNAMIC_CLASS(wxAnimationCtrl);
|
||||
};
|
||||
#endif // defined(__WXGTK__)
|
||||
|
||||
#endif // wxUSE_ANIMATIONCTRL
|
||||
|
||||
#endif // _WX_ANIMATE_H_
|
||||
Reference in New Issue
Block a user