IStringListControlData Class Reference

#include <IStringListControlData.h>

Inheritance diagram for IStringListControlData:

Public Types
enum	{ kDefaultIID = IID_ISTRINGLISTCONTROLDATA }

list position constants
enum	{ kBeginning = 0, kEnd = -2, kInvalidStringIndex = -1 }
virtual void	AddString (const PMString &newString, int32 at=kEnd, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual void	RemoveString (int32 index, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual void	Clear (bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual PMString	GetString (int32 index) const =0
virtual void	SetString (int32 index, const PMString &replaceString, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual int32	GetIndex (const PMString &string, bool16 skipIfDisabled=kFalse) const =0
virtual int32	GetIndexOfPartialString (const PMString &stringBeginning, bool16 caseSensitive, bool16 skipIfDisabled=kFalse) const =0
virtual int32	Length () const =0
virtual void	Enable (int32 index, bool16 doEnable=kTrue, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual void	Disable (int32 index, bool16 invalidate=kTrue, bool16 notifyOfChange=kTrue)=0
virtual bool16	IsEnabled (int32 index) const =0

Additional Inherited Members
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 associated with widgets based on a list of strings (typically a drop downs variant).

Member Enumeration Documentation

anonymous enum

Enumerator
kBeginning	at the beginning of the list
kEnd	at the end of the list
kInvalidStringIndex	not found in the list

Member Function Documentation

virtual void IStringListControlData::AddString ( const PMString &  newString, int32  at = kEnd, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Add a string to the list.

Parameters

newString	IN the string to add
at	IN index to add the string, default is at end
invalidate	IN invalidate the associated view, default is true
notifyOfChange	IN notify the associated subject, default is true

virtual void IStringListControlData::Clear ( bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Clear the list (remove all the strings).

Parameters

invalidate	IN invalidate the associated view, default is true
notifyOfChange	IN notify the associated subject, default is true

virtual void IStringListControlData::Disable ( int32  index, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Disable the element at the given position in the list.

Parameters

index	IN item to disable
invalidate	IN invalidate the associated view, default is true
notifyOfChange	IN notify the associated subject, default is true

virtual void IStringListControlData::Enable ( int32  index, bool16  doEnable = kTrue, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Enable (or disable) the element at the given position in the list.

Parameters

index	IN item to enable/disable
doEnable	IN enable or disable the item
invalidate	IN invalidate the associated view, default is true
notifyOfChange	IN notify the associated subject, default is true

virtual int32 IStringListControlData::GetIndex ( const PMString &  string, bool16  skipIfDisabled = kFalse  ) const

pure virtual

Find the index of a string in the list

Parameters

string	IN the string to find
skipIfDisabled	IN whether or not the match (if any) be skipped if it is disabled

Returns

index of the string, or kInvalidStringIndex if not found.

virtual int32 IStringListControlData::GetIndexOfPartialString ( const PMString &  stringBeginning, bool16  caseSensitive, bool16  skipIfDisabled = kFalse  ) const

pure virtual

Find the index of a string whose beginning matches the passed in string.

Parameters

stringBeginning	IN the string to match
caseSensitive	IN should the comparison be case sensitive
skipIfDisabled	IN whether or not the match (if any) be skipped if it is disabled

Returns

index of the string, or kInvalidStringIndex if not found.

virtual PMString IStringListControlData::GetString ( int32  index ) const

pure virtual

Get one of the strings

virtual bool16 IStringListControlData::IsEnabled ( int32  index ) const

pure virtual

Is this item enabled?

virtual int32 IStringListControlData::Length ( ) const

pure virtual

How many strings are in the list?

virtual void IStringListControlData::RemoveString ( int32  index, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Remove a string to the list.

Parameters

index	IN index of string to remove
invalidate	IN invalidate the associated view, default is true
notifyOfChange	IN notify the associated subject, default is true

virtual void IStringListControlData::SetString ( int32  index, const PMString &  replaceString, bool16  invalidate = kTrue, bool16  notifyOfChange = kTrue  )

pure virtual

Replace one of the strings

Parameters

index	IN which string to replace
replaceString	IN the new string
invalidate	IN invalidate the associated view, default is true
notifyOfChange	IN notify the associated subject, default is true