#include <core.h>

Inheritance diagram for IProgressor:

Public Member Functions
virtual	~IProgressor (void)
	A destructor.

virtual bool	ShowProgress (bool bShow)=0
	Show/hide progressor. More...

virtual void	SetRange (int range)=0
	Set progressor range. More...

virtual int	GetRange (void) const =0
	Set progressor range. More...

virtual void	SetValue (int value)=0
	Set progressor position. More...

virtual int	GetValue (void) const =0
	Get progressor position. More...

virtual void	Play (void)=0
	Start undefined progressor state.

virtual void	Stop (void)=0
	Stop undefined progressor state.

virtual void	SetYield (bool bYield=false)=0
	SetYield Yields control to pending messages in the windowing system. More...

Detailed Description

A progressor interface class. This is base class for progressors.

Library: wxGISCore

Member Function Documentation

int IProgressor::GetRange ( void ) const

pure virtual

Set progressor range.

Returns: The current progressor range

Implemented in wxGISProgressDlg, wxGISAnimation, and wxGISProgressor.

Here is the caller graph for this function:

int IProgressor::GetValue ( void ) const

pure virtual

Get progressor position.

Returns: The current progressor position

Implemented in wxGISProgressDlg, wxGISAnimation, and wxGISProgressor.

Here is the caller graph for this function:

void IProgressor::SetRange ( int range )

pure virtual

Set progressor range.

Parameters

range The progressor value range

Implemented in wxGISProgressDlg, wxGISAnimation, wxGPTaskExecutor, and wxGISProgressor.

Here is the caller graph for this function:

void IProgressor::SetValue ( int value )

pure virtual

Set progressor position.

Parameters

value The progressor current value

Implemented in wxGISProgressDlg, wxGISAnimation, wxGISProgressor, and wxGPTaskExecutor.

Here is the caller graph for this function:

void IProgressor::SetYield ( bool bYield = false )

pure 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.

Implemented in wxGISProgressDlg, wxGISAnimation, wxGPTaskExecutor, and wxGISProgressor.

Here is the caller graph for this function:

bool IProgressor::ShowProgress ( bool bShow )

pure virtual

Show/hide progressor.

Parameters

bShow The indicator to show (true) or hide (false) progressor

Returns: The success of function execution

Implemented in wxGISProgressDlg, wxGISAnimation, and wxGISProgressor.

The documentation for this class was generated from the following file:

/home/bishop/work/projects/nextgismanager/include/wxgis/core/core.h

Public Member Functions

Detailed Description

Member Function Documentation