Class Checkbox

Namespace

MLEM.Ui.Elements

Assembly

MLEM.Ui.dll

A checkbox element to use inside of a UiSystem. A checkbox can be checked by pressing it and will stay checked until it is pressed again. For a checkbox that causes neighboring checkboxes to be deselected automatically, use RadioButton.

public class Checkbox : Element, IGenericDataHolder

Inheritance

object

GenericDataHolder

Element

Checkbox

Implements

IGenericDataHolder

Derived

RadioButton

Inherited Members

Element.Epsilon

Element.System

Element.Controls

Element.Parent

Element.Root

Element.Scale

Element.Anchor

Element.Size

Element.ScaledSize

Element.AutoSizeAddedAbsolute

Element.ScaledAutoSizeAddedAbsolute

Element.PositionOffset

Element.ScaledOffset

Element.ScaledPadding

Element.ScaledChildPadding

Element.ChildPaddedArea

Element.UnscrolledArea

Element.Area

Element.DisplayArea

Element.ScrollOffset

Element.ScaledScrollOffset

Element.IsHidden

Element.Priority

Element.Transform

Element.CanBeMoused

Element.CanAutoAnchorsAttach

Element.SetWidthBasedOnChildren

Element.SetHeightBasedOnChildren

Element.TreatSizeAsMinimum

Element.TreatSizeAsMaximum

Element.PreventParentSpill

Element.DrawAlpha

Element.IsMouseOver

Element.IsSelected

Element.IsSelectedActive

Element.AreaDirty

Element.AutoNavGroup

Element.Style

Element.SelectionIndicator

Element.ActionSound

Element.SecondActionSound

Element.Padding

Element.ChildPadding

Element.MouseEnterAnimation

Element.MouseExitAnimation

Element.OnDrawn

Element.OnUpdated

Element.OnPressed

Element.OnSecondaryPressed

Element.OnSelected

Element.OnDeselected

Element.OnMouseEnter

Element.OnMouseExit

Element.OnTouchEnter

Element.OnTouchExit

Element.OnTextInput

Element.OnAreaUpdated

Element.OnStyleInit

Element.OnMousedElementChanged

Element.OnTouchedElementChanged

Element.OnSelectedElementChanged

Element.GetTabNextElement

Element.GetGamepadNextElement

Element.OnChildAdded

Element.OnChildRemoved

Element.OnAddedToUi

Element.OnRemovedFromUi

Element.Children

Element.PlayingAnimations

Element.SortedChildren

Element.Input

Element.ParentArea

Element.AddChild<T>(T, int)

Element.RemoveChild(Element)

Element.RemoveChildren(Func<Element, bool>)

Element.SetSortedChildrenDirty()

Element.UpdateSortedChildrenIfDirty()

Element.ForceUpdateSortedChildren()

Element.SetAreaDirty()

Element.UpdateAreaIfDirty()

Element.ForceUpdateArea()

Element.CalcActualSize(RectangleF)

Element.GetAreaForAutoAnchors()

Element.GetLowestChild(Func<Element, bool>, bool)

Element.GetRightmostChild(Func<Element, bool>, bool)

Element.GetLowestOlderSibling(Func<Element, bool>, bool)

Element.GetOlderSibling(Func<Element, bool>)

Element.GetSiblings(Func<Element, bool>)

Element.GetChildren<T>(Func<T, bool>, bool, bool)

Element.GetChildren(Func<Element, bool>, bool, bool)

Element.GetParentTree()

Element.GetTotalCoveredArea(bool)

Element.GetRelevantChildren()

Element.Update(GameTime)

Element.DrawTransformed(GameTime, SpriteBatch, float, SpriteBatchContext)

Element.GetElementUnderPos(Vector2)

Element.PlayAnimation(UiAnimation)

Element.StopAnimation(UiAnimation)

Element.ToString()

Element.AndChildren(Action<Element>)

Element.ReorderChildren(Comparison<Element>)

Element.ReverseChildren(int, int?)

Element.ScaleTransform(float, Vector2?)

Element.OnChildAreaDirty(Element, bool)

Element.TransformInverse(Vector2)

Element.TransformInverseAll(Vector2)

Element.AddedToUi(UiSystem, RootElement)

Element.RemovedFromUi()

GenericDataHolder.SetData<T>(string, T)

GenericDataHolder.GetData<T>(string)

GenericDataHolder.GetDataKeys()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ElementExtensions.AddTooltip(Element, Paragraph.TextCallback)

ElementExtensions.AddTooltip(Element, Tooltip)

ElementExtensions.AddTooltip(Element, string)

Constructors

Checkbox(Anchor, Vector2, string, bool)

Creates a new checkbox with the given settings

public Checkbox(Anchor anchor, Vector2 size, string label, bool defaultChecked = false)

Parameters

anchor Anchor

The checkbox's anchor

size Vector2

The checkbox's size

label string

The checkbox's label text

defaultChecked bool

The default value of Checked

Fields

CanSelectDisabled

Whether this checkbox should be able to be selected even if it IsDisabled. If this is true, CanBeSelected will be able to return true even if IsDisabled is true.

public bool CanSelectDisabled

Field Value

bool

Checkmark

The texture that is rendered on top of this checkbox when it is Checked.

public StyleProp<TextureRegion> Checkmark

Field Value

StyleProp<TextureRegion>

DisabledColor

The color that the checkbox uses for drawing when it IsDisabled.

public StyleProp<Color> DisabledColor

Field Value

StyleProp<Color>

DisabledTexture

The texture that the checkbox uses when it IsDisabled. If this is null, it uses its default Texture.

public StyleProp<NinePatch> DisabledTexture

Field Value

StyleProp<NinePatch>

HoveredColor

The color that this checkbox uses for drawing when it is hovered.

public StyleProp<Color> HoveredColor

Field Value

StyleProp<Color>

HoveredTexture

The texture that this checkbox uses when it is hovered. If this is null, the default Texture is used.

public StyleProp<NinePatch> HoveredTexture

Field Value

StyleProp<NinePatch>

Label

The label Paragraph that displays next to this checkbox

public Paragraph Label

Field Value

Paragraph

OnCheckStateChange

An event that is invoked when this checkbox's Checked property changes

public Checkbox.CheckStateChange OnCheckStateChange

Field Value

Checkbox.CheckStateChange

Texture

The texture that this checkbox uses for drawing.

public StyleProp<NinePatch> Texture

Field Value

StyleProp<NinePatch>

Properties

CanBePressed

Set this field to false to disallow this element's OnPressed and OnSecondaryPressed events to be called.

public override bool CanBePressed { get; }

Property Value

bool

CanBeSelected

Set this field to false to disallow the element from being selected. An unselectable element is skipped by automatic navigation and its OnSelected callback will never be called.

public override bool CanBeSelected { get; }

Property Value

bool

Checked

Whether or not this checkbox is currently checked.

public bool Checked { get; set; }

Property Value

bool

IsDisabled

Set this property to true to mark the checkbox as disabled. A disabled checkbox cannot be moused over, selected or toggled.

public virtual bool IsDisabled { get; set; }

Property Value

bool

TextOffsetX

The width of the space between this checkbox and its Label

public StyleProp<float> TextOffsetX { get; set; }

Property Value

StyleProp<float>

Methods

Draw(GameTime, SpriteBatch, float, SpriteBatchContext)

Draws this element and all of its children. Override this method to draw the content of custom elements. Note that, when this is called, SpriteBatch.Begin has already been called with custom Transform etc. applied.

public override void Draw(GameTime time, SpriteBatch batch, float alpha, SpriteBatchContext context)

Parameters

time GameTime

The game's time

batch SpriteBatch

The sprite batch to use for drawing

alpha float

The alpha to draw this element and its children with

context SpriteBatchContext

The sprite batch context to use for drawing

InitStyle(UiStyle)

Initializes this element's StyleProp<T> instances using the ui system's UiStyle.

protected override void InitStyle(UiStyle style)

Parameters

style UiStyle

The new style

SetAreaAndUpdateChildren(RectangleF)

Sets this element's Area to the given RectangleF and invokes the OnElementAreaUpdated event. This method also updates all of this element's Children's areas. Note that this method does not take into account any auto-sizing, anchoring or positioning, and so it should be used sparingly, if at all.

public override void SetAreaAndUpdateChildren(RectangleF area)

Parameters

area RectangleF

See Also

ForceUpdateArea()