Number box (with mouse + keyboard interaction, C74 max style) More...

#include <ofxOuiNumbox.hpp>

Inheritance diagram for ofxOui::Numbox:

Collaboration diagram for ofxOui::Numbox:

Classes
class	ValueEvent
	Event arguments for value editing events. More...

Public Member Functions
template<typename T , typename args , class ListenerClass >
void	onEditValue (T owner, void(ListenerClass::listenerMethod)(args))
	Set callback function for value editing events. More...

	Numbox (int x_=0, int y_=0, int width_=0, int height_=0)
	Constructor. More...

virtual	~Numbox ()
	Destructor. More...

virtual void	update ()
	OF-like update function. More...

virtual void	draw ()
	OF-like draw function. More...

virtual bool	inside (float x_, float y_) const
	checks if a point is inside the component (depending on the shape) More...

Type	type () const
	get the type of the component More...

Public Attributes
float	value
	value of the number box More...

float	min
	minimum value More...

float	max
	maximum value More...

int	precision
	precision of the number display More...

Shape	shape = ofxOui::Shape::Rectangle
	shape of the component More...

Style	style = ofxOui::Style::Default
	style of the component More...

TextBox	font
	textbox for the main label of the component More...

Icon	icon
	icon box of the component More...

float	x
	x position (left) More...

float	y
	y position(top) More...

float	width
	component width More...

float	height
	component height More...

string	labelOn = ""
	Label of the component (active) More...

string	labelOff = ""
	Label of the component (not active) More...

bool	disabled = false
	specifies if the component should be in "disabled" mode (no interaction) More...

bool	active = false
	specifies if the component is active More...

Protected Member Functions
virtual void	drawLabel ()

void	clipValue ()

virtual void	mouseDragged (ofMouseEventArgs &e)

virtual void	mousePressed (ofMouseEventArgs &e)

virtual void	mouseReleased (ofMouseEventArgs &e)

virtual void	keyPressed (ofKeyEventArgs &e)

virtual void	drawBackground ()

virtual void	drawFrame ()

virtual void	drawIcon ()

Protected Attributes
bool	dragging_

string	user_input_

int	y_pressed_

float	value_pressed_

TextBox	value_text_

float	drag_step_

std::function< void(Numbox::ValueEvent &)>	numbox_event_callback_

Type	type_ = ofxOui::Type::Label

bool	hover_ = false

ofColor	current_background_color_

ofColor	current_frame_color_

Static Protected Attributes
static Component *	blocking_component = nullptr

Detailed Description

Number box (with mouse + keyboard interaction, C74 max style)

Constructor & Destructor Documentation

§ Numbox()

ofxOui::Numbox::Numbox	(	int	x_ = `0`,
		int	y_ = `0`,
		int	width_ = `0`,
		int	height_ = `0`
	)

Constructor.

Parameters

x_	x position (left)
y_	y position (top)
width_	component width
height_	component height

§ ~Numbox()

ofxOui::Numbox::~Numbox ( )

virtual

Destructor.

Member Function Documentation

§ clipValue()

void ofxOui::Numbox::clipValue ( )

protected

§ draw()

void ofxOui::Component::draw ( )

virtualinherited

OF-like draw function.

this method is subdivided in protected sub-methods that can be overloaded in inherited components

Reimplemented in ofxOui::Matrix, and ofxOui::DropDown.

§ drawBackground()

void ofxOui::Component::drawBackground ( )

protectedvirtualinherited

§ drawFrame()

void ofxOui::Component::drawFrame ( )

protectedvirtualinherited

§ drawIcon()

void ofxOui::Component::drawIcon ( )

protectedvirtualinherited

Reimplemented in ofxOui::CheckBox.

§ drawLabel()

void ofxOui::Numbox::drawLabel ( )

protectedvirtual

Reimplemented from ofxOui::Component.

Reimplemented in ofxOui::Slider.

§ inside()

bool ofxOui::Component::inside	(	float	x_,
		float	y_
	)		const

virtualinherited

checks if a point is inside the component (depending on the shape)

Returns: true if the point of coordinates (x, y) is inside the component

§ keyPressed()

void ofxOui::Numbox::keyPressed ( ofKeyEventArgs & e )

protectedvirtual

§ mouseDragged()

void ofxOui::Numbox::mouseDragged ( ofMouseEventArgs & e )

protectedvirtual

Reimplemented in ofxOui::Slider.

§ mousePressed()

void ofxOui::Numbox::mousePressed ( ofMouseEventArgs & e )

protectedvirtual

Reimplemented in ofxOui::Slider.

§ mouseReleased()

void ofxOui::Numbox::mouseReleased ( ofMouseEventArgs & e )

protectedvirtual

§ onEditValue()

template<typename T , typename args , class ListenerClass >

void ofxOui::Numbox::onEditValue	(	T *	owner,
		void(ListenerClass::*)(args)	listenerMethod
	)

inline

Set callback function for value editing events.

Parameters

owner	pointer to the owner object
listenerMethod	method to be called on eaech event

Template Parameters

T	type of the owner object
args	arguments of the callback function
ListenerClass	class to which the listener method belongs

§ type()

Type ofxOui::Component::type ( ) const

inlineinherited

get the type of the component

Returns: type of the component

§ update()

void ofxOui::Numbox::update ( )

virtual

OF-like update function.

Reimplemented from ofxOui::Component.

Reimplemented in ofxOui::Slider.

Member Data Documentation

§ active

bool ofxOui::Component::active = false

inherited

specifies if the component is active

§ blocking_component

ofxOui::Component * ofxOui::Component::blocking_component = nullptr

staticprotectedinherited

§ current_background_color_

ofColor ofxOui::Component::current_background_color_

protectedinherited

§ current_frame_color_

ofColor ofxOui::Component::current_frame_color_

protectedinherited

§ disabled

bool ofxOui::Component::disabled = false

inherited

specifies if the component should be in "disabled" mode (no interaction)

§ drag_step_

float ofxOui::Numbox::drag_step_

protected

§ dragging_

bool ofxOui::Numbox::dragging_

protected

§ font

TextBox ofxOui::Component::font

inherited

textbox for the main label of the component

§ height

float ofxOui::Component::height

inherited

component height

§ hover_

bool ofxOui::Component::hover_ = false

protectedinherited

§ icon

Icon ofxOui::Component::icon

inherited

icon box of the component

§ labelOff

string ofxOui::Component::labelOff = ""

inherited

Label of the component (not active)

§ labelOn

string ofxOui::Component::labelOn = ""

inherited

Label of the component (active)

§ max

float ofxOui::Numbox::max

maximum value

§ min

float ofxOui::Numbox::min

minimum value

§ numbox_event_callback_

std::function<void(Numbox::ValueEvent &)> ofxOui::Numbox::numbox_event_callback_

protected

§ precision

int ofxOui::Numbox::precision

precision of the number display

§ shape

Shape ofxOui::Component::shape = ofxOui::Shape::Rectangle

inherited

shape of the component

§ style

Style ofxOui::Component::style = ofxOui::Style::Default

inherited

style of the component

§ type_

Type ofxOui::Component::type_ = ofxOui::Type::Label

protectedinherited

§ user_input_

string ofxOui::Numbox::user_input_

protected

§ value

float ofxOui::Numbox::value

value of the number box

§ value_pressed_

float ofxOui::Numbox::value_pressed_

protected

§ value_text_

TextBox ofxOui::Numbox::value_text_

protected

§ width

float ofxOui::Component::width

inherited

component width

§ x

float ofxOui::Component::x

inherited

x position (left)

§ y

float ofxOui::Component::y

inherited

y position(top)

§ y_pressed_

int ofxOui::Numbox::y_pressed_

protected

The documentation for this class was generated from the following files:

ofxOui - UI Components for OpenFrameworks

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

§ Numbox()

§ ~Numbox()

Member Function Documentation

§ clipValue()

§ draw()

§ drawBackground()

§ drawFrame()

§ drawIcon()

§ drawLabel()

§ inside()

§ keyPressed()

§ mouseDragged()

§ mousePressed()

§ mouseReleased()

§ onEditValue()

§ type()

§ update()

Member Data Documentation

§ active

§ blocking_component

§ current_background_color_

§ current_frame_color_

§ disabled

§ drag_step_

§ dragging_

§ font

§ height

§ hover_

§ icon

§ labelOff

§ labelOn

§ max

§ min

§ numbox_event_callback_

§ precision

§ shape

§ style

§ type_

§ user_input_

§ value

§ value_pressed_

§ value_text_

§ width

§ x

§ y

§ y_pressed_