ITextAttrInt32 Class Reference

#include <ITextAttrInt32.h>

Inheritance diagram for ITextAttrInt32:

Public Types
enum	{ kDefaultIID = IID_ITEXTATTRINT32 }
typedef int32	ValueType
typedef int32	value_type

Public Member Functions
virtual void	Set (value_type)=0
virtual value_type	Get () const =0
virtual bool16	HasLimits (value_type &lLim, value_type &uLim) const =0
value_type	GetInt32 () const
void	SetInt32 (value_type flag)
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 for a text attribute whose value is represented by a 32 bit integer.

Member Function Documentation

virtual bool16 ITextAttrInt32::HasLimits ( value_type &  lLim, value_type &  uLim  ) const

pure virtual

Report whether or not this attribute has upper and/or lower limits and what they are. The limits are the same units as the value.

Parameters

lLim	IN If the return value is kTrue, is the lower limit of valid values. (value will always be >= the returned value)
uLim	IN If the return value is kTrue, is the upper limit of valid values. (value will always be <= the returned value)

Returns

if the return value is kFalse the parameter values are undefined.

Note

the caller has ultimate responsibility for enforcing the limits. i.e. although well-behaved implementations will enforce the limits, not all are. Also, how the limits are enforced may vary with each implementation - i.e. some silently ignore the invalid values, some set to the nearest limit.

virtual void ITextAttrInt32::Set ( value_type  )

pure virtual

A well-behaved implementation will enforce the limits, if any, returned by HasLimits(). If the value exceeds either limit, it should be set to that limit.