All Frameworks Class Hierarchy This Framework Indexes Previous Next

DELLiveInfraU5Itf Interface DELILiveInfraStampProxy

Usage: you can freely reimplement this interface.

interface DELILiveInfraStampProxy

Interface providing information and actions related to the thumbnail displayed in the immersive browser.
Role: Interface used by model objects to provide information and actions related to a thumbnail displayed in the immersive browser.

Method Index

o GetContextualMenu(CATListOfCATUnicodeString*,CATListOfCATUnicodeString*,CATListOfCATUnicodeString*): This method returns the information needed to build the contextual menu of a stamp.
o GetCreationInfo(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATPixelImage*&,CATPathElement*&,CATString&,CATBoolean&,CATBoolean&,CATBoolean&,CATBoolean&,CATBoolean&)
o GetCtxMenuModes(int,CATListOfInt*): This method returns the mode (exclusive/shared) for the commands available on the contextual menu of a stamp.
o GetDepth(): Returns the depth of the stamp's object in the tree.
o GetFullName(CATBoolean): Returns the full name of the stamps's object (a concatenation of the names of the stamp's object and all its fathers.
o GetImage(): Returns the stamp's image (thumbnail).
o GetNLSType(CATUnicodeString&): Returns the NLS type of the thumbnail, used for arranging thumbnails by type.
o GetName(CATBoolean): Returns the name of the stamp's object, to be displayed as label of the thumbnail.
o GetTextModeImage(): Returns an image that is displayed to the right of the name in text mode.
o IsObjectActive(): Returns the active state of the stamp's object.
o IsObjectHidden(): Returns the visibility state of the stamp's object.
o NeedsRebuild(): Returns 'TRUE' if the stamp needs to be rebuilt while refreshing the immersive browser, otherwise 'FALSE'.
o OnCommandEnding(CATString&): Method called when a command launched from the stamp's contextual menu ends.
o PreSelected(CATBoolean): This method is called by the browser when the pre-selection state (mouse over) of the stamp changes.
o Refresh(): This method is called by browser agents when the object represented by the stamp has been modified.
o Selected(CATBoolean): This method is called by the browser when the selection state of the stamp changes.
o SetImage(CATPixelImage*): Replaces the stamp's image (thumbnail).

Methods

o GetContextualMenu

public virtual GetContextualMenu(		`oCmdHeaders`,
		`oCmdLabels`,
		`oCmdIcons`)

This method returns the information needed to build the contextual menu of a stamp. It is called on the stamp after it was built/rebuilt and the resulting menu is cached.

Parameters:

oCmdHeaders: [in] CATListOfCATUnicodeString *. Ordered list of command header strings.
oCmdLabels: [in] CATListOfCATUnicodeString *. Ordered list of labels to be displayed in the menu.
oCmdIcons: [in] CATListOfCATUnicodeString *. Ordered list of bmp icons to be displayed to the left of the label. Size: 22x22 Do not include the '.bmp'. Place icons in resources\graphic\icons\normal.

Returns:

S_OK on success, E_FAIL on failure

o GetCreationInfo

public virtual GetCreationInfo(		`oName`,
		`oType`,
		`oImageName`,
		`oImage`,
		`opPathOfTbObject`,
		`oDoubleClickCmdHdr`,
		`oSupportsDelete`,
		`oSupportsProperties`,
		`oSupportsDragNDrop`,
		`oSupportsHideShow`,
		`oSupportsAcquisition`)

o GetCtxMenuModes

public virtual GetCtxMenuModes(		`iCmdHdrSize`,
		`oCmdModes`)

This method returns the mode (exclusive/shared) for the commands available on the contextual menu of a stamp.

Parameters:

iCmdHdrSize: [in] int. Number of declared commmand headers.
oCmdModes: [out] CATListOfInt *. Ordered list of command header modes (acceptable values: 0 - exclusive command, 1 - shared command).

Returns:

S_OK on success, E_FAIL on failure

o GetDepth

public virtual GetDepth(

)

Returns the depth of the stamp's object in the tree. If returned value is bigger than 0, the thumbnail will appear indented.

Returns:: Depth value (must be 0 or bigger than 0).

o GetFullName

public virtual GetFullName( ibUpper = FALSE )

Returns the full name of the stamps's object (a concatenation of the names of the stamp's object and all its fathers.)

Parameters:

ibUpper: [in] CATBoolean. Indicates if the returned name should be all upper-case letters (if TRUE), or not (if FALSE - default value).

Returns:

CATUnicodeString &.

o GetImage

public virtual GetImage(

)

Returns the stamp's image (thumbnail).

Returns:: CATPixelImage *. Returned pointer must be AddRef by the implementation method and released by the caller.

o GetNLSType

public virtual GetNLSType( oNLSType)

Returns the NLS type of the thumbnail, used for arranging thumbnails by type.

Parameters:

oNLSType: [out] CATUnicodeString&. Represents the thumbnail's type (with NLS support).

Returns:

S_OK on success, E_FAIL on failure

o GetName

public virtual GetName( ibUpper = FALSE )

Returns the name of the stamp's object, to be displayed as label of the thumbnail.

Parameters:

ibUpper: [in] CATBoolean. Indicates if the returned name should be all upper-case letters (if TRUE), or not (if FALSE - default value).

Returns:

CATUnicodeString &.

o GetTextModeImage

public virtual GetTextModeImage(

)

Returns an image that is displayed to the right of the name in text mode. This an optional image that is used to display information unique to a particular object.

Returns:: CATPixelImage *. Must be of size 22x22. Returned pointer must be AddRef by the implementation method and released by the caller.

o IsObjectActive

public virtual IsObjectActive(

)

Returns the active state of the stamp's object.

Returns:: int. '0' means the object is not active, otherwise returned value must be bigger than 0.

o IsObjectHidden

public virtual IsObjectHidden(

)

Returns the visibility state of the stamp's object.

Returns:: CATBoolean. Visibility status: 'TRUE' means the object is visible, 'FALSE' means the object is hidden.

o NeedsRebuild

public virtual NeedsRebuild(

)

Returns 'TRUE' if the stamp needs to be rebuilt while refreshing the immersive browser, otherwise 'FALSE'.

Returns:: CATBoolean. Rebuild status.

o OnCommandEnding

public virtual OnCommandEnding( ipCommandHdrID)

Method called when a command launched from the stamp's contextual menu ends. This method can be used as an opportunity to force a refresh of the browsers if the command did not trigger any model events.

Parameters:

ipCommandHdrID: [in] CATString&. Represents the command header ID for the command that just ended.

Returns:

S_OK on success, E_FAIL on failure

o PreSelected

public virtual PreSelected( ibState)

This method is called by the browser when the pre-selection state (mouse over) of the stamp changes.

Parameters:

ibState: [in] CATBoolean. 'TRUE' if the stamp was pre-selected, 'FALSE' if the stamp pre-selection status is canceled.

Returns:

S_OK on success, E_FAIL on failure

o Refresh

public virtual Refresh(

)

This method is called by browser agents when the object represented by the stamp has been modified.

Returns:: S_OK on success, E_FAIL on failure

o Selected

public virtual Selected( ibState)

This method is called by the browser when the selection state of the stamp changes.

Parameters:

ibState: [in] CATBoolean. 'TRUE' if the stamp was selected, 'FALSE' if the stamp was unselected.

Returns:

S_OK on success, E_FAIL on failure

o SetImage

public virtual SetImage( iImage)

Replaces the stamp's image (thumbnail).

Parameters:

iImage: [in] CATPixelImage *. Represents the image to be used on the thumbnail (must be of size 144x108).

Returns:

S_OK on success, E_FAIL on failure

This object is included in the file: DELILiveInfraStampProxy.h
If needed, your Imakefile.mk should include the module: DELLiveInfraU5Itf