XUIInspectorCheckBoxItem
Implements XUIInspectorItem
Description
Used to display a checkbox with a caption in the inspector.
Properties
| Name | Type | Read-Only |
|---|---|---|
| Caption | String |
|
| CaptionWidth | Integer |
|
| mBounds | Rect |
|
| mCaption | String |
|
| mCheckboxBounds | Rect |
|
| mData | Variant |
|
| mID | String |
|
| mSection | WeakRef |
|
| mValue | Boolean |
|
| Value | Boolean |
Methods
| Name | Parameters | Returns |
|---|---|---|
| Bounds | Rect |
|
| Bounds | Assigns b As Rect |
|
| CanAcceptTab | Boolean |
|
| Constructor | ID As String, caption As String, captionWidth As Integer, value As Boolean |
|
| Data | Variant |
|
| Data | Assigns v As Variant |
|
| DidReceiveBackTab | ||
| DidReceiveTabFocus | ||
| DrawCheckbox | g As Graphics, x As Double, y As Double, style As XUIInspectorStyle |
|
| FromTOML | toml As String |
XUIInspectorCheckBoxItem |
| 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 |
|
| 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 |
|---|---|
| CHECKBOX_SIZE | Double |
| HPADDING | Double |
| VPADDING | Double |
CHECKBOX_SIZE As Double The size of the checkbox square.
HPADDING As Double The number of pixels to pad the item's content left and right.
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 checkbox.
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 checkbox.
mCheckboxBounds As Rect
The bounds of the checkbox. Used for hit-testing.
mData As Variant
Arbitrary data associated with this item.
mID As String
Used to identify this item in notifications. You should ensure it is unique within the inspector.
mSection As WeakRef
A weak reference to the inspector section this item is within. May be Nil.
mValue As Boolean
The checkbox value. True = checked, False = unchecked.
Value As Boolean
The checkbox value. True = checked, False = unchecked.
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.
CanAcceptTab() 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 checkbox item. captionWidth is the desired width of the caption and value is the initial checkbox state.
Data() As Variant
Arbitrary data associated with this item.
Data(Assigns v As Variant)
Arbitrary data associated with this item.
DidReceiveBackTab()
This item has just received the focus via the shift-tab key combo (the "back tab").
Part of the XUIInspectorItem interface.
DidReceiveTabFocus()
This item has just received the focus via the tab key.
DrawCheckbox(g As Graphics, x As Double, y As Double, style As XUIInspectorStyle)
Draws the checkbox to the passed graphics context at the precomputed x, y position.
FromTOML(toml As String) As XUIInspectorCheckBoxItem
Returns a new checkbox item from a TOML string.
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.
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.