LCDWidget Class Reference
[Widgets]

#include "api/LCDWidget.h"

Inheritance diagram for LCDWidget:

[legend]Collaboration diagram for LCDWidget:

[legend]List of all members.

---

Detailed Description

All the widgets in this API have LCDWidget as their base class. It contains common methods. But it should not be used directly.

Definition at line 23 of file LCDWidget.h.

Public Types
typedef std::list< std::string >	ParameterList
	A list of parameters for set method.
Public Member Functions
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.

---

Member Typedef Documentation

typedef std::list<std::string> ParameterList

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

---

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.

void move (  int  x, int  y = 1 )

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  )

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.

---