IHidTxtSuite Class Reference

#include <IHidTxtSuite.h>

Inheritance diagram for IHidTxtSuite:

Public Types
enum	{ kDefaultIID = IID_IHIDTXTSUITE }

Public Member Functions
virtual bool16	CanCreateHiddenText () const =0
virtual ErrorCode	CreateHiddenText (const WideString &text)=0
virtual bool16	CanGetHiddenText () const =0
virtual void	GetHiddenText (WideString &text) const =0
virtual bool16	CanModifyHiddenText () const =0
virtual ErrorCode	ModifyHiddenText (const WideString &text)=0
virtual bool16	CanDeleteHiddenText () const =0
virtual ErrorCode	DeleteHiddenText ()=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

From SDK sample; abstract suite interface that extends the capability of selection so that it can manipulate hidden text.

Member Function Documentation

virtual bool16 IHidTxtSuite::CanCreateHiddenText ( ) const

pure virtual

Returns

kTrue if hidden text can be created, kFalse otherwise.

Implemented in HidTxtSuiteTextCSB, and HidTxtSuiteASB.

virtual bool16 IHidTxtSuite::CanDeleteHiddenText ( ) const

pure virtual

Returns

kTrue if hidden text can be deleted, kFalse otherwise.

Implemented in HidTxtSuiteTextCSB, and HidTxtSuiteASB.

virtual bool16 IHidTxtSuite::CanGetHiddenText ( ) const

pure virtual

Returns

kTrue if hidden text can be accessed, kFalse otherwise.

Implemented in HidTxtSuiteTextCSB, and HidTxtSuiteASB.

virtual bool16 IHidTxtSuite::CanModifyHiddenText ( ) const

pure virtual

Returns

kTrue if hidden text can be modified, kFalse otherwise.

Implemented in HidTxtSuiteTextCSB, and HidTxtSuiteASB.

virtual ErrorCode IHidTxtSuite::CreateHiddenText ( const WideString &  text )

pure virtual

Create hidden text.

Parameters

text	the hidden text to be stored.

Returns

kSuccess on success, other ErrorCode otherwise.

Implemented in HidTxtSuiteTextCSB, and HidTxtSuiteASB.

virtual ErrorCode IHidTxtSuite::DeleteHiddenText ( )

pure virtual

Delete hidden text.

Returns

kSuccess on success, other ErrorCode otherwise.

Implemented in HidTxtSuiteTextCSB, and HidTxtSuiteASB.

virtual void IHidTxtSuite::GetHiddenText ( WideString &  text ) const

pure virtual

Get hidden text.

Parameters

text	the retrieved hidden text.

Implemented in HidTxtSuiteTextCSB, and HidTxtSuiteASB.

virtual ErrorCode IHidTxtSuite::ModifyHiddenText ( const WideString &  text )

pure virtual

Modify hidden text.

Parameters

text	this string completely replaces the current hidden text.

Returns

kSuccess on success, other ErrorCode otherwise.

Implemented in HidTxtSuiteTextCSB, and HidTxtSuiteASB.