Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATTPSBaseUseItf Interface CATITPSNoa

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATITPSNoa

Interface for the TPS Noa object.

Method Index

o GetFlagText(wchar_t**): Retrieves Flag Text.
o GetNoaType(wchar_t**): Retrieves Type of Noa.
o GetText(wchar_t**): Retrieves Text Representation.
o GetURL(int,wchar_t**)
o GetUrlListSize(int*)
o SetFlagText(wchar_t*): Sets Flag Text.
o SetNoaType(wchar_t*): Sets Type of Noa.
o SetText(wchar_t*): Sets Text Representation.
o SetURL(wchar_t*): Set a link to file or URL.

Methods

o GetFlagText

public virtual GetFlagText( opText)

Retrieves Flag Text.

Parameters:

opText: Flag Text

Returns:

S_OK if succeded (opText must be deleted).

o GetNoaType

public virtual GetNoaType( opNoaType)

Retrieves Type of Noa.

Parameters:

opNoaType: Kind of Noa.

Returns:

S_OK if succeded (opNoaType must be deleted).

o GetText

public virtual GetText( opText)

Retrieves Text Representation.

Parameters:

opText: Returned text for graphical representation.

Returns:

S_OK if succeded (opText must be deleted).

o GetURL

public virtual GetURL(	const	`iIndex`,
		`opUrl`)

Deprecated:

R417, use CATITPSHyperlinksManager::GetHyperlinkList Retrieves url.

Parameters:

iIndex: Index of url.
opUrl: url

Returns:

S_OK if succeded (opUrl must be deleted).

o GetUrlListSize

public virtual GetUrlListSize( oNumber)

Deprecated:

R417, use CATITPSHyperlinksManager::GetHyperlinkList Retrieves the number of urls.

Parameters:

oNumber: the size of url list.

o SetFlagText

public virtual SetFlagText( const ipText)

Sets Flag Text.

Parameters:

ipText: Flag Text

o SetNoaType

public virtual SetNoaType( const ipNoaType)

Sets Type of Noa.

Parameters:

ipNoaType: Kind of Noa, which will serve for filtering.

o SetText

public virtual SetText( const ipText)

Sets Text Representation.

Parameters:

ipText: Text for graphical representation.

o SetURL

public virtual SetURL( const pUrl)

Set a link to file or URL.

Parameters:

pUrl: The url or file link to set.

Returns:

S_OK if succeded.

This object is included in the file: CATITPSNoa.h