wxPython/contrib/animate/gtk/animate.py

   1 # This file was created automatically by SWIG 1.3.29.
   2 # Don't modify this file, modify the SWIG interface instead.
   3
   4 """
   5 Simple animation player classes, including `GIFAnimationCtrl` for displaying
   6 animated GIF files
   7
   8 """
   9
  10 import _animate
  11 import new
  12 new_instancemethod = new.instancemethod
  13 def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
  14     if (name == "thisown"): return self.this.own(value)
  15     if (name == "this"):
  16         if type(value).__name__ == 'PySwigObject':
  17             self.__dict__[name] = value
  18             return
  19     method = class_type.__swig_setmethods__.get(name,None)
  20     if method: return method(self,value)
  21     if (not static) or hasattr(self,name):
  22         self.__dict__[name] = value
  23     else:
  24         raise AttributeError("You cannot add attributes to %s" % self)
  25
  26 def _swig_setattr(self,class_type,name,value):
  27     return _swig_setattr_nondynamic(self,class_type,name,value,0)
  28
  29 def _swig_getattr(self,class_type,name):
  30     if (name == "thisown"): return self.this.own()
  31     method = class_type.__swig_getmethods__.get(name,None)
  32     if method: return method(self)
  33     raise AttributeError,name
  34
  35 def _swig_repr(self):
  36     try: strthis = "proxy of " + self.this.__repr__()
  37     except: strthis = ""
  38     return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
  39
  40 import types
  41 try:
  42     _object = types.ObjectType
  43     _newclass = 1
  44 except AttributeError:
  45     class _object : pass
  46     _newclass = 0
  47 del types
  48
  49
  50 def _swig_setattr_nondynamic_method(set):
  51     def set_attr(self,name,value):
  52         if (name == "thisown"): return self.this.own(value)
  53         if hasattr(self,name) or (name == "this"):
  54             set(self,name,value)
  55         else:
  56             raise AttributeError("You cannot add attributes to %s" % self)
  57     return set_attr
  58
  59
  60 import _core
  61 import wx
  62 __docfilter__ = wx._core.__DocFilter(globals())
  63 ANIM_UNSPECIFIED = _animate.ANIM_UNSPECIFIED
  64 ANIM_DONOTREMOVE = _animate.ANIM_DONOTREMOVE
  65 ANIM_TOBACKGROUND = _animate.ANIM_TOBACKGROUND
  66 ANIM_TOPREVIOUS = _animate.ANIM_TOPREVIOUS
  67 class AnimationPlayer(_core.Object):
  68     """Proxy of C++ AnimationPlayer class"""
  69     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
  70     __repr__ = _swig_repr
  71     def __init__(self, *args, **kwargs):
  72         """__init__(self, AnimationBase animation=None, bool destroyAnimation=False) -> AnimationPlayer"""
  73         _animate.AnimationPlayer_swiginit(self,_animate.new_AnimationPlayer(*args, **kwargs))
  74     __swig_destroy__ = _animate.delete_AnimationPlayer
  75     __del__ = lambda self : None;
  76     def SetAnimation(*args, **kwargs):
  77         """SetAnimation(self, AnimationBase animation, bool destroyAnimation=False)"""
  78         return _animate.AnimationPlayer_SetAnimation(*args, **kwargs)
  79
  80     def GetAnimation(*args, **kwargs):
  81         """GetAnimation(self) -> AnimationBase"""
  82         return _animate.AnimationPlayer_GetAnimation(*args, **kwargs)
  83
  84     def SetDestroyAnimation(*args, **kwargs):
  85         """SetDestroyAnimation(self, bool destroyAnimation)"""
  86         return _animate.AnimationPlayer_SetDestroyAnimation(*args, **kwargs)
  87
  88     def GetDestroyAnimation(*args, **kwargs):
  89         """GetDestroyAnimation(self) -> bool"""
  90         return _animate.AnimationPlayer_GetDestroyAnimation(*args, **kwargs)
  91
  92     def SetCurrentFrame(*args, **kwargs):
  93         """SetCurrentFrame(self, int currentFrame)"""
  94         return _animate.AnimationPlayer_SetCurrentFrame(*args, **kwargs)
  95
  96     def GetCurrentFrame(*args, **kwargs):
  97         """GetCurrentFrame(self) -> int"""
  98         return _animate.AnimationPlayer_GetCurrentFrame(*args, **kwargs)
  99
 100     def SetWindow(*args, **kwargs):
 101         """SetWindow(self, Window window)"""
 102         return _animate.AnimationPlayer_SetWindow(*args, **kwargs)
 103
 104     def GetWindow(*args, **kwargs):
 105         """GetWindow(self) -> Window"""
 106         return _animate.AnimationPlayer_GetWindow(*args, **kwargs)
 107
 108     def SetPosition(*args, **kwargs):
 109         """SetPosition(self, Point pos)"""
 110         return _animate.AnimationPlayer_SetPosition(*args, **kwargs)
 111
 112     def GetPosition(*args, **kwargs):
 113         """GetPosition(self) -> Point"""
 114         return _animate.AnimationPlayer_GetPosition(*args, **kwargs)
 115
 116     def SetLooped(*args, **kwargs):
 117         """SetLooped(self, bool looped)"""
 118         return _animate.AnimationPlayer_SetLooped(*args, **kwargs)
 119
 120     def GetLooped(*args, **kwargs):
 121         """GetLooped(self) -> bool"""
 122         return _animate.AnimationPlayer_GetLooped(*args, **kwargs)
 123
 124     def HasAnimation(*args, **kwargs):
 125         """HasAnimation(self) -> bool"""
 126         return _animate.AnimationPlayer_HasAnimation(*args, **kwargs)
 127
 128     def IsPlaying(*args, **kwargs):
 129         """IsPlaying(self) -> bool"""
 130         return _animate.AnimationPlayer_IsPlaying(*args, **kwargs)
 131
 132     def UseBackgroundColour(*args, **kwargs):
 133         """UseBackgroundColour(self, bool useBackground)"""
 134         return _animate.AnimationPlayer_UseBackgroundColour(*args, **kwargs)
 135
 136     def UsingBackgroundColour(*args, **kwargs):
 137         """UsingBackgroundColour(self) -> bool"""
 138         return _animate.AnimationPlayer_UsingBackgroundColour(*args, **kwargs)
 139
 140     def SetCustomBackgroundColour(*args, **kwargs):
 141         """SetCustomBackgroundColour(self, Colour col, bool useCustomBackgroundColour=True)"""
 142         return _animate.AnimationPlayer_SetCustomBackgroundColour(*args, **kwargs)
 143
 144     def UsingCustomBackgroundColour(*args, **kwargs):
 145         """UsingCustomBackgroundColour(self) -> bool"""
 146         return _animate.AnimationPlayer_UsingCustomBackgroundColour(*args, **kwargs)
 147
 148     def GetCustomBackgroundColour(*args, **kwargs):
 149         """GetCustomBackgroundColour(self) -> Colour"""
 150         return _animate.AnimationPlayer_GetCustomBackgroundColour(*args, **kwargs)
 151
 152     def UseParentBackground(*args, **kwargs):
 153         """UseParentBackground(self, bool useParent)"""
 154         return _animate.AnimationPlayer_UseParentBackground(*args, **kwargs)
 155
 156     def UsingParentBackground(*args, **kwargs):
 157         """UsingParentBackground(self) -> bool"""
 158         return _animate.AnimationPlayer_UsingParentBackground(*args, **kwargs)
 159
 160     def Play(*args, **kwargs):
 161         """Play(self, Window window, Point pos=wxPoint(0, 0), bool looped=True) -> bool"""
 162         return _animate.AnimationPlayer_Play(*args, **kwargs)
 163
 164     def Build(*args, **kwargs):
 165         """Build(self) -> bool"""
 166         return _animate.AnimationPlayer_Build(*args, **kwargs)
 167
 168     def Stop(*args, **kwargs):
 169         """Stop(self)"""
 170         return _animate.AnimationPlayer_Stop(*args, **kwargs)
 171
 172     def Draw(*args, **kwargs):
 173         """Draw(self, DC dc)"""
 174         return _animate.AnimationPlayer_Draw(*args, **kwargs)
 175
 176     def GetFrameCount(*args, **kwargs):
 177         """GetFrameCount(self) -> int"""
 178         return _animate.AnimationPlayer_GetFrameCount(*args, **kwargs)
 179
 180     def GetFrame(*args, **kwargs):
 181         """GetFrame(self, int i) -> Image"""
 182         return _animate.AnimationPlayer_GetFrame(*args, **kwargs)
 183
 184     def GetDisposalMethod(*args, **kwargs):
 185         """GetDisposalMethod(self, int i) -> int"""
 186         return _animate.AnimationPlayer_GetDisposalMethod(*args, **kwargs)
 187
 188     def GetFrameRect(*args, **kwargs):
 189         """GetFrameRect(self, int i) -> Rect"""
 190         return _animate.AnimationPlayer_GetFrameRect(*args, **kwargs)
 191
 192     def GetDelay(*args, **kwargs):
 193         """GetDelay(self, int i) -> int"""
 194         return _animate.AnimationPlayer_GetDelay(*args, **kwargs)
 195
 196     def GetLogicalScreenSize(*args, **kwargs):
 197         """GetLogicalScreenSize(self) -> Size"""
 198         return _animate.AnimationPlayer_GetLogicalScreenSize(*args, **kwargs)
 199
 200     def GetBackgroundColour(*args, **kwargs):
 201         """GetBackgroundColour(self, Colour col) -> bool"""
 202         return _animate.AnimationPlayer_GetBackgroundColour(*args, **kwargs)
 203
 204     def GetTransparentColour(*args, **kwargs):
 205         """GetTransparentColour(self, Colour col) -> bool"""
 206         return _animate.AnimationPlayer_GetTransparentColour(*args, **kwargs)
 207
 208     def PlayFrame(*args, **kwargs):
 209         """PlayFrame(self, int frame, Window window, Point pos) -> bool"""
 210         return _animate.AnimationPlayer_PlayFrame(*args, **kwargs)
 211
 212     def PlayNextFrame(*args, **kwargs):
 213         """PlayNextFrame(self) -> bool"""
 214         return _animate.AnimationPlayer_PlayNextFrame(*args, **kwargs)
 215
 216     def DrawFrame(*args, **kwargs):
 217         """DrawFrame(self, int frame, DC dc, Point pos)"""
 218         return _animate.AnimationPlayer_DrawFrame(*args, **kwargs)
 219
 220     def DrawBackground(*args, **kwargs):
 221         """DrawBackground(self, DC dc, Point pos, Colour colour)"""
 222         return _animate.AnimationPlayer_DrawBackground(*args, **kwargs)
 223
 224     def ClearCache(*args, **kwargs):
 225         """ClearCache(self)"""
 226         return _animate.AnimationPlayer_ClearCache(*args, **kwargs)
 227
 228     def SaveBackground(*args, **kwargs):
 229         """SaveBackground(self, Rect rect)"""
 230         return _animate.AnimationPlayer_SaveBackground(*args, **kwargs)
 231
 232     def GetBackingStore(*args, **kwargs):
 233         """GetBackingStore(self) -> Bitmap"""
 234         return _animate.AnimationPlayer_GetBackingStore(*args, **kwargs)
 235
 236     Animation = property(GetAnimation,SetAnimation,doc="See `GetAnimation` and `SetAnimation`")
 237     BackingStore = property(GetBackingStore,doc="See `GetBackingStore`")
 238     CurrentFrame = property(GetCurrentFrame,SetCurrentFrame,doc="See `GetCurrentFrame` and `SetCurrentFrame`")
 239     CustomBackgroundColour = property(GetCustomBackgroundColour,SetCustomBackgroundColour,doc="See `GetCustomBackgroundColour` and `SetCustomBackgroundColour`")
 240     DestroyAnimation = property(GetDestroyAnimation,SetDestroyAnimation,doc="See `GetDestroyAnimation` and `SetDestroyAnimation`")
 241     DisposalMethod = property(GetDisposalMethod,doc="See `GetDisposalMethod`")
 242     FrameCount = property(GetFrameCount,doc="See `GetFrameCount`")
 243     LogicalScreenSize = property(GetLogicalScreenSize,doc="See `GetLogicalScreenSize`")
 244     Looped = property(GetLooped,SetLooped,doc="See `GetLooped` and `SetLooped`")
 245     Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
 246     Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
 247 _animate.AnimationPlayer_swigregister(AnimationPlayer)
 248 cvar = _animate.cvar
 249 AnimationControlNameStr = cvar.AnimationControlNameStr
 250
 251 class AnimationBase(_core.Object):
 252     """Proxy of C++ AnimationBase class"""
 253     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 254     def __init__(self): raise AttributeError, "No constructor defined"
 255     __repr__ = _swig_repr
 256     __swig_destroy__ = _animate.delete_AnimationBase
 257     __del__ = lambda self : None;
 258     def GetFrameCount(*args, **kwargs):
 259         """GetFrameCount(self) -> int"""
 260         return _animate.AnimationBase_GetFrameCount(*args, **kwargs)
 261
 262     def GetFrame(*args, **kwargs):
 263         """GetFrame(self, int i) -> Image"""
 264         return _animate.AnimationBase_GetFrame(*args, **kwargs)
 265
 266     def GetDisposalMethod(*args, **kwargs):
 267         """GetDisposalMethod(self, int i) -> int"""
 268         return _animate.AnimationBase_GetDisposalMethod(*args, **kwargs)
 269
 270     def GetFrameRect(*args, **kwargs):
 271         """GetFrameRect(self, int i) -> Rect"""
 272         return _animate.AnimationBase_GetFrameRect(*args, **kwargs)
 273
 274     def GetDelay(*args, **kwargs):
 275         """GetDelay(self, int i) -> int"""
 276         return _animate.AnimationBase_GetDelay(*args, **kwargs)
 277
 278     def GetLogicalScreenSize(*args, **kwargs):
 279         """GetLogicalScreenSize(self) -> Size"""
 280         return _animate.AnimationBase_GetLogicalScreenSize(*args, **kwargs)
 281
 282     def GetBackgroundColour(*args, **kwargs):
 283         """GetBackgroundColour(self, Colour col) -> bool"""
 284         return _animate.AnimationBase_GetBackgroundColour(*args, **kwargs)
 285
 286     def GetTransparentColour(*args, **kwargs):
 287         """GetTransparentColour(self, Colour col) -> bool"""
 288         return _animate.AnimationBase_GetTransparentColour(*args, **kwargs)
 289
 290     def IsValid(*args, **kwargs):
 291         """IsValid(self) -> bool"""
 292         return _animate.AnimationBase_IsValid(*args, **kwargs)
 293
 294     def LoadFile(*args, **kwargs):
 295         """LoadFile(self, String filename) -> bool"""
 296         return _animate.AnimationBase_LoadFile(*args, **kwargs)
 297
 298     DisposalMethod = property(GetDisposalMethod,doc="See `GetDisposalMethod`")
 299     FrameCount = property(GetFrameCount,doc="See `GetFrameCount`")
 300     LogicalScreenSize = property(GetLogicalScreenSize,doc="See `GetLogicalScreenSize`")
 301 _animate.AnimationBase_swigregister(AnimationBase)
 302
 303 class GIFAnimation(AnimationBase):
 304     """Proxy of C++ GIFAnimation class"""
 305     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 306     __repr__ = _swig_repr
 307     def __init__(self, *args, **kwargs):
 308         """__init__(self) -> GIFAnimation"""
 309         _animate.GIFAnimation_swiginit(self,_animate.new_GIFAnimation(*args, **kwargs))
 310     __swig_destroy__ = _animate.delete_GIFAnimation
 311     __del__ = lambda self : None;
 312 _animate.GIFAnimation_swigregister(GIFAnimation)
 313
 314 AN_FIT_ANIMATION = _animate.AN_FIT_ANIMATION
 315 class GIFAnimationCtrl(_core.Control):
 316     """Proxy of C++ GIFAnimationCtrl class"""
 317     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 318     __repr__ = _swig_repr
 319     def __init__(self, *args, **kwargs):
 320         """
 321         __init__(self, Window parent, int id=-1, String filename=EmptyString,
 322             Point pos=DefaultPosition, Size size=DefaultSize,
 323             long style=wxAN_FIT_ANIMATION|wxNO_BORDER,
 324             String name=AnimationControlNameStr) -> GIFAnimationCtrl
 325         """
 326         _animate.GIFAnimationCtrl_swiginit(self,_animate.new_GIFAnimationCtrl(*args, **kwargs))
 327         self._setOORInfo(self)
 328
 329     def Create(*args, **kwargs):
 330         """
 331         Create(self, Window parent, int id=-1, String filename=EmptyString,
 332             Point pos=DefaultPosition, Size size=DefaultSize,
 333             long style=wxAN_FIT_ANIMATION|wxNO_BORDER,
 334             String name=AnimationControlNameStr) -> bool
 335         """
 336         return _animate.GIFAnimationCtrl_Create(*args, **kwargs)
 337
 338     def LoadFile(*args, **kwargs):
 339         """LoadFile(self, String filename=EmptyString) -> bool"""
 340         return _animate.GIFAnimationCtrl_LoadFile(*args, **kwargs)
 341
 342     def Play(*args, **kwargs):
 343         """Play(self, bool looped=True) -> bool"""
 344         return _animate.GIFAnimationCtrl_Play(*args, **kwargs)
 345
 346     def Stop(*args, **kwargs):
 347         """Stop(self)"""
 348         return _animate.GIFAnimationCtrl_Stop(*args, **kwargs)
 349
 350     def FitToAnimation(*args, **kwargs):
 351         """FitToAnimation(self)"""
 352         return _animate.GIFAnimationCtrl_FitToAnimation(*args, **kwargs)
 353
 354     def IsPlaying(*args, **kwargs):
 355         """IsPlaying(self) -> bool"""
 356         return _animate.GIFAnimationCtrl_IsPlaying(*args, **kwargs)
 357
 358     def GetPlayer(*args, **kwargs):
 359         """GetPlayer(self) -> AnimationPlayer"""
 360         return _animate.GIFAnimationCtrl_GetPlayer(*args, **kwargs)
 361
 362     def GetAnimation(*args, **kwargs):
 363         """GetAnimation(self) -> AnimationBase"""
 364         return _animate.GIFAnimationCtrl_GetAnimation(*args, **kwargs)
 365
 366     def GetFilename(*args, **kwargs):
 367         """GetFilename(self) -> String"""
 368         return _animate.GIFAnimationCtrl_GetFilename(*args, **kwargs)
 369
 370     def SetFilename(*args, **kwargs):
 371         """SetFilename(self, String filename)"""
 372         return _animate.GIFAnimationCtrl_SetFilename(*args, **kwargs)
 373
 374     Animation = property(GetAnimation,doc="See `GetAnimation`")
 375     Filename = property(GetFilename,SetFilename,doc="See `GetFilename` and `SetFilename`")
 376     Player = property(GetPlayer,doc="See `GetPlayer`")
 377 _animate.GIFAnimationCtrl_swigregister(GIFAnimationCtrl)
 378
 379 def PreGIFAnimationCtrl(*args, **kwargs):
 380     """PreGIFAnimationCtrl() -> GIFAnimationCtrl"""
 381     val = _animate.new_PreGIFAnimationCtrl(*args, **kwargs)
 382     return val
 383
 384
 385