Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Widget Class Reference

A user interface leaf node. More...

#include <Widget.h>

Inherits Region.

Inherited by Button, CheckBox, Console, and TextField.

Inheritance diagram for Widget:

Inheritance graph
[legend]
Collaboration diagram for Widget:

Collaboration graph
[legend]
List of all members.

Public Methods

 Widget (int i=0)
 Default constructor. More...

void enable (bool e)
 Set the enabled state.

bool isEnabled ()
 Returns true iff the widget is enabled.

void parseSymbol (Token &t, ObjectFile &file)
 Reads a single parameter sections inside the body of the object description. More...

void writeParams (ostream &stream)
 Writes all parameter sections inside the body of the object description. More...


Protected Methods

void foreGround ()
 Renders the foreground color.

void entryBackGround ()
 Renders the entry background color.

void createSymbols ()
 Creates all parameter symbols that are used within the body of the object description.


Protected Attributes

bool enabled
 True iff the Widget accepts keyboard and mouse input.


Detailed Description

A user interface leaf node.

A Widget is an active user interface control. Widgets can be enabled or disabled. Only enabled widgets will accept an Event.

Format: (see Region)

    PARAM ::= DISABLED
    DISABLED ::= "disabled"

    Example:
    Widget {
      id 5;
      size 640 480;
      position 10 5;
      disabled;
    }
    


Constructor & Destructor Documentation

Widget::Widget int    i = 0
 

Default constructor.

Constructs a new Widget with id 'i'. The id must be unique in the current scope.

Parameters:
i  int to be used as id.
Postcondition:
Widget is initialized.


Member Function Documentation

void Widget::parseSymbol Token   t,
ObjectFile   file
[virtual]
 

Reads a single parameter sections inside the body of the object description.

Each object has a set of parameter names associated with it, called symbols. Symbols are declared inside the createSymbols method. The method parseSymbol expects the Token t to be such a symbol and reads the corresponding parameters. Unknown symbols are passed to its super class.

Parameters:
t  Token that is the current parameter symbol.
file  ObjectFile from which to read.
Precondition:
The file is opened for reading and is positioned just after the parameter name.
Postcondition:
The parameter section is read including the terminating semicolon (';').

Reimplemented from Region.

Reimplemented in Button.

void Widget::writeParams ostream &    stream [virtual]
 

Writes all parameter sections inside the body of the object description.

This method writes all object parameters to ostream. Inhereting classes will always call super::writeParams().

Parameters:
stream  ostream to which to write.
Precondition:
stream is opened for writing.
Postcondition:
All object parameters are written.

Reimplemented from Region.

Reimplemented in Button.


The documentation for this class was generated from the following files:
This documentation was generated using doxygen. If you have any comments or additions please mail me.