Detailed Description

A pair of two buttons, one incrementing and one decrementing a value.

Inheritance diagram for SpinButtons:

Public Types
enum	Orientation { VERTICAL, HORIZONTAL }

Public Types inherited from Widget
enum	Type { WIDGET, PANEL, BOX, LINE, FRAME, BUTTON, TOGGLEBUTTON, RADIOBUTTON, CHECKBOX, CHECKMARK, CROSSMARK, ARROW, TEXT, TEXTEDIT, RICHTEXTAREA, SCROLLBAR, SLIDER, COLORSLIDER, COLORWHEEL, KNOB, TREEVIEW, IMAGE, POPUP, LIST, LISTBOX, SELECTION, PROGRESSBAR, SCROLLCONTAINER, MENU, MENUPANEL, MENUBOX, TABBAR, TABCONTAINER, DIALOG, FOLDABLECONTAINER, COLORPICKER, COLORPICKERBUTTON, SPINBOX, SPINBUTTONS, ICONIMAGE, ICONSVG, DROPDOWNLIST, TOOLTIP, GRIDCELL, GRID, TABLE }

Public Member Functions
	SpinButtons (Orientation orientation=VERTICAL)

auto	getOrientation () const

void	setOrientation (Orientation orientation)

auto	getRepeatDelay () const

void	setRepeatDelay (const uint32 milliseconds)

auto	getRepeatInterval () const

void	setRepeatInterval (const uint32 milliseconds)

auto	getUpButton () const

auto	getDownButton () const

void	setResources (const std::string &resButton, const std::string &resArrow)

Public Member Functions inherited from Widget
	Widget (Type type=WIDGET)

	~Widget () override

Type	getType () const

bool	isVisible () const

void	setVisible (bool show=true)

bool	isEnabled () const

void	setEnabled (bool isEnabled=true)

virtual void	setPos (float x, float y)

float	getWidth () const

float	getHeight () const

float	getRequestedWidth () const

float	getRequestedHeight () const

virtual void	setSize (float width, float height)

void	setWidth (const float width)

void	setHeight (const float height)

const Rect &	getRect () const

void	setRect (float x, float y, float width, float height)

void	setRect (const Rect &rect)

float	getAspectRatio () const

Alignment	getAlignment () const

void	setAlignment (Alignment alignment)

std::shared_ptr< Font >	getFont () const

void	setFont (const std::shared_ptr< Font > &font)

float	getFontScale () const

virtual void	setFontScale (float fontScale)

bool	isFocused () const

Widget *	getParent () const

void	setOverlap (const bool overlap)

template<typename T , typename... Args>
std::shared_ptr< T >	create (const std::string &resource, const Alignment alignment, Args &&...args)

template<typename T , typename... Args>
std::shared_ptr< T >	create (const Alignment alignment, Args &&...args)

template<typename T >
std::shared_ptr< T >	add (std::shared_ptr< T > child, const Alignment alignment=Alignment::NONE, const std::string &resource="", const bool overlap=false)

template<typename T >
std::shared_ptr< T >	addPopup (std::shared_ptr< T > child, const std::string &resource="")

template<typename T >
std::shared_ptr< T >	addAfter (std::shared_ptr< T > child, const std::shared_ptr< Widget > &after, const Alignment alignment, const std::string &resource="", const bool overlap=false)

virtual void	remove (const std::shared_ptr< Widget > &child)

virtual void	removeAll ()

void	setPadding (float padding)

float	getPadding () const

float	getVBorder () const

float	getHBorder () const

void	setVBorder (float size)

void	setHBorder (float size)

bool	isDrawBackground () const

void	setDrawBackground (bool drawBackground)

bool	isPushed () const

bool	isPointed () const

bool	isFreezed () const

bool	isRedrawOnMouseEvent () const

bool	isOverlapping () const

Rect	getChildrenRect () const

void	setFreezed (const bool f)

void	setPushed (const bool p)

void	refresh ()

void	setResource (std::shared_ptr< UIResource > res)

uint32	getGroupIndex () const

void	setGroupIndex (int32 index)

template<typename T >
T	getUserData () const

template<typename T >
std::shared_ptr< T >	getPointerUserData () const

const std::any &	getUserData () const

void	setUserData (const std::any &data)

float	getTransparency () const

void	setTransparency (float alpha)

void	resizeChildren ()

float	getChildrenOffsetX () const

float	getChildrenOffsetY () const

void	setChildrenOffset (float x, float y)

std::shared_ptr< Widget >	setFocus (bool focus=true)

virtual void	onAttach ()

virtual void	onDetach ()

virtual void	onShow ()

virtual void	onHide ()

virtual void	onResize ()

virtual void	onMove ()

virtual bool	onKeyDown (Key key)

virtual bool	onTextInput (const std::string &text)

virtual bool	onKeyUp (Key key)

virtual bool	onMouseDown (MouseButton button, float x, float y)

virtual bool	onMouseUp (MouseButton button, float x, float y)

virtual bool	onMouseMove (uint32 buttonsState, float x, float y)

virtual void	onMouseLeave ()

virtual void	onDisable ()

virtual void	onEnable ()

virtual void	onGotFocus ()

virtual void	onLostFocus ()

bool	getConsumeMouseEvent () const

void	setConsumeMouseEvent (const bool consumeMouseEvent)

const std::list< std::shared_ptr< Widget > > &	getChildren () const

bool	hasChildren () const

void	subscribe (const event_type &type, unique_id id, EventHandlerCallback callback)

void	subscribe (const event_type &type, EventHandlerCallback callback)

void	unsubscribe (unique_id id)

bool	isAttached () const

Window &	getWindow () const

Style &	getStyle () const

Vector2DRenderer &	getRenderer () const

RenderingWindow &	getRenderingWindow () const

WindowManager &	getWindowManager () const

Static Public Attributes
static constexpr float	DEFAULT_WIDTH {16.0f}
	Default width of the column of the two buttons. More...

static constexpr uint32	DEFAULT_REPEAT_DELAY {400}
	Default delay in milliseconds before the first repetition of a button held down. More...

static constexpr uint32	DEFAULT_REPEAT_INTERVAL {60}
	Default delay in milliseconds between two repetitions of a button held down. More...

Additional Inherited Members
Protected Attributes inherited from Widget
const Type	type

Rect	rect

float	requestedWidth {0}

float	requestedHeight {0}

float	hborder {0}

float	vborder {0}

float	padding {0}

bool	consumeMouseEvent {false}

bool	overlap {false}

bool	focused {false}

bool	allowFocus {false}

bool	allowChildren {true}

bool	drawBackground {true}

bool	moveChildrenOnPush {false}

bool	scrollChildren {false}

bool	skipInvisibleChildren {false}

bool	redrawOnMouseEvent {false}

bool	redrawOnMouseMove {false}

float	transparency {1.0f}

Widget *	parent {nullptr}

Alignment	alignment {Alignment::NONE}

std::shared_ptr< UIResource >	resource

std::list< std::shared_ptr< Widget > >	children

bool	mouseMoveOnFocus {false}

float	childrenOffsetX {0}

float	childrenOffsetY {0}

Member Enumeration Documentation

enum Orientation

Placement of the two buttons.

Enum Values	Documentation
VERTICAL	The incrementing button is above the decrementing one.
HORIZONTAL	The incrementing button is at the right of the decrementing one.

Constructor & Destructor Documentation

SpinButtons ( Orientation orientation = VERTICAL )

Creates a pair of two buttons.

Member Function Documentation

auto getDownButton ( ) const

inline

Returns the button decrementing the value

auto getOrientation ( ) const

inline

Returns the placement of the two buttons

auto getRepeatDelay ( ) const

inline

Returns the delay in milliseconds before the first repetition of a button held down

auto getRepeatInterval ( ) const

inline

Returns the delay in milliseconds between two repetitions of a button held down

auto getUpButton ( ) const

inline

Returns the button incrementing the value

void setOrientation ( Orientation orientation )

Changes the placement of the two buttons

void setRepeatDelay ( const uint32 milliseconds )

inline

Changes the delay in milliseconds before the first repetition of a button held down

void setRepeatInterval ( const uint32 milliseconds )

inline

Changes the delay in milliseconds between two repetitions of a button held down, zero to only send a signal on each click

void setResources	(	const std::string &	resButton,
		const std::string &	resArrow
	)

Sets the UI resources of the widgets created by the pair of buttons.

Parameters

resButton	Resource for the two buttons.
resArrow	Resource for the arrows of the two buttons.

Member Data Documentation

constexpr uint32 DEFAULT_REPEAT_DELAY {400}

staticconstexpr

Default delay in milliseconds before the first repetition of a button held down.

constexpr uint32 DEFAULT_REPEAT_INTERVAL {60}

staticconstexpr

Default delay in milliseconds between two repetitions of a button held down.

constexpr float DEFAULT_WIDTH {16.0f}

staticconstexpr

Default width of the column of the two buttons.

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation