Class: TScrollingList

Declaration: ScrollingListControl.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TScrollingView

Inherited By:

None.

Purpose:

TScrollingList is a class that contains a child table view.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TScrollingList.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TScrollingList::TScrollingList

TScrollingList ()
TScrollingList (const TScrollingList & copy)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called to create a TScrollingList suitable for streaming into.
Called to copy an object.

Parameters:

Takes no parameters.
const TScrollingList & copy -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::~TScrollingList

virtual ~ TScrollingList ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::operator=

TScrollingList & operator =(const TScrollingList & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TScrollingList & copy -The object to be copied.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The destination stream.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The source stream.

Return Value:

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

Exceptions:

Throws TInvalidVersionError if the version of the flattened object is not supported.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::GetList

virtual TTableView * GetList () const

Interface Category:

API.

Purpose:

Returns a pointer to the view associated with this list.

Calling Context:

Call this function directly to obtain the view associated with this list.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the view associated with this list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::AdoptList

virtual TTableView * AdoptList (TTableView * newList)

Interface Category:

API.

Purpose:

Adopts the specified view.

Calling Context:

Call this function directly to adopt a view.

Parameters:

TTableView * newList -The view to adopt.

Return Value:

Returns a pointer to the previously adopted view, if any.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::AdoptState

virtual void AdoptState (MTableControlState * state)

Interface Category:

API.

Purpose:

Adopts the specified control state.

Calling Context:

Call this function directly to adopt a control state.

Parameters:

MTableControlState * state -The control state to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::SetEnabled

virtual void SetEnabled (bool enabled)

Interface Category:

API.

Purpose:

Enables or disables this list, depending on the specified parameter.

Calling Context:

Call this function directly to enable or disable this list.

Parameters:

bool enabled -If set to true, this list is enabled. If set to false, this list is disabled.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::IsEnabled

virtual bool IsEnabled () const

Interface Category:

API.

Purpose:

Returns true if this list is enabled. False is returned if this list is disabled.

Calling Context:

Call this function directly to determine if this list is enabled.

Parameters:

Takes no parameters.

Return Value:

Returns true if this list is enabled. False is returned if this list is disabled.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::GetCount

virtual unsigned long GetCount () const

Interface Category:

API.

Purpose:

Returns the count of items in this list.

Calling Context:

Call this function directly to obtain the count of items in this list.

Parameters:

Takes no parameters.

Return Value:

Returns the count of items in this list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::GetPreferredSize

virtual TGPoint GetPreferredSize (GCoordinate maximumMainDimension =kInfinity) const

Interface Category:

API.

Purpose:

Returns the preferred size of this list's view.

Calling Context:

Call this function directly to determine the preferred size of this list's view.

Parameters:

GCoordinate maximumMainDimension =kInfinity -This parameter is defined in the MControl virtual member function and is currently ignored.

Return Value:

Returns the preferred size of this scrolling list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This actually calls the TTabelView::GetPreferredSize().

Member Function: TScrollingList::SetSize

virtual void SetSize (const TGPoint & size)

Interface Category:

API.

Purpose:

Sets the size of this list's view to the specified value.

Calling Context:

Call this function directly to set the size of this list's view.

Parameters:

const TGPoint & size -The new size for this list's view.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::SetCellSize

virtual void SetCellSize (const TGPoint & theSize)

Interface Category:

API.

Purpose:

Sets the size of the cells in this list to the specified value.

Calling Context:

Call this function directly to set the size of the cells in this list.

Parameters:

const TGPoint & size -The new size for the cells in this list.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::GetCellSize

virtual void GetCellSize (TGPoint & theSize) const

Interface Category:

API.

Purpose:

Fills in the passed parameter with the size of the cells in this list.

Calling Context:

Call this function directly to obtain the size of the cells in this list.

Parameters:

TGPoint & theSize -Filled in with the cell size.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::SetSelectionType

virtual void SetSelectionType (MTableControlState :: EListSelectionType type)

Interface Category:

API.

Purpose:

Sets the type if selections that may be made in this list.

Calling Context:

Call this function directly to set the type of selections that may be made in this list.

Parameters:

MTableControlState :: EListSelectionType type -Currently there are four types:
MTableControlState::kOneOnly: Only One is selected at all times.
MTableControlState::kNoneOrOne: Maximum One is selected.
MTableControlState::kMultipleAny: None or More is allowed.
MTableControlState::kMultipleContiguous: None or More is allowed but selections have to be contiguous.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::Initialize

virtual void Initialize ()

Interface Category:

API.

Purpose:

Initializes this list.

Calling Context:

Called at construction time.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::DrawContents

virtual void DrawContents (TGrafPort & port) const

Interface Category:

API.

Purpose:

Draws the contents of this list to the specified port.

Calling Context:

Called by the View system to draw the contents of this list when a refresh is needed.

Parameters:

TGrafPort & port -The port to which the list is drawn.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScrollingList::Layout

virtual void Layout ()

Interface Category:

API.

Purpose:

Layouts this control within the allocated area. This will layout vertical/horizontal scrollbar as prespecified, and clip the view area.

Calling Context:

Called from TScrollingListView whenever there relayout the ScrollingView is necessary.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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