LCDTitle Class Reference
[Widgets]

#include "api/LCDTitle.h"

Inheritance diagram for LCDTitle:

[legend]Collaboration diagram for LCDTitle:

[legend]List of all members.

---

Detailed Description

This widget is used to display a title on first line of the LCD.

Examples:

client.cpp.

Definition at line 12 of file LCDTitle.h.

Public Types
typedef std::list< std::string >	ParameterList
	A list of parameters for set method.
Public Member Functions
	LCDTitle (LCDElement *parent=0, const std::string &id="")
	Default Constructor.
	LCDTitle (const std::string &text, LCDElement *parent=0, const std::string &id="")
	Constructor with widget values specified.
void	set (std::string text)
	Set the text for the widget.
std::string	get () const
	Get the text 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.

---

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

LCDTitle (  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 7 of file LCDTitle.cpp.

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

This construct can be used to specify the values for the widget while building it. Parameters: text  A string containing the text that will be displayed. 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 11 of file LCDTitle.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.

string get (   )  const

G the text used for the title. Returns: A string containing the title that is displayed. Examples: client.cpp. Definition at line 33 of file LCDTitle.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 )  [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 (  std::string  text  )

Set or change the text used for the title. Parameters: text  A string containing the title that will be displayed. Definition at line 27 of file LCDTitle.cpp.

---