X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e4f1d811cc5b15a148ae7331c033d1749940cac0..27608f1130d577131674dc546b62ef11f75226d1:/interface/animate.h diff --git a/interface/animate.h b/interface/animate.h index 861625aec3..c2f4735b3c 100644 --- a/interface/animate.h +++ b/interface/animate.h @@ -37,9 +37,9 @@ enum wxAnimationType It is only available if @c wxUSE_ANIMATIONCTRL is set to 1 (the default). @beginStyleTable - @style{wxAC_DEFAULT_STYLE}: + @style{wxAC_DEFAULT_STYLE} The default style: wxBORDER_NONE. - @style{wxAC_NO_AUTORESIZE}: + @style{wxAC_NO_AUTORESIZE} By default, the control will adjust its size to exactly fit to the size of the animation when SetAnimation is called. If this style flag is given, the control will not change its size @@ -50,7 +50,7 @@ enum wxAnimationType @nativeimpl{wxgtk,wxmsw} - @appearance{animationctrl.png} + @see wxAnimation */ @@ -66,7 +66,7 @@ public: const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxAC_DEFAULT_STYLE, - const wxString& name = "animationctrl"); + const wxString& name = wxAnimationCtrlNameStr); /** Creates the control with the given @a anim animation. @@ -90,8 +90,8 @@ public: @param name Control name. - @returns @true if the control was successfully created or @false if - creation failed. + @return @true if the control was successfully created or @false if + creation failed. */ bool Create(wxWindow* parent, wxWindowID id, const wxAnimation& anim = wxNullAnimation, @@ -123,6 +123,13 @@ public: virtual bool LoadFile(const wxString& file, wxAnimationType animType = wxANIMATION_TYPE_ANY); + /** + Loads the animation from the given stream and calls SetAnimation(). + See wxAnimation::Load() for more info. + */ + virtual bool Load(wxInputStream& file, + wxAnimationType animType = wxANIMATION_TYPE_ANY); + /** Starts playing the animation. @@ -246,7 +253,7 @@ public: @li wxANIMATION_TYPE_ANI: load an ANI file; @li wxANIMATION_TYPE_ANY: tries to autodetect the filetype. - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. */ virtual bool Load(wxInputStream& stream, wxAnimationType type = wxANIMATION_TYPE_ANY); @@ -260,7 +267,7 @@ public: One of the wxAnimationType values; wxANIMATION_TYPE_ANY means that the function should try to autodetect the filetype. - @returns @true if the operation succeeded, @false otherwise. + @return @true if the operation succeeded, @false otherwise. */ virtual bool LoadFile(const wxString& name, wxAnimationType type = wxANIMATION_TYPE_ANY);