Songbird / Development / Songbird Add-Ons API Documentation

sbIClickablePropertyInfo Interface Reference

The property information specific to clickable properties. More...

import "sbIClickablePropertyInfo.idl";

List of all members.

Public Member Functions

AString getValueForClick (in AString aCurrentValue, in unsigned long aBoxWidth, in unsigned long aBoxHeight, in unsigned long aMouseX, in unsigned long aMouseY)
 Convert a mouse click to a value for this property.

Public Attributes

readonly attribute boolean suppressSelect


Detailed Description

The property information specific to clickable properties.

A property that implements this interface indicates that it can convert a mouse click into a value for the property.

See also:
sbIPropertyInfo

Definition at line 45 of file sbIClickablePropertyInfo.idl.


Member Function Documentation

AString sbIClickablePropertyInfo::getValueForClick ( in AString  aCurrentValue,
in unsigned long  aBoxWidth,
in unsigned long  aBoxHeight,
in unsigned long  aMouseX,
in unsigned long  aMouseY 
)

Convert a mouse click to a value for this property.

Parameters:
aCurrentValue The current value of this property
aBoxWidth Width of the clickable area
aBoxHeight Height of the clickable area
aMouseX The X coordinate of the click location
aMouseY The Y coordinate of the click location
Returns:
The value that should be given to this property for the click


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:57 2009 for Songbird by  doxygen 1.5.2