All Frameworks  Class Hierarchy  This Framework  Indexes   

CATTPSInterfaces 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**)
Retrieves url.
o GetUrlListSize(int*)
Retrieves the number of urls.
o RemoveURL(int)
Delete an url.
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*,int)
Sets or modifies 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)
Retrieves url.
Parameters:
iIndex
Index of url.
opUrl
url
Returns:
S_OK if succeded (opUrl must be deleted).
o GetUrlListSize
public virtual GetUrlListSize( oNumber)
Retrieves the number of urls.
Parameters:
oNumber
the size of url list.
o RemoveURL
public virtual RemoveURL( const iIndex)
Delete an url.
Parameters:
iIndex
Index of url to remove.
Returns:
S_OK if succeded.
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,
const iIndex= -1 )
Sets or modifies a link to file or URL.
Parameters:
pUrl
The url or file link to set.
iIndex
index of the URL to modify. if the iIndex is not defined, the URL is added to the FlagNote.
Returns:
S_OK if succeded.

This object is included in the file: CATITPSNoa.h

Copyright © 2003, Dassault Systèmes. All rights reserved.