XUIInspectorColorItem

Implements XUIInspectorItem

Description

An item containing a single colour swatch and a caption.

Properties

Name	Type	Read-Only
Caption	`String`
CaptionWidth	`Integer`
mBounds	`Rect`
mCaption	`String`
mColorPickerVisible	`Boolean`
mID	`String`
mOwner	`WeakRef`
mSection	`WeakRef`
mSwatchBounds	`Rect`
mValue	`Color`
Value	`Color`

Methods

Name	Parameters	Returns
Bounds		`Rect`
Bounds	Assigns b As `Rect`
CanAcceptTabFocus		`Boolean`
Constructor	ID As `String`, caption As `String`, captionWidth As `Integer`, value As `Color`
DidReceiveTabFocus
DrawColorSwatch	g As `Graphics`, x As `Double`, y As `Double`, style As `XUIInspectorStyle`, w As `Double`, h As `Double`
Height	style As `XUIInspectorStyle`	`Double`
ID		`String`
LostFocus
MouseDown	x As `Integer`, y As `Integer`, clickType As `XUI.ClickTypes`	`XUIInspectorMouseDownData`
MouseExit		`Boolean`
MouseMoved	x As `Double`, y As `Double`	`XUIInspectorMouseMoveData`
MouseUp	x As `Integer`, y As `Integer`, clickType As `XUI.ClickTypes`	`XUIInspectorMouseUpData`
Owner		`XUIInspector`
Owner	Assigns inspector As `XUIInspector`
PickerClosing	picker As `XUIColorPicker`
PopupDismissed
PopupItemSelected	index As `Integer`
Render	g As `Graphics`, x As `Double`, y As `Double`, width As `Double`, style As `XUIInspectorStyle`	`Double`
Section		`XUIInspectorSection`
Section	Assigns section As `XUIInspectorSection`
SwatchHeight	style As `XUIInspectorStyle`	`Double`

Constants

Name	Type
HPADDING	`Double`
SWATCH_VPADDING	`Double`
VPADDING	`Double`

HPADDING As Double The number of pixels to pad the item's content left and right.

SWATCH_VPADDING As Double The height of the swatch is the height of the caption plus this value.

VPADDING As Double The number of pixels to pad the item's content above and below.

Property Descriptions

Caption As String

The caption to display besides the colour swatch.

CaptionWidth As Integer

The width the caption should be constrained to.

mBounds As Rect

The bounds of this item.

mCaption As String

The caption to display besides the colour swatch.

mColorPickerVisible As Boolean

True if the color picker is visible.

mID As String

Used to identify this item in notifications. You should ensure it is unique within the inspector.

mOwner As WeakRef

A weak reference to the inspector this item belongs to.

mSection As WeakRef

A weak reference to the inspector section this item is within. May be Nil.

mSwatchBounds As Rect

The bounds of the colour swatch. Used for hit-testing.

mValue As Color

The swatch colour.

Value As Color

The swatch colour.

Method Descriptions

Bounds() As Rect

The bounds of this item within the inspector.

Bounds(Assigns b As Rect)

Sets the bounds of this item in the inspector.

CanAcceptTabFocus() As Boolean

Returns True if this item is able to accept the focus via the tab key.

Constructor(ID As String, caption As String, captionWidth As Integer, value As Color)

Constructs a new item containing a colour swatch which can be altered by clicking it. value is the initial colour.

DidReceiveTabFocus()

This item has just received the focus via the tab key.

DrawColorSwatch(g As Graphics, x As Double, y As Double, style As XUIInspectorStyle, w As Double, h As Double)

Draws the color to the passed graphics context at the precomputed x, y position of width w and height h and updates its bounds.

Height(style As XUIInspectorStyle) As Double

The height of this item given the desired style.

Part of the XUIInspectorItem interface.

ID() As String

Used to identify this item in notifications. You should ensure it is unique within the inspector.

LostFocus()

This item just lost the focus.

Part of the XUIInspectorItem interface.

MouseDown(x As Integer, y As Integer, clickType As XUI.ClickTypes) As XUIInspectorMouseDownData

Tells the item that a mouse down event has occurred within its bounds. x, y are the absolute coordinates relative to the inspector (adjusted for scrolling). Returns a MouseDownData instance instructing the inspector how to handle the event or Nil if the click didn't happen in this item.

MouseExit() As Boolean

Used to tell this item that the mouse has just exited it. Returns True if the inspector should redraw.

Part of the XUIInspectorItem interface.

MouseMoved(x As Double, y As Double) As XUIInspectorMouseMoveData

The mouse has just moved over this item. Returns data to inform the inspector how to handle the movement. May return Nil.

Part of the XUIInspectorItem interface.

MouseUp(x As Integer, y As Integer, clickType As XUI.ClickTypes) As XUIInspectorMouseUpData

Tells the item that a mouse up event has occurred within its bounds. x, y are the absolute coordinates relative to the inspector (adjusted for scrolling). Returns a MouseUpData instance instructing the inspector how to handle the event or Nil if the click didn't happen in this item.

Owner() As XUIInspector

A weak reference to the inspector this item belongs to.

Owner(Assigns inspector As XUIInspector)

The inspector this item belongs to. A weak reference will be created.

PickerClosing(picker As XUIColorPicker)

Delegate called when this swatch's color picker is closing.

PopupDismissed()

Tells this item that any popup it thinks it has displayed has been dismissed with no action.

Part of the XUIInspectorItem interface.

PopupItemSelected(index As Integer)

The entry at index has been selected in this item's popup menu.

Part of the XUIInspectorItem interface.

Render(g As Graphics, x As Double, y As Double, width As Double, style As XUIInspectorStyle) As Double

The item should render itself to the passed graphics context at the specified location. Returns the position of the item's bottom edge.

Part of the XUIInspectorItem interface.

|----------------------|
| CAPTION     [      ] |
|----------------------|

Section() As XUIInspectorSection

A weak reference to the section this item is in.

Section(Assigns section As XUIInspectorSection)

The section this item is within to. A weak reference will be created.

SwatchHeight(style As XUIInspectorStyle) As Double

The height of the swatch given the current style.