The property information specific to clickable properties. More...
import"sbIClickablePropertyInfo.idl";
Public Member Functions | |
| boolean | isDisabled (in AString aCurrentValue) |
| Whether the tree cell widget representing this property should be disabled given a value (for this property) More... | |
| boolean | hitTest (in AString aCurrentValue, in AString aPart, in unsigned long aBoxWidth, in unsigned long aBoxHeight, in unsigned long aMouseX, in unsigned long aMouseY) |
| Hit testing for a cell. More... | |
| boolean | onClick (in sbIMediaItem aItem, [optional] in nsISupports aEvent, [optional] in nsISupports aContext) |
| Callback for a click event for special handling. More... | |
| 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. More... | |
Public Attributes | |
| attribute boolean | suppressSelect |
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.
Definition at line 49 of file sbIClickablePropertyInfo.idl.
| 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.
| 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 |
| boolean sbIClickablePropertyInfo::hitTest | ( | in AString | aCurrentValue, |
| in AString | aPart, | ||
| in unsigned long | aBoxWidth, | ||
| in unsigned long | aBoxHeight, | ||
| in unsigned long | aMouseX, | ||
| in unsigned long | aMouseY | ||
| ) |
Hit testing for a cell.
| aCurrentValue | the property value of the item (row) clicked on |
| aPart | the pseudoelement being hit |
| aBoxWidth | the total box object width of the cell |
| aBoxHeight | the total box object height of the cell |
| aMouseX | the X coordinate of the mouse, relative to the left edge of the box object |
| aMouseY | the Y coordinate of the mouse, relative to the top edge of the box object |
| boolean sbIClickablePropertyInfo::isDisabled | ( | in AString | aCurrentValue | ) |
Whether the tree cell widget representing this property should be disabled given a value (for this property)
| aCurrentValue | the property value of an item |
| boolean sbIClickablePropertyInfo::onClick | ( | in sbIMediaItem | aItem, |
| [optional] in nsISupports | aEvent, | ||
| [optional] in nsISupports | aContext | ||
| ) |
Callback for a click event for special handling.
| aItem | the media item being clicked on |
| aEvent | the DOM click event |
| aContext | a context for the click; most likely a playlist widget |
| attribute boolean sbIClickablePropertyInfo::suppressSelect |
Whether tree row selection should be suppressed for clicks on tree cells representing this property
Definition at line 55 of file sbIClickablePropertyInfo.idl.
