Class: TStandardDropDownListControlState

Declaration: DropDownTextControl.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MDropDownListControlState

Inherited By:

None.

Purpose:

The TStandardDropDownListControlState class is derived from the abstract class MDropDownListControlState. This class provides the concrete definitions for the internal list virtual functions that were defined in MDropDownListControlState.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::TStandardDropDownListControlState

TStandardDropDownListControlState ()
TStandardDropDownListControlState (TSequenceOf < TText > * listToAdopt, unsigned long selectedIndex =TDropDownTextControl :: kInvalidIndex)
TStandardDropDownListControlState (const TStandardDropDownListControlState &)

Interface Category:

API.

Purpose:

Default constructor.
This constructor creates an internal list object from the specified sequence list object.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to create a custom internal list using the specified sequence list object.
Called to copy an object.

Parameters:

Takes no parameters.
TSequenceOf < TText > * listToAdopt -A pointer to the sequence list object.
unsigned long selectedIndex =TDropDownTextControl :: kInvalidIndex -The index of a selected item in the list object.
const TStandardDropDownListControlState & -The object that is to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::~TStandardDropDownListControlState

virtual ~ TStandardDropDownListControlState ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::operator=

TStandardDropDownListControlState & operator =(const TStandardDropDownListControlState &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TStandardDropDownListControlState & -The object to be assigned to this object.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream the stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream the stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::AdoptList

virtual void AdoptList (TSequenceOf < TText > * listToAdopt)

Interface Category:

API.

Purpose:

Adopts the referenced list control state and incorporates its items into the drop-down list display. This enables customizing of the text items of the control object.

Calling Context:

Call this function directly to adopt a new list.

Parameters:

TSequenceOf < TText > * listToAdopt -A pointer to the list of text items that is to be adopted.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::OrphanList

virtual TSequenceOf < TText > * OrphanList ()

Interface Category:

API.

Purpose:

Orphans, or frees, the current adopted list sequence.

Calling Context:

Call this function directly to release the list.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the just orphaned list sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::CreateIterator

virtual TDropDownTextControlIterator * CreateIterator (const TAllocationHeap & whichHeap) const

Interface Category:

API.

Purpose:

Creates an iterator, which gives the creator the ability to iterate through a list of items.

Calling Context:

Call this function directly.

Parameters:

const TAllocationHeap & whichHeap -A reference to the heap on which the list has been allocated.

Return Value:

Returns a pointer to the TDropDownTextControlIterator iterator.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::GetItemFromIndex

virtual bool GetItemFromIndex (unsigned long index, TText & textToFill) const

Interface Category:

API.

Purpose:

Gets an item by its index value.

Calling Context:

Call this function directly.

Parameters:

unsigned long index -The index value to the item.
TText & textToFill -The text of the item, filled in by the function.

Return Value:

Returns true if the item was found successfully; otherwise, returns false.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::GetIndexFromItem

virtual unsigned long GetIndexFromItem (const TText & item) const

Interface Category:

API.

Purpose:

Gets the index value for a given item.

Calling Context:

Call this function directly.

Parameters:

const TText & item -The text of the item for which the index value is desired.

Return Value:

Returns the index value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::GetSelectedIndex

virtual unsigned long GetSelectedIndex () const

Interface Category:

API.

Purpose:

Gets the selected list item's index value.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the index value of the selected list item.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::GetItemCount

virtual unsigned long GetItemCount () const

Interface Category:

API.

Purpose:

Gets the count of the number of items in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the number of items in the list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::GetItemsMaximumSize

virtual TGPoint GetItemsMaximumSize () const

Interface Category:

API.

Purpose:

Gets the maximum size--the maximum width and height--of an item in the list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the TGPoint object that describes the width and height dimensions for the item.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::CreateInterests

virtual void CreateInterests (TCollectionOf < TInterest > & collection) const

Interface Category:

API.

Purpose:

Establishes a notification connection for changes to the control state. This function is called by the control so that it will receive notification of changes. If this function returns one or more interests, then a member function connection is made with the control's StateChanged function.

Calling Context:

Call this function directly.

Parameters:

TCollectionOf < TInterest > & collection -The set of interests.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardDropDownListControlState::NotifyControlOfChange

virtual void NotifyControlOfChange ()

Interface Category:

API.

Purpose:

Notifies the control of changes that are of interest to the control.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.