IProgressBarControlData Class Reference

#include <IProgressBarControlData.h>

Inheritance diagram for IProgressBarControlData:

Public Member Functions
virtual bool16	SetRange (int16 min, int16 max)=0
virtual int16	GetMin () const =0
virtual int16	GetMax () const =0
virtual void	SetValue (int16 newValue, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual int16	GetValue () const =0
virtual void	SetTitle (const PMString &title, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual PMString	GetTitle () const =0
virtual void	SetMajorTaskName (const PMString &majorTask, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual PMString	GetMajorTaskName ()=0
virtual void	SetMinorTaskName (const PMString &minorTask, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual PMString	GetMinorTaskName ()=0
virtual void	SetStyle (ProgressBarStyle s)=0
virtual ProgressBarStyle	GetStyle () const =0
virtual void	SetTaskStatus (const PMString &taskStatus, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual PMString	GetTaskStatus ()=0
virtual void	SetInnerText (const PMString &str)=0
virtual PMString	GetInnerText ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Control Data interface corresponding to a progress bar.

Member Function Documentation

virtual PMString IProgressBarControlData::GetInnerText ( )

pure virtual

Get the "inner text" string.

virtual PMString IProgressBarControlData::GetMajorTaskName ( )

pure virtual

Get the name of the current major task.

virtual int16 IProgressBarControlData::GetMax ( ) const

pure virtual

Get the maximum of the progress bar's range

virtual int16 IProgressBarControlData::GetMin ( ) const

pure virtual

Get the minimum of the progress bar's range

virtual PMString IProgressBarControlData::GetMinorTaskName ( )

pure virtual

Get the name of the current minor task.

virtual ProgressBarStyle IProgressBarControlData::GetStyle ( ) const

pure virtual

Get the Progress Bar style.

virtual PMString IProgressBarControlData::GetTaskStatus ( )

pure virtual

Get the current task status string.

virtual PMString IProgressBarControlData::GetTitle ( ) const

pure virtual

Get the Title the progress bar.

virtual int16 IProgressBarControlData::GetValue ( ) const

pure virtual

Get the current value of the progress indicator.

virtual void IProgressBarControlData::SetInnerText ( const PMString &  str )

pure virtual

Set the "inner text" string (used in DrawBarText method of some progress bar implementations).

virtual void IProgressBarControlData::SetMajorTaskName ( const PMString &  majorTask, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Set the name of the current major task

Parameters

majorTask	IN the name of the major task
invalidate	IN invalidate the associated control view
notifyOfChange	IN notify the associated subject

virtual void IProgressBarControlData::SetMinorTaskName ( const PMString &  minorTask, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Set the name of the current minor task

Parameters

minorTask	IN the name of the minor task
invalidate	IN invalidate the associated control view
notifyOfChange	IN notify the associated subject

virtual bool16 IProgressBarControlData::SetRange ( int16  min, int16  max  )

pure virtual

Set the range of the progress bar.

virtual void IProgressBarControlData::SetStyle ( ProgressBarStyle  s )

pure virtual

Set the Progress Bar style: eFixedRange, eBarberPole, eDocWindow.

virtual void IProgressBarControlData::SetTaskStatus ( const PMString &  taskStatus, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Set the current task status string

Parameters

taskStatus	IN status string
invalidate	IN invalidate the associated control view
notifyOfChange	IN notify the associated subject

virtual void IProgressBarControlData::SetTitle ( const PMString &  title, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Set the Title the progress bar.

Parameters

title	IN the title
invalidate	IN invalidate the associated control view
notifyOfChange	IN notify the associated subject

virtual void IProgressBarControlData::SetValue ( int16  newValue, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Set the current value of the progress indicator.

Parameters

newValue	IN the new value for the control
invalidate	IN invalidate the associated control view
notifyOfChange	IN notify the associated subject