ICounterControlData Class Reference

#include <ICounterControlData.h>

Inheritance diagram for ICounterControlData:

Public Types
enum	{ kDefaultIID = IID_ICOUNTERCONTROLDATA }

Public Member Functions
virtual void	SetMinimum (int32 min)=0
virtual void	SetMaximum (int32 max)=0
virtual void	SetValue (int32 value, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual void	SetPageSize (int32 pageSize)=0
virtual int32	GetMinimum () const =0
virtual int32	GetMaximum () const =0
virtual int32	GetValue () const =0
virtual int32	GetPageSize () const =0
virtual int32	Increment (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual int32	Decrement (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual int32	IncrementMultiple (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual int32	DecrementMultiple (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual int32	GetIncrement () const =0
virtual int32	GetIncrementMultiple () const =0
virtual void	SetIncrement (int32 increment)=0
virtual void	SetIncrementMultiple (int32 increment)=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

Interface representing counter state, used for widgets like a scrollbar or splitter.

Member Function Documentation

virtual int32 ICounterControlData::Decrement ( bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Parameters

invalidate	if kTrue, specify that control needs redrawn
notifyOfChange	if kTrue, notify registered observers of change

Returns

the new value of counter state

virtual int32 ICounterControlData::DecrementMultiple ( bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Parameters

invalidate	if kTrue, specify that control needs redrawn
notifyOfChange	if kTrue, notify registered observers of change

Returns

the new value of counter state

virtual int32 ICounterControlData::GetIncrement ( ) const

pure virtual

Accessor for the current increment value of this counter

Returns

current increment value

virtual int32 ICounterControlData::GetIncrementMultiple ( ) const

pure virtual

Accessor the multiple-increment property of this counter

Returns

current state of the multiple-increment

virtual int32 ICounterControlData::GetMaximum ( ) const

pure virtual

Accessor for upper bound on counter range

Returns

upper bound on counter range

virtual int32 ICounterControlData::GetMinimum ( ) const

pure virtual

Accessor for lower bound on counter range

Returns

lower bound on counter range

virtual int32 ICounterControlData::GetPageSize ( ) const

pure virtual

Accessor for the "page size", i.e. how much of a scrollbar, say, is visible

Returns

the page size

virtual int32 ICounterControlData::GetValue ( ) const

pure virtual

Accessor for counter state

Returns

current counter state

virtual int32 ICounterControlData::Increment ( bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Parameters

invalidate	if kTrue, specify that control needs redrawn
notifyOfChange	if kTrue, notify registered observers of change

Returns

the new value of counter state

virtual int32 ICounterControlData::IncrementMultiple ( bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Parameters

invalidate	if kTrue, specify that control needs redrawn
notifyOfChange	if kTrue, notify registered observers of change

Returns

the new value of counter state

virtual void ICounterControlData::SetIncrement ( int32  increment )

pure virtual

Specify a new increment for the counter. If 0, defaults to 1.

Parameters

increment

new increment for counter

virtual void ICounterControlData::SetIncrementMultiple ( int32  increment )

pure virtual

Specify a new multiple-increment property for counter. If 0, defaults to 1.

Parameters

increment

new multiple-increment for counter

virtual void ICounterControlData::SetMaximum ( int32  max )

pure virtual

Specify upper bound for range spanned

Parameters

max

virtual void ICounterControlData::SetMinimum ( int32  min )

pure virtual

Specify lower bound for range spanned

Parameters

min

virtual void ICounterControlData::SetPageSize ( int32  pageSize )

pure virtual

Set a new page size for this control. Note that pageSize is (max - min) / howMuchIsVisibleAtOnce on Win and howMuchIsVisibleAtOnce on Mac

Parameters

pageSize

virtual void ICounterControlData::SetValue ( int32  value, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Set state to given value, will be within range [min,max]

Parameters

value	value to set
invalidate	if kTrue, specify that control needs redrawn
notifyOfChange	if kTrue, notify registered observers of change