Control::State Struct Reference

Internal state. More...

#include <Control>

Inheritance diagram for Control::State:

Public Member Functions
void	grabFocus ()
void	releaseFocus ()
virtual Control	delegate () const
	Specific child control to cascade all input events to.
virtual bool	cascade () const
	Allow input events to cascade to any child control.
virtual Rect	textInputArea () const
virtual void	onTextEdited (const String &text, int start, int length)
virtual void	onTextInput (const String &text)
Control	self () const
void	onClicked (Function< void()> &&f)
Public Member Functions inherited from View::State
	~State ()
	Virtual destructor.
const char *	objectName () const
	Get the object name (for debugging)
void	objectName (const char *name)
	Set the object name
bool	hasParent () const
	Check if this view has a parent
View	parent () const
	Get the parent.
const Set< View > &	children () const
	Get set of all children.
const Set< View > &	visibleChildren () const
	Get set of visible children.
void	attach (const Object &other)
	Attach a non-visual object (e.g.
void	attach (Function< void()> &&f)
	Convenience method for attaching a monitor.
void	deplete ()
	Remove all children.
double	x () const
	Get pos().x()
double	y () const
	Get pos().y()
double	width () const
	Get width.
double	height () const
	Get height.
double	innerWidth () const
	Get inner width.
double	innerHeight () const
	Get inner height.
Layout	layout () const
	Get the layout.
double	expandableWidth (double width) const
	Get the expandable width of this view within its parent layout.
double	top () const
	Get y-coordinate of this view's top border.
double	bottom () const
	Get y-coordinate of this view's bottom border.
double	left () const
	Get x-coordinate of this view's left border.
double	right () const
	Get x-coordinate of this view's right border.
Point	topLeft () const
	Get this view's top-left corner.
Point	topCenter () const
	Get this view's top-center point.
Point	topRight () const
	Get this view's top-right corner.
Point	bottomLeft () const
	Get this view's bottom-left corner.
Point	bottomCenter () const
Point	bottomRight () const
	Get this view's bottom-right corner.
Point	centerLeft () const
	Get this view's center-left point.
Point	centerRight () const
	Get this view's center-right point.
void	topLeft (Point newValue)
	Get this view's top-left corner.
void	topCenter (Point newValue)
	Get this view's top-center point.
void	topRight (Point newValue)
	Get this view's top-right corner.
void	bottomLeft (Point newValue)
	Get this view's bottom-left corner.
void	bottomCenter (Point newValue)
	Get this view's bottom-center point.
void	bottomRight (Point newValue)
	Get this view's bottom-right corner.
void	centerLeft (Point newValue)
	Get this view's center-left point.
void	centerRight (Point newValue)
	Get this view's center-right point.
void	center (Point newValue)
	Make this view's center match newValue.
void	topLeft (Definition< Point > &&a)
	Get this view's top-left corner.
void	topCenter (Definition< Point > &&a)
	Get this view's top-center point.
void	topRight (Definition< Point > &&a)
	Get this view's top-right corner.
void	bottomLeft (Definition< Point > &&a)
	Get this view's bottom-left corner.
void	bottomCenter (Definition< Point > &&a)
	Get this view's bottom-center point.
void	bottomRight (Definition< Point > &&a)
	Get this view's bottom-right corner.
void	centerLeft (Definition< Point > &&a)
	Get this view's center-left point.
void	centerRight (Definition< Point > &&a)
	Get this view's center-right point.
void	center (Definition< Point > &&a)
	Make this view's center match newValue.
void	centerInParent ()
	Anchor this view's center to its parent's center.
void	layout (const Layout &newValue)
	Set the layout
Point	mapToGlobal (Point l) const
	Map view coordinates l to window coordinates
Point	mapToLocal (Point g) const
	Map window coordinates g to view coordinates
Point	mapToChild (const View &child, Point l) const
	Map local coordinates l to child coordinates
Point	mapToParent (const View &parent, Point l) const
	Map local coordinates l to parent coordinates
View	findChild (Point l) const
	Find the first child which contains local point l.
Control	findControl (Point l) const
	Find the first control which contains local point l.
bool	isParentOf (const View &other) const
	Check if this view is parent of other.
bool	laysInsideOf (const View &other, double margin=0.) const
	Check if this view is fully visible inside other with given surrounding margin.
virtual Size	preferredSize () const
	Get preferred size.
virtual Size	minSize () const
	Get minimal size.
virtual Size	maxSize () const
	Get maximal size.
virtual bool	isOpaque () const
	Tells the graphics engine if all pixels of this view are fully opaque.
virtual bool	isPainted () const
	Tells the graphics engine if this view has visible pixels.
virtual bool	isStatic () const
	Tells the graphics engine if this view is static (i.e. is not changing with each frame)
virtual bool	isPremultiplied () const
	Tells the underlying image contains a color tuple with premultiplied alpha.
Color	basePaper () const
	Search upwards in the view hierarchy for the first valid background color
virtual bool	withinBounds (Point l) const
	Check if local point l is inside this view.
bool	containsLocal (Point l) const
	Check if local point l lays inside this view.
bool	containsGlobal (Point g) const
	Check if global point l lays inside this view.
virtual void	childReady (InOut< View > child)
	Called when a new child has been added.
virtual void	childDone (InOut< View > child)
	Called after a child had been removed.
virtual void	settled ()
	Called on the child after it has been added (ideal place for setting up easing behavior / transitions)
void	add (const View &child)
	Add new child placed visually above all existing children.
void	addAbove (const View &child)
	Add new child placed visually above all existing children.
void	addBelow (const View &child)
	Add child place visually below all existing children.
void	insertAt (Locator target, View child)
	Insert new child at target.
void	insertAt (long index, const View &child)
	Insert new child at index.
void	remove (const View &child)
	Remove a child.
virtual void	insertChild (View child)
	Handles the insertion of new children.
virtual void	removeChild (View child)
	Handles the removal of children.
void	moveToTop ()
	Make this view be visible above any other visible sibling.
void	moveToBottom ()
	Make this view be visible beneath any other visible sibling.
void	moveToTop (View child)
	Make child visible above all its siblings.
void	moveToBottom (View child)
	Make child visible beneath all its siblings.
Image &	image ()
	Painting target.
void	image (const Image &newValue)
	Set painting target
View	self () const
	Get a view from this state.
bool	hasWindow () const
Window	window () const
	Check if this view is already shown in a window.
bool	sizing () const
	Window is currently undergoing size change
bool	isHandheld () const
	Get window().display().isHandheld()
void	clear (Color color)
void	clear ()
void	polish () override

Public Attributes
Property< Cursor >	cursor
	Pointer cursor when the pointer is over this control
Property< bool >	hover
	Pointer is currently hovering over this control
Property< bool >	pressed
	Control is currently pressed by the user
Property< bool >	pressedOverwrite
Property< bool >	focus
	Control has text input focus
Property< Point >	pointerPos
	Pointer position when hovered, pressed or clicked
Event< PointerEvent >	onPointerClicked
	Control has been pressed and released
Event< MouseEvent >	onMouseClicked
	Control has been clicked by the mouse
Event< FingerEvent >	onFingerClicked
	Control has been pressed and released by a touch input
Public Attributes inherited from View::State
Property< void >	paint
	Painting monitor
Property< Color >	paper
	Background color
Property< bool >	visible { true }
	Visiblity
Property< double >	opacity { 1. }
	Opacity (0: fully transparent, 1: fully opaque)
Property< bool >	clip { false }
	Clip children views
Property< bool >	moving { false }
Property< Point >	pos
	Position within its parent
Property< Size >	size
	Size of this view
Property< Padding >	padding
	Padding to apply when adding this view to a layout
Property< Point >	pivot
	Rotation center
Property< double >	angle { 0 }
	Rotation angle
Property< double >	scale { 1 }
	Zoom factor
Property< long >	childrenCount { 0 }
	Number of children
Property< View >	decoration
Trigger	onWindowEntered
	Triggered when the pointer enters the window.
Trigger	onWindowLeft
	Triggered when the pointer leaves the window.
Event< PointerEvent >	onPointerPressed
	Pointing device is pressed over this view
Event< PointerEvent >	onPointerReleased
	Pointing device is released over this view
Event< PointerEvent >	onPointerMoved
	Pointer moved over this view
Event< MouseEvent >	onMousePressed
	Mouse is pressed over this view
Event< MouseEvent >	onMouseReleased
	Mouse is released over this view
Event< MouseEvent >	onMouseMoved
	Mouse moved over this view
Event< FingerEvent >	onFingerPressed
	Finger contact started over this view
Event< FingerEvent >	onFingerReleased
	Finger contact ended over this view
Event< FingerEvent >	onFingerMoved
	Finger contact moved over this view
Event< WheelEvent >	onWheelMoved
	Mouse wheel is moved
Event< KeyEvent >	onKeyPressed
	Keyboard key is pressed
Event< KeyEvent >	onKeyReleased
	Keyboard key is released

Additional Inherited Members
Protected Member Functions inherited from View::State
Id	nextAboveId () const
Id	nextBelowId () const
cairo_surface_t *	cairoSurface () override
void	update (UpdateReason reason)
virtual bool	feedExposedEvent () const
virtual bool	feedEnterEvent () const
virtual bool	feedLeaveEvent () const
virtual bool	feedFingerEvent (FingerEvent &event) const
virtual bool	feedMouseEvent (MouseEvent &event) const
virtual bool	feedWheelEvent (WheelEvent &event) const
virtual bool	feedKeyEvent (KeyEvent &event) const
Protected Attributes inherited from View::State
Id	id_ { std::numeric_limits<double>::quiet_NaN() }
const char *	objectName_ { "" }
Property< View::State * >	parent_ { nullptr }
Property< Object::State * >	window_
Property< Layout >	layout_
Property< double >	width_
Property< double >	height_
Set< View >	children_
Set< View >	visibleChildren_
List< Object >	attachments_
Image	image_
Object	context_
void *	trackingHandle_ { nullptr }

Detailed Description

Internal state.

Member Function Documentation

delegate()

Control delegate ( ) const

virtual

Specific child control to cascade all input events to.

cascade()

virtual bool cascade ( ) const

virtual

Allow input events to cascade to any child control.

onClicked()

void onClicked

(

Function< void()> &&

f

)

Parameters

f

Member Data Documentation

cursor

Property<Cursor> cursor

Pointer cursor when the pointer is over this control

hover

Property<bool> hover

Pointer is currently hovering over this control

pressed

Property<bool> pressed

Control is currently pressed by the user

focus

Property<bool> focus

Control has text input focus

pointerPos

Property<Point> pointerPos

Pointer position when hovered, pressed or clicked

onPointerClicked

Event<PointerEvent> onPointerClicked

Control has been pressed and released

onMouseClicked

Event<MouseEvent> onMouseClicked

Control has been clicked by the mouse

onFingerClicked

Event<FingerEvent> onFingerClicked

Control has been pressed and released by a touch input