Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TSimpleView, MMouseEventHandler, MControl, MDelegatingTable
Inherited By:
None.
Purpose:
TTableView is a class that represents a variable a list of items in a view. TTableView provides the list interactor with information on the bounds of the items and delegates item selection to the operations to the affected items.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Do not derive any classes from TTableView.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
- TTableView ()
- TTableView (const TTableView & copy)
Interface Category:
API.
Purpose:
- Default constructor.
- Copy constructor.
Calling Context:
- Called to create a TTableView suitable for streaming into.
- Called to copy an object.
Parameters:
- Takes no parameters.
- const TTableView & copy -The object to be copied.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TTableView ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::operator=
TTableView & operator =(const TTableView &)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object.
Parameters:
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: TTableView::operator>>=
virtual TStream & operator >>=(TStream &) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Called to stream out data.
Parameters:
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: TTableView::operator<<=
virtual TStream & operator <<= (TStream &)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called to stream in data.
Parameters:
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: TTableView::AdoptState
virtual void AdoptState (MTableControlState * state)
Interface Category:
API.
Purpose:
Adopts the specified control state object.
Calling Context:
Call this function directly to adopt a control state object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::SetState
virtual void SetState (MTableControlState * state)
Interface Category:
API.
Purpose:
Set the specified control state object.
Calling Context:
Call this function directly to set a control state object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetState
virtual MTableControlState * GetState () const
Interface Category:
API.
Purpose:
Returns a pointer to this object's current control state object.
Calling Context:
Call this function directly to obtain the current control state object.
Parameters:
Return Value:
Returns a pointer to this object's current control state object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::OrphanState
virtual MTableControlState * OrphanState ()
Interface Category:
API.
Purpose:
Orphans the current control state object.
Calling Context:
Call this function directly to orphan the current control state object.
Parameters:
Return Value:
Returns a pointer to the orphaned control state object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::SetEnabled
virtual void SetEnabled (bool enabled)
Interface Category:
API.
Purpose:
Enables or disables this view, depending on the passed parameter.
Calling Context:
Call this function directly to enable or disable this view.
Parameters:
- bool enabled -If set to true, this object is enabled. If set to false, this object is disabled.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::IsEnabled
virtual bool IsEnabled () const
Interface Category:
API.
Purpose:
Returns true if this view is enabled. False is returned if this view is disabled.
Calling Context:
Call this function directly to determine if this view is enabled.
Parameters:
Return Value:
Returns true if this view is enabled. False is returned if this view is disabled.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetPreferredSize
virtual TGPoint GetPreferredSize (GCoordinate maximumMainDimension =kInfinity) const
Interface Category:
API.
Purpose:
Returns the preferred size of this view.
Calling Context:
Call this function directly to obtain the preferred size of this 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 view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::SetSize
virtual void SetSize (const TGPoint & size)
Interface Category:
API.
Purpose:
Sets the size of this view.
Calling Context:
Call this function directly to set the size of this view.
Parameters:
- const TGPoint & size -The new size for this view.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetBackgroundBundle
virtual const TGrafBundle * GetBackgroundBundle () const
Interface Category:
API.
Purpose:
Returns the background graphic bundle for this view.
Calling Context:
Call this function directly to obtain the background graphic bundle for this view.
Parameters:
Return Value:
Returns the background graphic bundle for this view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::AdoptBackgroundBundle
virtual void AdoptBackgroundBundle (TGrafBundle * backgroundBundle)
Interface Category:
API.
Purpose:
Adopts the specified background graphic bundle for this view.
Calling Context:
Call this function directly to adopt a background graphic bundle for this view.
Parameters:
- TGrafBundle * backgroundBundle -The new background graphic bundle for this view.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetHighlightBundle
virtual const TGrafBundle * GetHighlightBundle () const
Interface Category:
API.
Purpose:
Returns the highlight graphic bundle for this view.
Calling Context:
Call this function directly to obtain the highlight graphic bundle for this view.
Parameters:
Return Value:
Returns the highlight graphic bundle for this view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::AdoptHighlightBundle
virtual void AdoptHighlightBundle (TGrafBundle * highlightBundle)
Interface Category:
API.
Purpose:
Adopts the specified highlight graphic bundle for this view.
Calling Context:
Call this function directly to adopt a highlight graphic bundle for this view.
Parameters:
- TGrafBundle * highlightBundle -The new highlight graphic bundle for this view.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::HandleAllocatedAreaChanged
virtual void HandleAllocatedAreaChanged (const TGArea & newArea)
Interface Category:
API.
Purpose:
Handles the change in the area allocated to this view. Currently, this change is handled by forcing the view to be redrawn.
Calling Context:
Called to handle changes in the area allocated to this view.
Parameters:
- const TGArea & newArea -The new area.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::NeedsClipping
virtual bool NeedsClipping ()
Interface Category:
API.
Purpose:
Returns true if this view needs clipping, returns false if not.
Calling Context:
Called to determine if this view needs to be clipped.
Parameters:
Return Value:
Returns true if this view needs clipping, returns false if not.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::PointToCell
virtual void PointToCell (const TGPoint & aPoint, TTableCell & theCell) const
Interface Category:
API.
Purpose:
Fills in theCell with the cell located at the specified point location.
Calling Context:
Call this function directly to obtain a cell by giving the cell's global coordinates.
Parameters:
- const TGPoint & aPoint -The point's global coordinates.
- TTableCell & theCell -The parameter to be filled in.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetVisibility
virtual bool GetVisibility () const
Interface Category:
API.
Purpose:
Returns true if this view is currently visible, otherwise false is returned.
Calling Context:
Call this function directly to determine if this view is currently visible.
Parameters:
Return Value:
Returns true if this view is currently visible, otherwise false is returned.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::SetVisibility
virtual void SetVisibility (bool visible =true)
Interface Category:
API.
Purpose:
Enables or disables the visibility of this view, depending on the passed parameter.
Calling Context:
Call this function directly to enable or disable the visibility of this view.
Parameters:
- bool visible =true -If set to true, this view will be changed to visible. If set to false, this view will be set to not visible.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::SetInsetSize
virtual void SetInsetSize (const TGPoint insetSize)
Interface Category:
API.
Purpose:
Sets this view's inset to the size specified.
Calling Context:
Call this function directly to set this view's inset size.
Parameters:
- const TGPoint insetSize -The new inset size.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetInsetSize
virtual void GetInsetSize (TGPoint & insetSize) const
Interface Category:
API.
Purpose:
Fills in the parameter with the size of this view's inset.
Calling Context:
Call this function directly to obtain the size of this view's inset.
Parameters:
- TGPoint & insetSize -The parameter to be filled in.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::SetCellSize
virtual void SetCellSize (const TGPoint & theSize, unsigned long count)
Interface Category:
API.
Purpose:
Sets the cell size for this view to the size specified. The number of rows and columns to the count specified.
Calling Context:
Call this function directly to set the size and number of this view's cells.
Parameters:
- const TGPoint & theSize -The new cell size.
- unsigned long count -The new number of rows and columns.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetCellSize
virtual void GetCellSize (TGPoint & theSize) const
Interface Category:
API.
Purpose:
Fills in the passed parameter with the size of the cells in this view.
Calling Context:
Call this function directly to obtain the size of the cells in this view.
Parameters:
- TGPoint & theSize -The parameter to be filled in.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::SetSelectionType
virtual void SetSelectionType (MTableControlState :: EListSelectionType type)
Interface Category:
API.
Purpose:
Sets the selection type to the value specified.
Calling Context:
Call this function directly to set the selection type of this view.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::UpdateSelection
virtual void UpdateSelection ()
Interface Category:
API.
Purpose:
Updates all the cells currently selected.
Calling Context:
Call this function directly to update all selected cells.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetColumnWidth
virtual GCoordinate GetColumnWidth (unsigned long aCol) const
Interface Category:
API.
Purpose:
Returns the width of the specified column. Column numbering starts at zero.
Calling Context:
Call this function directly to obtain the width of a specific column.
Parameters:
- unsigned long aCol -The number of the column whose width is to be returned.
Return Value:
Returns the width of the specified column.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetRowHeight
virtual GCoordinate GetRowHeight (unsigned long aRow) const
Interface Category:
API.
Purpose:
Returns the height of the specified row. Row numbering starts at zero.
Calling Context:
Call this function directly to obtain the height of a specific row.
Parameters:
- unsigned long aCol -The number of the row whose height is to be returned.
Return Value:
Returns the height of the specified row.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::SetColumnWidth
virtual void SetColumnWidth (unsigned long aCol, GCoordinate aWidth, unsigned long numberOfColumns)
Interface Category:
API.
Purpose:
Sets the width of the specified column. Column numbering starts at zero.
Calling Context:
Call this function directly to set the width of a specific column.
Parameters:
- unsigned long aCol -The number of the column to be resized.
- GCoordinate aWidth -The new column width.
- unsigned long numberOfColumns -The number of columns to resize.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
This member function will currently only resize one column, regardless of the value of numberOfColumns.
Member Function: TTableView::SetRowHeight
virtual void SetRowHeight (unsigned long aRow, GCoordinate aHeight, unsigned long numberOfRows)
Interface Category:
API.
Purpose:
Sets the height of the specified row. Row numbering starts at zero.
Calling Context:
Call this function directly to set the height of one or more rows.
Parameters:
- unsigned long aRow -The row to be resized.
- GCoordinate aHeight -The new height.
- unsigned long numberOfRows -The number of rows to be resized.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
This member function will currently only resize one row, regardless of the value of numberOfRows.
Member Function: TTableView::GetNumberOfRows
virtual unsigned long GetNumberOfRows () const
Interface Category:
API.
Purpose:
Returns the number of rows in this view.
Calling Context:
Call this function directly to obtain the number of rows in this view.
Parameters:
Return Value:
Returns the number of rows in this view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetNumberOfColumns
virtual unsigned long GetNumberOfColumns () const
Interface Category:
API.
Purpose:
Returns the number of columns in this view.
Calling Context:
Call this function directly to obtain the number of columns in this view.
Parameters:
Return Value:
Returns the number of columns in this view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetFirstRow
virtual unsigned long GetFirstRow () const
Interface Category:
API.
Purpose:
Returns the number of the first row in this view.
Calling Context:
Call this function directly to obtain the number of the first row in this view.
Parameters:
Return Value:
Returns the number of the first row in this view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetFirstColumn
virtual unsigned long GetFirstColumn () const
Interface Category:
API.
Purpose:
Returns the number of the first column in this view.
Calling Context:
Call this function directly to obtain the number of the first column in this view.
Parameters:
Return Value:
Returns the number of the first column in this view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetLastRow
virtual unsigned long GetLastRow () const
Interface Category:
API.
Purpose:
Returns the number of the last row in this view.
Calling Context:
Call this function directly to obtain the number of the last row in this view.
Parameters:
Return Value:
Returns the number of the last row in this view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetLastColumn
virtual unsigned long GetLastColumn () const
Interface Category:
API.
Purpose:
Returns the number of the last column in this view.
Calling Context:
Call this function directly to obtain the number of the last column in this view.
Parameters:
Return Value:
Returns the number of the last column in this view.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::HandleAfterConnectionToViewRoot
virtual void HandleAfterConnectionToViewRoot ()
Interface Category:
API.
Purpose:
Establishes a connection to a request processor, and updates the selections.
Calling Context:
Called by the View system after connecting to the view root.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::HandleBeforeDisconnectionFromViewRoot
virtual void HandleBeforeDisconnectionFromViewRoot ()
Interface Category:
API.
Purpose:
Handles process required prior to disconnecting from the root view. The current implementation does nothing.
Calling Context:
Called by the View system before disconnecting from the view root.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::RectToBoundingCells
virtual void RectToBoundingCells (const TGRect & theRect, TTableCell & startCell, TTableCell & stopCell) const
Interface Category:
API.
Purpose:
Fills in the range of cells bounded by the area specified by theRect.
Calling Context:
Called to determine the cells bounded by an area.
Parameters:
- const TGRect & theRect -The bounding area.
- TTableCell & startCell -The first cell in the range.
- TTableCell & stopCell -The last cell in the range.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::DrawRangeOfCells
- virtual void DrawRangeOfCells (const TTableCell & startCell, const TTableCell & stopCell, TGrafPort & drawingPort)
- virtual void DrawRangeOfCells (const TTableCell & startCell, const TTableCell & stopCell, const TGRect & bounds, TGrafPort & drawingPort)
Interface Category:
API.
Purpose:
- Draws the specified range of cells to the specified port.
- Draws the specified range of cells to the specified port, bounded by the specified rectangle.
Calling Context:
- Called to draw a range of cells to a port.
- Called to draw a range of cells to a port, bounded by the specified rectangle.
- Called by 1.
Parameters:
- const TTableCell & startCell -The first cell in the range.
- const TTableCell & stopCell -The last cell in the range.
- TGrafPort & drawingPort -The port.
- const TTableCell & startCell -The first cell in the range.
- const TTableCell & stopCell -The last cell in the range.
- const TGRect & bounds -The bounds of the range of cells.
- TGrafPort & drawingPort -The port.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::DrawCell
virtual void DrawCell (const TTableCell & aCell, const TGRect & cellRect, TGrafPort & drawingPort)
Interface Category:
API.
Purpose:
Draws the specified cell.
Calling Context:
Called to draw a cell.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::CellToRect
virtual void CellToRect (const TTableCell & aCell, TGRect & aRect) const
Interface Category:
API.
Purpose:
Fills in aRect with the bounds of the specified cell.
Calling Context:
Called to obtain the bounds of a cell.
Parameters:
- const TTableCell & aCell -The cell.
- TGRect & aRect -Filled in with the bounds of the cell.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::CellRangeToRect
virtual void CellRangeToRect (const TTableCell & startCell, const TTableCell & endCell, TGRect & aRect) const
Interface Category:
API.
Purpose:
Fills in aRect with the bounds of the range of cell specified.
Calling Context:
Called to obtain the bounds of a range of cells.
Parameters:
- const TTableCell & startCell -The first cell in the range.
- const TTableCell & endCell -The last cell in the range.
- TGRect & aRect -Filled in with the bounds of the range of cells.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetRowFromDimension
virtual unsigned long GetRowFromDimension (GCoordinate dimension) const
Interface Category:
API.
Purpose:
Returns the number of the rows with the specified width.
Calling Context:
Called to determine the number of rows with the width specified.
Parameters:
- GCoordinate dimension -The dimension.
Return Value:
Returns the number of the rows with the specified width.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetColumnFromDimension
virtual unsigned long GetColumnFromDimension (GCoordinate dimension) const
Interface Category:
API.
Purpose:
Returns the number of the columns with the specified height.
Calling Context:
Called to determine the number of columns with the height specified.
Parameters:
- GCoordinate dimension -The dimension.
Return Value:
Returns the number of the columns with the specified height.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::CommonGetIndex
virtual unsigned long CommonGetIndex (GCoordinate dimension, bool doingColumns) const
Interface Category:
API.
Purpose:
Returns the number of columns or the number of rows with the specified dimension.
Calling Context:
Called to return the number of columns or the number of rows with the specified dimension.
Parameters:
- GCoordinate dimension -The dimension.
- bool doingColumns -If true, search for columns with the specified dimension. If false, search for rows.
Return Value:
Returns the number of columns or the number of rows with the specified dimension.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetDimensionFromRow
virtual GCoordinate GetDimensionFromRow (unsigned long aRow) const
Interface Category:
API.
Purpose:
Returns the dimension of the specified row.
Calling Context:
Called to obtain the of a specific row.
Parameters:
- unsigned long aRow -The row whose dimension is to be returned.
Return Value:
Returns the dimension of the specified row.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::GetDimensionFromColumn
virtual GCoordinate GetDimensionFromColumn (unsigned long aColumn) const
Interface Category:
API.
Purpose:
Returns the dimension of the specified column.
Calling Context:
Called to obtain the of a specific column.
Parameters:
- unsigned long aColumn -The column whose dimension is to be returned.
Return Value:
Returns the dimension of the specified column.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::CommonGetDimension
virtual GCoordinate CommonGetDimension (unsigned long aColumn, bool doingColumns) const
Interface Category:
API.
Purpose:
Returns the dimension of a specified row or column.
Calling Context:
Called to obtain the dimension of a specified row or column.
Parameters:
- unsigned long aColumn -The row or column number.
- bool doingColumns -If true, return the column's dimension. If false, return the row's dimension.
Return Value:
Returns the dimension of a specified row or column.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::AreColumnsSingleWidth
virtual bool AreColumnsSingleWidth ()
Interface Category:
API.
Purpose:
Returns true if the columns in this table have the same width. False is returned if there are columns with differing widths.
Calling Context:
Called to determine if the table contains columns with differing widths.
Parameters:
Return Value:
Returns true if the columns in this table have the same width.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Currently, this member function will always return true. Only SingleWidth for columns is handled.
Member Function: TTableView::AreRowsSingleHeight
virtual bool AreRowsSingleHeight ()
Interface Category:
API.
Purpose:
Returns true if the rows in this table have the same height. False is returned if there are rows with differing heights.
Calling Context:
Called to determine if the table contains rows with differing heights.
Parameters:
Return Value:
Returns true if the rows in this table have the same height.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Currently, this member function will always return false. Only SingleHeight for rows is handled.
Member Function: TTableView::InvalidateCell
virtual void InvalidateCell (const TTableCell & aCell)
Interface Category:
API.
Purpose:
Forces the specified cell to be redrawn.
Calling Context:
Called to force a redraw of a specific cell.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::InvalidateCells
virtual void InvalidateCells (const TTableCell & startCell, const TTableCell & endCell)
Interface Category:
API.
Purpose:
Forces a range of cells to be redrawn.
Calling Context:
Called to force a range of cells to be redrawn.
Parameters:
- const TTableCell & startCell -The first cell in the range.
- const TTableCell & endCell -The last cell in the range.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::InvalidateRow
virtual void InvalidateRow (unsigned long startRow, unsigned long numberOfRows =1)
Interface Category:
API.
Purpose:
Forces one or more rows to be redrawn.
Calling Context:
Called to force one or more rows to be redrawn.
Parameters:
- unsigned long startRow -The first row.
- unsigned long numberOfRows =1 -The total number of rows to be redrawn.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::InvalidateColumn
virtual void InvalidateColumn (unsigned long startColumn, unsigned long numberOfColumns =1)
Interface Category:
API.
Purpose:
Forces one or more columns to be redrawn.
Calling Context:
Called to force one or more columns to be redrawn.
Parameters:
- unsigned long startColumn -The first column.
- unsigned long numberOfcolumns =1 -The total number of columns to be redrawn.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::SelectCell
virtual void SelectCell (const TTableCell & aCell, bool selected)
Interface Category:
API.
Purpose:
Selects or deselects the specified cell, depending on the value of the selected parameter.
Calling Context:
Called to select or deselect a cell.
Parameters:
- const TTableCell & aCell -The cell.
- bool selected -If true, the cell is selected. If false, the cell is deselected.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::IsCellSelected
virtual bool IsCellSelected (const TTableCell & aCell) const
Interface Category:
API.
Purpose:
Returns true if the specified cell is selected, false if it is not selected.
Calling Context:
Called to determine if a cell is selected.
Parameters:
Return Value:
Returns true if the specified cell is selected, false if it is not selected.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::AdoptListColor
virtual void AdoptListColor (TGrafBundle * bundle)
Interface Category:
API.
Purpose:
Adopts the specified color for the table view list.
Calling Context:
Called to change the table view list color.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
This will force a redraw of the view to reflect the new color.
Member Function: TTableView::CreateInteractor
virtual TInteractor * CreateInteractor (const TGPoint & pt)
Interface Category:
API.
Purpose:
Creates an interactor for mouse and keyboard interacting on the TTableView control. Classes deriving from TTableView can override this function to return different interactors.
Calling Context:
Called when a mouse down event occurred.
Parameters:
- const TGPoint & pt -The location where the mouse down event occurred.
Return Value:
A pointer to the interactor created.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::MouseDown
virtual bool MouseDown (TMouseDownEvent & mouseEvent)
Interface Category:
API.
Purpose:
If this view is enabled, creates an interactor for the specified event and returns true.
Calling Context:
Called to handle a mouse event.
Parameters:
Return Value:
Returns true if the event was handled, false otherwise.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::HandleDoubleClick
virtual void HandleDoubleClick (TMouseDownEvent & mouseEvent)
Interface Category:
API.
Purpose:
Handles a mouse down double click event for this view.
Calling Context:
Called to handle a mouse down double click event for this view.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Currently, This will turn around to call MTableControlState::HandleDoubleClick.
Member Function: TTableView::HandleStateChanged
virtual void HandleStateChanged ()
Interface Category:
API.
Purpose:
Forces a redraw of this view in response to a state change.
Calling Context:
Called to redraw this view in response to a state change.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::Initialize
virtual void Initialize ()
Interface Category:
API.
Purpose:
Initializes this view.
Calling Context:
Called at construction time.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::Finalize
virtual void Finalize ()
Interface Category:
API.
Purpose:
Deletes the resources associated with this view prior to destruction.
Calling Context:
Called prior to the destruction of this object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::DrawContents
virtual void DrawContents (TGrafPort & port) const
Interface Category:
API.
Purpose:
Draws the cells in this view.
Calling Context:
Called by the View system to draw the cells in this view.
Parameters:
- TGrafPort & port -The port to which the cells are drawn.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TTableView::DrawBackground
virtual void DrawBackground (TGrafPort & port, const TGArea & visibleArea) const
Interface Category:
API.
Purpose:
Draws the visible portion of this view's background.
Calling Context:
Called to draw this view's background.
Called by TTableView::DrawContents.
Parameters:
- TGrafPort & port -The port.
- const TGArea & visibleArea -The area of this view that is visible.
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.
Copyright©1995 Taligent,Inc. All rights reserved.