Version: 0.6.0

#include <animation.h>

Inheritance diagram for wxGISAnimation:
Collaboration diagram for wxGISAnimation:

Public Member Functions

 wxGISAnimation (wxWindow *parent, wxWindowID id=wxID_ANY, const wxBitmap &bitmap=wxNullBitmap, const int bitmap_size=16, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxNO_BORDER, const wxString name=wxT("Ani"))
 
void OnPaint (wxPaintEvent &event)
 
void OnEraseBackground (wxEraseEvent &event)
 
void OnTimer (wxTimerEvent &event)
 
virtual bool ShowProgress (bool bShow)
 Show/hide progressor. More...
 
virtual void Play (void)
 Start undefined progressor state.
 
virtual void Stop (void)
 Stop undefined progressor state.
 
virtual void SetRange (int range)
 Set progressor range. More...
 
virtual int GetRange () const
 Set progressor range. More...
 
virtual void SetValue (int value)
 Set progressor position. More...
 
virtual int GetValue () const
 Get progressor position. More...
 
virtual void SetYield (bool bYield=false)
 SetYield Yields control to pending messages in the windowing system. More...
 
virtual void OnChangeState (wxCommandEvent &event)
 
- Public Member Functions inherited from IProgressor
virtual ~IProgressor (void)
 A destructor.
 

Protected Attributes

wxImageList m_ImageList
 
int m_nImgPos
 
wxTimer m_timer
 
bool m_bYield
 

Detailed Description

The rotating globe animation class. The bitmap for animation may be any.

Library:  wxGISFramework

Member Function Documentation

virtual int wxGISAnimation::GetRange ( void  ) const
inlinevirtual

Set progressor range.

Returns
The current progressor range

Implements IProgressor.

virtual int wxGISAnimation::GetValue ( void  ) const
inlinevirtual

Get progressor position.

Returns
The current progressor position

Implements IProgressor.

virtual void wxGISAnimation::SetRange ( int  range)
inlinevirtual

Set progressor range.

Parameters
rangeThe progressor value range

Implements IProgressor.

virtual void wxGISAnimation::SetValue ( int  value)
inlinevirtual

Set progressor position.

Parameters
valueThe progressor current value

Implements IProgressor.

void wxGISAnimation::SetYield ( bool  bYield = false)
virtual

SetYield Yields control to pending messages in the windowing system.

This can be useful, for example, when a time-consuming process writes to a text window. Without an occasional yield, the text window will not be updated properly, and other processes will not respond.

Implements IProgressor.

bool wxGISAnimation::ShowProgress ( bool  bShow)
virtual

Show/hide progressor.

Parameters
bShowThe indicator to show (true) or hide (false) progressor
Returns
The success of function execution

Implements IProgressor.


The documentation for this class was generated from the following files:
  • /home/bishop/work/projects/nextgismanager/include/wxgis/framework/animation.h
  • /home/bishop/work/projects/nextgismanager/src/framework/animation.cpp