University of Sheffield   

    The Simons
    Component Library
Introduction   Class Hierarchy   Class Listing   Index of Classes   Index of Methods   Header Files  

TextInputID Class Reference

#include <TextInputID.h>

Inheritance diagram for TextInputID:

InputID FileStreamID StreamID ObjectID List of all members.

Detailed Description

TextInputID: a typed reference to a TextInput.

TextInputID is a strongly typed, reference counting pointer that refers to a TextInput. TextInputID variables may be initialised to TextInput* objects and all subtypes. TextInputID variables may alias objects held by other TextInputID variables, or any subtype. When a TextInputID acquires an object, it increments the object's reference count. When a TextInputID releases an object, it decrements the object's reference count. If the reference count reaches zero, the object is automatically deleted.


Public Member Functions

 TextInputID ()
 Declare a TextInputID.

 ~TextInputID ()
 Release a TextInputID.

 TextInputID (const Null *)
 Initialise a TextInputID to refer explicitly to null.

 TextInputID (const TextInput *)
 Initialise a TextInputID to refer to a TextInput.

 TextInputID (const TextInputID &)
 Initialise a TextInputID to alias another TextInputID.

TextInputID & operator= (const TextInput *)
 Reassign this TextInputID to refer to a TextInput.

TextInputID & operator= (const TextInputID &)
 Reassign this TextInputID to alias another TextInputID.

TextInput * operator-> () const
 Invoke a method on this TextInputID.

Constructor & Destructor Documentation

TextInputID::TextInputID (   )  [inline]
 

Declare a TextInputID.

Returns:
a null TextInputID.

TextInputID::~TextInputID (   )  [inline]
 

Release a TextInputID.

TextInputID::TextInputID (  const Null *  null  )  [inline]
 

Initialise a TextInputID to refer explicitly to null.

Parameters:
null - the null reference.
Returns:
a TextInputID referring to null.

TextInputID::TextInputID (  const TextInput *  stream  )  [inline]
 

Initialise a TextInputID to refer to a TextInput.

Parameters:
stream - the TextInput.
Returns:
a TextInputID referring to the stream.

TextInputID::TextInputID (  const TextInputID &  pointer  )  [inline]
 

Initialise a TextInputID to alias another TextInputID.

Parameters:
pointer - the other TextInputID.
Returns:
a TextInputID referring to the stream.

Member Function Documentation

TextInput * TextInputID::operator-> (   )  const
 

Invoke a method on this TextInputID.

Returns:
the result of the method.

Reimplemented from InputID.

TextInputID & TextInputID::operator= (  const TextInputID &  pointer  )  [inline]
 

Reassign this TextInputID to alias another TextInputID.

Parameters:
pointer - the other TextInputID.
Returns:
a TextInputID referring to the same TextInput as the other TextInputID.

TextInputID & TextInputID::operator= (  const TextInput *  stream  )  [inline]
 

Reassign this TextInputID to refer to a TextInput.

Parameters:
stream - the TextInput.
Returns:
a TextInputID referring to the stream.

The documentation for this class was generated from the following files:
Generated on Fri May 5 17:17:20 2006 for The Simons Component Library by doxygen1.3