LCDBigNumber Class Reference
[Widgets]

#include "api/LCDBigNumber.h"

Inheritance diagram for LCDBigNumber:

[legend]Collaboration diagram for LCDBigNumber:

[legend]List of all members.

---

Detailed Description

This widget is used to display a big number (size is 3*4 characters) somewhere on screen.

Examples:

client.cpp.

Definition at line 13 of file LCDBigNumber.h.

Public Types
typedef std::list< std::string >	ParameterList
	A list of parameters for set method.
Public Member Functions
	LCDBigNumber (LCDElement *parent=0, const std::string &id="")
	Default Constructor.
	LCDBigNumber (int number, int x=1, LCDElement *parent=0, const std::string &id="")
	Constructor with widget values specified.
void	setNumberPosition (int position)
	Set which number should be used for the widget.
void	set (int number, int x)
	Set the values for the widget.
void	setNumber (int number)
	Set the value for the widget.
int	getNumber () const
	Get the value for the widget.
void	move (int x, int y=1)
	Move the widget to a new location.
void	set (const ParameterList &pList)
	Generic method to set widget parameter.
void	add (LCDElement *child)
	Add a child to the component.
const std::string &	getId ()
	Returns Id of the element.
Static Public Member Functions
bool	exists (std::string id)
	Test if a widget with given Id exists.
Static Public Attributes
const int	LCD_COLON = 10
	Represents a column.

---

Member Typedef Documentation

typedef std::list<std::string> ParameterList [inherited]

This is a list containing strings. Each string corresponds to a parameter. Definition at line 42 of file LCDWidget.h.

---

Constructor & Destructor Documentation

LCDBigNumber (  LCDElement *  parent = 0, const std::string &  id = "" )

This constructor can be used without parameter in most cases. But the widget will have to be added to a parent (screen or frame). Parameters: parent  A pointer to parent of this screen. It should be a LCDClient object. id  A string with the identifier for the screen. If not provided, a unique one will be generated automatically. Definition at line 9 of file LCDBigNumber.cpp.

LCDBigNumber (  int  number, int  x = 1, LCDElement *  parent = 0, const std::string &  id = "" )

This construct can be used to specify the values for the widget while building it. Parameters: number  An integer containing the number to be displayed. You can use special value LCD_COLON to display a colon. x  Integer containing 1-based value for column number. parent  A pointer to parent of this screen. It should be a LCDClient object. id  A string with the identifier for the screen. If not provided, a unique one will be generated automatically. Definition at line 15 of file LCDBigNumber.cpp.

---

Member Function Documentation

void add (  LCDElement *  child  )  [inherited]

This method is used to add a child to a component. Parameters: child  The element to be added in the children list. Examples: client.cpp. Definition at line 110 of file LCDElement.cpp.

bool exists (  std::string  id  )  [static, inherited]

This static method is used to test the existence of a widget. Parameters: id  The identifier of the widget to test. Definition at line 76 of file LCDElement.cpp.

const string & getId (   )  [inherited]

With this method one can have read access to the element identifier. Returns: A string. Definition at line 82 of file LCDElement.cpp.

int getNumber (   )  const

Get the number displayed by this widget. Returns: An integer containing the number that is displayed. Returns LCD_COLON if it is a colon. Definition at line 50 of file LCDBigNumber.cpp.

void move (  int  x, int  y = 1 )  [inherited]

Change the coordinate of a widget. Even if all the widgets have this method, it won't have an effect on all of them. Parameters: x  Integer containing 1-based value for column number. y  Integer containing 1-based value for row number. See also: LCDScreen::setCursorPosition Examples: client.cpp. Definition at line 22 of file LCDWidget.cpp.

void set (  const ParameterList &  pList  )  [inherited]

This method can be used to set all parameters of a widget. You should know the ones that are used by the protocol to put all of them in correct order. Parameters: pList  A list of all the parameters values. Definition at line 34 of file LCDWidget.cpp.

void set (  int  number, int  x )

Set or change the useful values for this widget. Parameters: number  An integer containing the number to be displayed. You can use special value LCD_COLON to display a colon. x  Integer containing 1-based value for column number. Examples: client.cpp. Definition at line 37 of file LCDBigNumber.cpp.

void setNumber (  int  number  )

Set or change the number displayed by this widget. Parameters: number  An integer containing the number to be displayed. You can use special value LCD_COLON to display a colon. Definition at line 44 of file LCDBigNumber.cpp.

void setNumberPosition (  int  position  )

Useful when using with a sensor returning a number with more than one digit. You can choose which one should be used to change the value of the widget. Number 1 is on right (less significant digit). Parameters: position  The position to use in the sensor value. Examples: client.cpp. Definition at line 21 of file LCDBigNumber.cpp.

---

Member Data Documentation

const int LCD_COLON = 10 [static]

Can be used as a value for this widget. It will then display a big colon character wich size is 1*4. Definition at line 7 of file LCDBigNumber.cpp.

---