HidTxtFacade Class Reference

#include <HidTxtFacade.h>

Public Member Functions
	HidTxtFacade (const UIDRef &textModelUIDRef, const TextIndex &anchorTextIndex)
virtual	~HidTxtFacade ()
virtual bool16	CanCreateHiddenText ()
virtual ErrorCode	CreateHiddenText (const WideString &text)
virtual bool16	CanGetHiddenText ()
virtual ErrorCode	GetHiddenText (WideString &text)
virtual bool16	CanModifyHiddenText ()
virtual ErrorCode	ModifyHiddenText (const WideString &text)
virtual bool16	CanDeleteHiddenText ()
virtual ErrorCode	DeleteHiddenText ()

Detailed Description

Facade for the manipulation of hidden text. Suites should manipulate hidden text through this API.

Constructor & Destructor Documentation

HidTxtFacade::HidTxtFacade	(	const UIDRef &	textModelUIDRef,
		const TextIndex &	anchorTextIndex
	)

Constructor.

Parameters

textModelUIDRef	references story in which the hidden text is stored.
anchorTextIndex	index in the text model when the hidden text is anchored.

HidTxtFacade::~HidTxtFacade ( )

virtual

Destructor.

Member Function Documentation

bool16 HidTxtFacade::CanCreateHiddenText ( )

virtual

Returns

kTrue if hidden text can be created, kFalse otherwise.

bool16 HidTxtFacade::CanDeleteHiddenText ( )

virtual

Returns

kTrue if hidden text can be deleted, kFalse otherwise.

bool16 HidTxtFacade::CanGetHiddenText ( )

virtual

Returns

kTrue if hidden text can be accessed, kFalse otherwise.

bool16 HidTxtFacade::CanModifyHiddenText ( )

virtual

Returns

kTrue if hidden text can be modified, kFalse otherwise.

ErrorCode HidTxtFacade::CreateHiddenText ( const WideString &  text )

virtual

Create hidden text.

Parameters

text	the hidden text to be stored.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode HidTxtFacade::DeleteHiddenText ( )

virtual

Delete hidden text.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode HidTxtFacade::GetHiddenText ( WideString &  text )

virtual

Get hidden text.

Parameters

text	the retrieved hidden text.

ErrorCode HidTxtFacade::ModifyHiddenText ( const WideString &  text )

virtual

Modify hidden text.

Parameters

text	this string completely replaces the current hidden text.

Returns

kSuccess on success, other ErrorCode otherwise.