Class ColorPicker
Framework View
The tag name of this view is <color-picker>.
Definition
Namespace: StardewUI.Widgets
Assembly: StardewUI.dll
Drop-down style widget that opens a detailed color wheel/slider overlay for choosing a precise color.
Inheritance
Object ⇦ DecoratorView<T> ⇦ ComponentView<T> ⇦ ComponentView ⇦ ColorPicker
Members
Constructors
| Name | Description |
|---|---|
| ColorPicker() |
Properties
| Name | Description |
|---|---|
ActualBoundsactual-bounds |
The bounds of this view relative to the origin (0, 0). (Inherited from DecoratorView<T>) |
ClipOriginclip-origin |
Origin position for the ClipSize. (Inherited from DecoratorView<T>) |
ClipSizeclip-size |
Size of the clipping rectangle, outside which content will not be displayed. (Inherited from DecoratorView<T>) |
Colorcolor |
The current color. |
ContentBoundscontent-bounds |
The true bounds of this view's content; i.e. ActualBounds excluding margins. (Inherited from DecoratorView<T>) |
FloatingBoundsfloating-bounds |
Contains the bounds of all floating elements in this view tree, including the current view and all descendants. (Inherited from DecoratorView<T>) |
HoveredSubjecthovered-subject |
When Lookup Anything (Pathoschild.LookupAnything) is loaded, this Object or NPC subject is given to lookup anything for it's menu. (unofficial-mushymato)(Inherited from DecoratorView<T>) |
IsFocusableis-focusable |
Whether or not the view can receive controller focus, i.e. the stick/d-pad controlled cursor can move to this view. Not generally applicable for mouse controls. (Inherited from DecoratorView<T>) |
Layoutlayout |
The current layout parameters, which determine how Measure(Vector2) will behave. (Inherited from DecoratorView<T>) |
Namename |
Simple name for this view, used in log/debug output; does not affect behavior. (Inherited from DecoratorView<T>) |
Opacityopacity |
Opacity (alpha level) of the view. (Inherited from DecoratorView<T>) |
OuterSizeouter-size |
The true computed layout size resulting from a single Measure(Vector2) pass. (Inherited from DecoratorView<T>) |
PointerEventsEnabledpointer-events-enabled |
Whether this view should receive pointer events like Click or Drag. (Inherited from DecoratorView<T>) |
PointerStylepointer-style |
Pointer style to use when this view is hovered. (Inherited from DecoratorView<T>) |
Presetspresets |
Preset colors to show at the bottom, providing single click convenience for the most common colors. |
ScreenReadscreen-read |
When a screen reader mod (shoaib.stardewaccess) is loaded, this element will be announced by the screen reader using this value. (unofficial-mushymato)(Inherited from DecoratorView<T>) |
ScrollWithChildrenscroll-with-children |
If set to an axis, specifies that when any child of the view is scrolled into view (using ScrollIntoView(IEnumerable<ViewChild>, Vector2)), then this entire view should be scrolled along with it. (Inherited from DecoratorView<T>) |
Tagstags |
The user-defined tags for this view. (Inherited from DecoratorView<T>) |
Tooltiptooltip |
Tooltip data to display on hover, if any. (Inherited from DecoratorView<T>) |
Transformtransform |
Local transformation to apply to this view, including any children and floating elements. (Inherited from DecoratorView<T>) |
TransformOrigintransform-origin |
Relative origin position for any Transform on this view. (Inherited from DecoratorView<T>) |
Viewview |
(Inherited from ComponentView<T>) |
Visibilityvisibility |
Drawing visibility for this view. (Inherited from DecoratorView<T>) |
WheelSpritewheel-sprite |
Sprite to display for the Hue-Saturation color wheel. |
ZIndexz-index |
Z order for this view within its direct parent. Higher indices draw later (on top). (Inherited from DecoratorView<T>) |
Methods
| Name | Description |
|---|---|
| ContainsPoint(Vector2) | Checks if a given point, relative to the view's origin, is within its bounds. (Inherited from DecoratorView<T>) |
| CreateView() | Creates and returns the root view. (Overrides ComponentView<T>.CreateView()) |
| Dispose() | (Inherited from DecoratorView<T>) |
| Draw(ISpriteBatch) | Draws the content for this view. (Inherited from DecoratorView<T>) |
| FocusSearch(Vector2, Direction) | Finds the next focusable component in a given direction that does not overlap with a current position. (Inherited from DecoratorView<T>) |
| GetChildAt(Vector2, Boolean, Boolean) | Finds the child at a given position. (Inherited from DecoratorView<T>) |
| GetChildPosition(IView) | Computes or retrieves the position of a given direct child. (Inherited from DecoratorView<T>) |
| GetChildren(Boolean) | Gets the current children of this view. (Inherited from DecoratorView<T>) |
| GetChildrenAt(Vector2) | Finds all children at a given position. (Inherited from DecoratorView<T>) |
| GetDefaultFocusChild() | Gets the direct child that should contain cursor focus when a menu or overlay containing this view is first opened. (Inherited from DecoratorView<T>) |
| HasOutOfBoundsContent() | Checks if the view has content or elements that are all or partially outside the ActualBounds. (Inherited from DecoratorView<T>) |
| IsDirty() | Checks whether or not the view is dirty - i.e. requires a new layout with a full Measure(Vector2). (Inherited from DecoratorView<T>) |
| IsVisible(Vector2?) | Checks if the view is effectively visible, i.e. if it has anything to draw. (Inherited from DecoratorView<T>) |
| Measure(Vector2) | Performs layout on this view, updating its OuterSize, ActualBounds and ContentBounds, and arranging any children in their respective positions. (Inherited from DecoratorView<T>) |
| OnButtonPress(ButtonEventArgs) | Called when a button press is received while this view is in the focus path. (Inherited from DecoratorView<T>) |
| OnButtonRepeat(ButtonEventArgs) | Called when a button press is first received, and at recurring intervals thereafter, for as long as the button is held and this view remains in the focus path. (Inherited from DecoratorView<T>) |
| OnClick(ClickEventArgs) | Called when a click is received within this view's bounds. (Inherited from DecoratorView<T>) |
| OnDrag(PointerEventArgs) | Called when the view is being dragged (mouse moved while left button held). (Inherited from DecoratorView<T>) |
| OnDrop(PointerEventArgs) | Called when the mouse button is released after at least one OnDrag(PointerEventArgs). (Inherited from DecoratorView<T>) |
| OnLayout() | Runs whenever layout occurs as a result of the UI elements changing. (Inherited from DecoratorView<T>) |
| OnPointerMove(PointerMoveEventArgs) | Called when a pointer movement related to this view occurs. (Inherited from DecoratorView<T>) |
| OnPropertyChanged(PropertyChangedEventArgs) | Raises the PropertyChanged event. (Inherited from DecoratorView<T>) |
| OnPropertyChanged(string) | Raises the PropertyChanged event. (Inherited from DecoratorView<T>) |
| OnUpdate(TimeSpan) | Runs on every update tick. (Inherited from DecoratorView<T>) |
| OnWheel(WheelEventArgs) | Called when a wheel event is received within this view's bounds. (Inherited from DecoratorView<T>) |
| RegisterDecoratedProperty<TValue>(DecoratedProperty<T, TValue>) | Registers a DecoratedProperty<T, TValue>. (Inherited from DecoratorView<T>) |
| ScrollIntoView(IEnumerable<ViewChild>, Vector2) | Attempts to scroll the specified target into view, including all of its ancestors, if not fully in view. (Inherited from DecoratorView<T>) |
Events
| Name | Description |
|---|---|
| ButtonPress | Event raised when any button on any input device is pressed. (Inherited from DecoratorView<T>) |
| ButtonRepeat | Event raised when a button is being held while the view is in focus, and has been held long enough since the initial ButtonPress or the previous ButtonRepeat to trigger a repeated press.(Inherited from DecoratorView<T>) |
| Change | Event raised when the selected color changes. |
| Click | Event raised when the view receives a click initiated from any button. (Inherited from DecoratorView<T>) |
| Drag | Event raised when the view is being dragged using the mouse. (Inherited from DecoratorView<T>) |
| DragEnd | Event raised when mouse dragging is stopped, i.e. when the button is released. Always raised after the last Drag, and only once per drag operation. (Inherited from DecoratorView<T>) |
| DragStart | Event raised when mouse dragging is first activated. Always raised before the first Drag, and only once per drag operation. (Inherited from DecoratorView<T>) |
| LeftClick | Event raised when the view receives a click initiated from the left mouse button, or the controller's action button (A). (Inherited from DecoratorView<T>) |
| PointerEnter | Event raised when the pointer enters the view. (Inherited from DecoratorView<T>) |
| PointerLeave | Event raised when the pointer exits the view. (Inherited from DecoratorView<T>) |
| PointerMove | Event raised when the pointer moves within the view. (Inherited from DecoratorView<T>) |
| PropertyChanged | (Inherited from DecoratorView<T>) |
| RightClick | Event raised when the view receives a click initiated from the right mouse button, or the controller's tool-use button (X). (Inherited from DecoratorView<T>) |
| Wheel | Event raised when the scroll wheel moves. (Inherited from DecoratorView<T>) |
Details
Constructors
ColorPicker()
Properties
Color
The current color.
Property Value
Presets
Preset colors to show at the bottom, providing single click convenience for the most common colors.
public System.Collections.Generic.IReadOnlyList<Microsoft.Xna.Framework.Color> Presets { get; set; }
Property Value
WheelSprite
Sprite to display for the Hue-Saturation color wheel.
Property Value
Methods
CreateView()
Creates and returns the root view.
Returns
Events
Change
Event raised when the selected color changes.