XUIInspectorSwitchItem
Implements XUIInspectorItem
Description
An item containing an on-off switch and caption.
Properties
| Name | Type | Read-Only |
|---|---|---|
| Caption | String |
|
| CaptionWidth | Integer |
|
| mBounds | Rect |
|
| mCaption | String |
|
| mID | String |
|
| mOwner | WeakRef |
|
| mSection | WeakRef |
|
| mSwitchBounds | Rect |
|
| mValue | Boolean |
|
| Value | Boolean |
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 Boolean |
|
| DidReceiveTabFocus | ||
| DrawSwitch | g As Graphics, x As Double, y As Double, style As XUIInspectorStyle |
|
| 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 |
|
| 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 |
Constants
| Name | Type |
|---|---|
| HPADDING | Double |
| SWITCH_HEIGHT | Double |
| SWITCH_WIDTH | Double |
| VPADDING | Double |
HPADDING As Double The number of pixels to pad the item's content left and right.
SWITCH_HEIGHT As Double The height of the switch.
SWITCH_WIDTH As Double The width of the switch.
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 switch.
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 switch.
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.
mSwitchBounds As Rect
The bounds of the switch. Used for hit-testing.
mValue As Boolean
The switch value. True = on, False = off.
Value As Boolean
The switch value. True = on, False = off.
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 Boolean)
Constructs a new item containing a switch which can be toggled on and off. value is the initial switch state (True is "on").
DidReceiveTabFocus()
This item has just received the focus via the tab key.
DrawSwitch(g As Graphics, x As Double, y As Double, style As XUIInspectorStyle)
Draws the switch to the passed graphics context at the precomputed x, y position.
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.
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.