Text input component (single-line) More...

#include <ofxOuiTextInput.hpp>

Inheritance diagram for ofxOui::TextInput:

Collaboration diagram for ofxOui::TextInput:

Classes
class	TextInputEvent
	Event arguments for text editing events. More...

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

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

virtual	~TextInput ()
	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
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	mouseMoved (ofMouseEventArgs &e)

void	mouseDragged (ofMouseEventArgs &e)

void	mousePressed (ofMouseEventArgs &e)

void	mouseReleased (ofMouseEventArgs &e)

void	keyPressed (ofKeyEventArgs &e)

virtual void	drawBackground ()

virtual void	drawFrame ()

virtual void	drawIcon ()

Protected Attributes
bool	erase_on_next_input_

std::function< void(TextInput::TextInputEvent &)>	text_input_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

Text input component (single-line)

Constructor & Destructor Documentation

§ TextInput()

ofxOui::TextInput::TextInput	(	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

§ ~TextInput()

ofxOui::TextInput::~TextInput ( )

virtual

Destructor.

Member Function Documentation

§ 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::TextInput::drawLabel ( )

protectedvirtual

Reimplemented from ofxOui::Component.

§ 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::TextInput::keyPressed ( ofKeyEventArgs & e )

protected

§ mouseDragged()

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

protected

§ mouseMoved()

void ofxOui::TextInput::mouseMoved ( ofMouseEventArgs & e )

protected

§ mousePressed()

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

protected

§ mouseReleased()

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

protected

§ onTextInput()

template<typename T , typename args , class ListenerClass >

void ofxOui::TextInput::onTextInput	(	T *	owner,
		void(ListenerClass::*)(args)	listenerMethod
	)

inline

Set callback function for text input 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::Component::update ( )

virtualinherited

OF-like update function.

Reimplemented in ofxOui::Waveform, ofxOui::Bpf, ofxOui::MultiSlider, ofxOui::Matrix, ofxOui::Button, ofxOui::DropDown, ofxOui::Numbox, and 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)

§ erase_on_next_input_

bool ofxOui::TextInput::erase_on_next_input_

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)

§ 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

§ text_input_event_callback_

std::function<void(TextInput::TextInputEvent &)> ofxOui::TextInput::text_input_event_callback_

protected

§ type_

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

protectedinherited

§ 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)

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

§ TextInput()

§ ~TextInput()

Member Function Documentation

§ draw()

§ drawBackground()

§ drawFrame()

§ drawIcon()

§ drawLabel()

§ inside()

§ keyPressed()

§ mouseDragged()

§ mouseMoved()

§ mousePressed()

§ mouseReleased()

§ onTextInput()

§ type()

§ update()

Member Data Documentation

§ active

§ blocking_component

§ current_background_color_

§ current_frame_color_

§ disabled

§ erase_on_next_input_

§ font

§ height

§ hover_

§ icon

§ labelOff

§ labelOn

§ shape

§ style

§ text_input_event_callback_

§ type_

§ width

§ x

§ y