UIWidget Class Reference

Inheritance diagram for UIWidget:
String GenObject

List of all members.

Public Member Functions

 UIWidget (const char *name=0)
virtual ~UIWidget ()
const Stringname () const
virtual bool setParams (const NamedList &params)
virtual bool getOptions (NamedList &items)
virtual bool addTableRow (const String &item, const NamedList *data=0, bool atStart=false)
virtual bool setMultipleRows (const NamedList &data, const String &prefix=String::empty())
virtual bool updateTableRows (const NamedList *data, bool atStart=false)
virtual bool insertTableRow (const String &item, const String &before, const NamedList *data=0)
virtual bool delTableRow (const String &item)
virtual bool setTableRow (const String &item, const NamedList *data)
virtual bool getTableRow (const String &item, NamedList *data=0)
virtual bool clearTable ()
virtual bool setSelect (const String &item)
virtual bool getSelect (String &item)

Constructor & Destructor Documentation

UIWidget ( const char *  name = 0  )  [inline]

Constructor, creates a new widget

Parameters:
name The widget's name
virtual ~UIWidget (  )  [inline, virtual]

Destructor


Member Function Documentation

virtual bool addTableRow ( const String item,
const NamedList data = 0,
bool  atStart = false 
) [inline, virtual]

Add a row to a table

Parameters:
item Name of the item to add
data Table's columns to set
atStart True to insert, false to append
Returns:
True if the operation was successfull
virtual bool clearTable (  )  [inline, virtual]

Clear (delete all rows) a table

Returns:
True if the operation was successfull
virtual bool delTableRow ( const String item  )  [inline, virtual]

Delete a row from a table

Parameters:
item Name of the item to remove
Returns:
True if the operation was successfull
virtual bool getOptions ( NamedList items  )  [inline, virtual]

Get widget's items

Parameters:
items List to fill with widget's items
Returns:
False on failure (e.g. not initialized)
virtual bool getSelect ( String item  )  [inline, virtual]

Retrieve the widget's selection

Parameters:
item String to fill with selection's contents
Returns:
True if the operation was successfull
virtual bool getTableRow ( const String item,
NamedList data = 0 
) [inline, virtual]

Retrieve a row from a table

Parameters:
item Name of the item to retrieve
data List to fill with table's columns contents
Returns:
True if the operation was successfull
virtual bool insertTableRow ( const String item,
const String before,
const NamedList data = 0 
) [inline, virtual]

Insert a row into a table

Parameters:
item Name of the item to insert
before Name of the item to insert before
data Table's columns to set
Returns:
True if the operation was successfull
const String& name (  )  const [inline]

Retrive the standard name of this Window

Returns:
Identifier of this window
virtual bool setMultipleRows ( const NamedList data,
const String prefix = String::empty() 
) [inline, virtual]

Append or update several table rows at once

Parameters:
data Parameters to initialize the rows with
prefix Prefix to match (and remove) in parameter names
Returns:
True if all the operations were successfull
virtual bool setParams ( const NamedList params  )  [inline, virtual]

Set widget's parameters

Parameters:
params List of parameters
Returns:
True if all parameters could be set
virtual bool setSelect ( const String item  )  [inline, virtual]

Set the widget's selection

Parameters:
item String containing the new selection
Returns:
True if the operation was successfull
virtual bool setTableRow ( const String item,
const NamedList data 
) [inline, virtual]

Update a table's row

Parameters:
item Name of the item to update
data Data to update
Returns:
True if the operation was successfull
virtual bool updateTableRows ( const NamedList data,
bool  atStart = false 
) [inline, virtual]

Add or set one or more table row(s). Screen update is locked while changing the table. Each data list element is a NamedPointer carrying a NamedList with item parameters. The name of an element is the item to update. Set element's value to boolean value 'true' to add a new item if not found or 'false' to set an existing one. Set it to empty string to delete the item

Parameters:
data The list of items to add/set/delete
atStart True to add new items at start, false to add them to the end
Returns:
True if the operation was successfull

The documentation for this class was generated from the following file:
Generated on Thu Apr 8 18:22:37 2010 for Yate by  doxygen 1.6.3