AbstractTextButton Class Reference

The base class for all buttons that have text. More...

#include <button.hpp>

Inheritance diagram for AbstractTextButton:

Public Member Functions
virtual	~AbstractTextButton ()
virtual void	setText (const char *text)=0
virtual const char *	text () const =0
virtual bool	isTextDirty () const =0
virtual void	resetText ()=0
Public Member Functions inherited from AbstractButton
virtual	~AbstractButton ()
virtual void	setPressed (bool pressed)=0
bool	isPressed () const
bool	isNotPressed () const
bool	isClicked () const
virtual void	waitUntilReleased () const
virtual void	waitUntilPressed () const
virtual void	waitUntilClicked () const
Public Member Functions inherited from Sensor< bool >
virtual	~Sensor ()
virtual bool	value () const =0

Detailed Description

The base class for all buttons that have text.

Provides methods to access and manipulate the button's text

Constructor & Destructor Documentation

virtual AbstractTextButton::~AbstractTextButton ( )

virtual

Member Function Documentation

virtual bool AbstractTextButton::isTextDirty ( ) const

pure virtual

Determines whether or not the text has been recently changed.

Note

This function will only return dirty once per change

Attention

User code should not call this method on system buttons.

Implemented in IdButton.

virtual void AbstractTextButton::resetText ( )

pure virtual

Resets the button's text to the default for that button. For example, the A button would be reset to "A"

Implemented in IdButton.

virtual void AbstractTextButton::setText ( const char *  text )

pure virtual

Sets the button's current text Strings over 16 bytes will be trancated.

See also

text

Implemented in IdButton.

virtual const char* AbstractTextButton::text ( ) const

pure virtual

Gets the button's current text

Returns

Null terminated text that will not exceed 16 bytes

See also

setText

Implemented in IdButton.

---

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

• include/kovan/button.hpp