wxGISProgressor Class Reference

#include <progressor.h>

Inheritance diagram for wxGISProgressor:

Collaboration diagram for wxGISProgressor:

Public Member Functions
	wxGISProgressor (wxWindow *parent, wxWindowID id=wxID_ANY, int range=100, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxGA_HORIZONTAL|wxGA_SMOOTH, const wxString name=wxT("GISProgressor"))
virtual bool	ShowProgress (bool bShow)
	Show/hide progressor. More...
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	Play (void)
	Start undefined progressor state.
virtual void	Stop (void)
	Stop undefined progressor state.
virtual void	SetYield (bool bYield=false)
	SetYield Yields control to pending messages in the windowing system. More...
virtual void	OnSetValue (wxCommandEvent &event)
Public Member Functions inherited from IProgressor
virtual	~IProgressor (void)
	A destructor.

Protected Attributes
int	m_nValue
bool	m_bYield

Detailed Description

The progress bar (gauge) class.

Library:  wxGISFramework

Member Function Documentation

int wxGISProgressor::GetRange ( void  ) const

virtual

Set progressor range.

Returns

The current progressor range

Implements IProgressor.

Here is the caller graph for this function:

int wxGISProgressor::GetValue ( void  ) const

virtual

Get progressor position.

Returns

The current progressor position

Implements IProgressor.

void wxGISProgressor::SetRange ( int  range )

virtual

Set progressor range.

Parameters

range

The progressor value range

Implements IProgressor.

void wxGISProgressor::SetValue ( int  value )

virtual

Set progressor position.

Parameters

value

The progressor current value

Implements IProgressor.

Here is the call graph for this function:

void wxGISProgressor::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 wxGISProgressor::ShowProgress ( bool  bShow )

virtual

Show/hide progressor.

Parameters

bShow

The 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/progressor.h
• /home/bishop/work/projects/nextgismanager/src/framework/progressor.cpp