Class ColorPicker

The ColorPicker View Color picker.
Inheritance
System.Object
Responder
View
ColorPicker
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
Inherited Members
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class ColorPicker : View

Constructors

ColorPicker()

Initializes a new instance of ColorPicker.
Declaration
public ColorPicker()

ColorPicker(ustring)

Initializes a new instance of ColorPicker.
Declaration
public ColorPicker(ustring title)
Parameters
Type Name Description
NStack.ustring title Title.

ColorPicker(Int32, Int32, ustring)

Initializes a new instance of ColorPicker.
Declaration
public ColorPicker(int x, int y, ustring title)
Parameters
Type Name Description
System.Int32 x X location.
System.Int32 y Y location.
NStack.ustring title Title

ColorPicker(Point, ustring)

Initializes a new instance of ColorPicker.
Declaration
public ColorPicker(Point point, ustring title)
Parameters
Type Name Description
Point point Location point.
NStack.ustring title Title.

Properties

Cursor

Cursor for the selected color.
Declaration
public Point Cursor { get; set; }
Property Value
Type Description
Point

SelectedColor

Selected color.
Declaration
public Color SelectedColor { get; set; }
Property Value
Type Description
Color

Methods

MouseEvent(MouseEvent)

Method invoked when a mouse event is generated
Declaration
public override bool MouseEvent(MouseEvent me)
Parameters
Type Name Description
MouseEvent me
Returns
Type Description
System.Boolean true, if the event was handled, false otherwise.
Overrides

MoveDown()

Moves the selected item index to the next row.
Declaration
public virtual bool MoveDown()
Returns
Type Description
System.Boolean

MoveLeft()

Moves the selected item index to the previous column.
Declaration
public virtual bool MoveLeft()
Returns
Type Description
System.Boolean

MoveRight()

Moves the selected item index to the next column.
Declaration
public virtual bool MoveRight()
Returns
Type Description
System.Boolean

MoveUp()

Moves the selected item index to the previous row.
Declaration
public virtual bool MoveUp()
Returns
Type Description
System.Boolean

ProcessKey(KeyEvent)

If the view is focused, gives the view a chance to process the keystroke.
Declaration
public override bool ProcessKey(KeyEvent kb)
Parameters
Type Name Description
KeyEvent kb
Returns
Type Description
System.Boolean
Overrides
Remarks

Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process.

The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses.

Redraw(Rect)

Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
Declaration
public override void Redraw(Rect bounds)
Parameters
Type Name Description
Rect bounds The bounds (view-relative region) to redraw.
Overrides
Remarks

Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative).

Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver.

Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter.

Events

ColorChanged

Fired when a color is picked.
Declaration
public event Action ColorChanged
Event Type
Type Description
System.Action

Implements

System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize