CTableView

Heritage

Description

Protected Data Members

Public Methods

Constructor, Destructor, and Initializer Methods

Overridden Methods

Table Methods

Row Methods

Column Methods

Cell Methods

Focus Methods

Refresh Methods

Advanced Access Methods

Data Connection Pip Methods

Protected Methods

Heritage

Subclass: None

Description

Protected Data Members

Public Methods

CTableView(
	CSubview* theEnclosure,
	const CRect& theRegion,
	const CFont& theTableFont	= STDFont,
	UNITS theDefaultRowHeight 	= kNoHeight,
	UNITS theDefaultColumnWidth 	= kNoWidth,
	long theChunkRows	= 128,
	long theChunkColumns	= 32);

The constructor.

virtual ~CTableView();

The destructor.

virtual BOOLEAN ITableView(
	BOOLEAN isVisible 	= TRUE,
	GLUETYPE theGlue 	= NULLSTICKY,
	const CFont& theFont 	= STDFont);

The table view initializer.

virtual void Draw(const CRect& theClip);

The Draw method is called whenever the table view must be redisplayed.

virtual void Size(const CRect& theNewSize);

The Size method is called to resize the table view, including when CGlue behavior is controlling the resizing.

virtual void VScroll(SCROLL_CONTROL theEventType, 
	UNITS thePos);

Implements the response to manipulating the vertical scrollbar associated with the table view.

virtual void HScroll(SCROLL_CONTROL theEventType, 
	UNITS thePos);

Implements the response to manipulating the horizontal scrollbar associated with the table view.

virtual void MouseDouble(
	CPoint theLocation, 
	short theButton	= 0,
	BOOLEAN isShiftKey  	= FALSE,
	BOOLEAN isControlKey 	= FALSE);

Implements the response to a mouse double click in the table view. Note that a MouseDown and MouseUp typically precede a MouseDouble, and a MouseUp typically follows.

virtual void MouseDown(
	CPoint theLocation, 
	short theButton	= 0,
	BOOLEAN isShiftKey  	= FALSE,
	BOOLEAN isControlKey 	= FALSE);

Implements the response to clicking the mouse button in the table view. Note that a MouseUp typically follows a MouseDown, though it may not due to user movement of the mouse.

virtual void SetTable(
	CTableAttributes& theAttributes,
	BOOLEAN thePropagate= FALSE);

Applies the provided CTableAttributes object to the CTableView and, optionally, its nested views. Invalidate the view to force redrawing.

virtual void AssociateScrollBars(
	NScrollBar* theVScrollBar,
	NScrollBar* theHScrollBar);

Internal routine used to set up scrollbars.

virtual void SetCellOrigin(const CCell& theCell);

Adjusts the visible table region after row or column insertion or deletion.

virtual CCell GetCellOrigin() const;

Queries the visible table region.

virtual void SetPixelOrigin(const CPoint& thePoint);

Scrolls the table view.

virtual CPoint GetPixelOrigin() const;

Queries the view origin in pixels.

virtual void SetCellBounds(const CBounds& theBounds);

Sets table-view range-controls scrollbar appearance and behavior.

virtual CBounds GetCellBounds() const;

Queries the horizontal and vertical bounds of the table view.

virtual void SetCellClipping(BOOLEAN theClip);

Enables or disables clipping to the borders of each cell during drawing.

virtual BOOLEAN GetCellClipping();

Queries the state of clipping to the borders of each cell during drawing.

virtual void SetRow(long theRow, UNITS theHeight);

Sets the height of a particular row. theRow is a zero-based index.

virtual void SetRow(
	long theRow,
	CTableAttributes& theAttributes,
	BOOLEAN thePropagate = FALSE);

Sets an attributes object for a particular row.

virtual void InsertRows(long theRow, long theCount = 1);

Inserts one or more rows in the table view after theRow.

virtual void DeleteRows(long theRow, long theCount = 1);

Deletes one or more rows from the table view starting with theRow.

virtual void SetColumn(long theColumn, UNITS theWidth);

Sets the width of a particular column. theColumn is a zero-based index.

virtual void SetColumn(
	long theColumn,
	CTableAttributes& theAttributes,
	BOOLEAN thePropagate= FALSE);

Sets an attributes object for a particular column.

virtual void InsertColumns(long theColumn, 
	long theCount = 1);

Inserts one or more columns in the table view after theColumn.

virtual void DeleteColumns(long theColumn, 
	long theCount = 1);

Deletes one or more columns from the table view starting with theColumn.

virtual void SetCell(
	const CCell& theCell,
	CTableAttributes& theAttributes);

Sets an attributes object for a particular cell.

virtual void SetFocus(const CCell* theCell);

Places focus in the designated cell. If some other cell presently has focus, that cell is unfocused by calling FocusOut on the cell's interpreter, then InvalidateCell on the cell to allow it to redraw in an unfocused appearance. Next, CanFocus is called on the interpreter of the cell which is to gain focus. If this cell can gain focus, then FocusIn is called on its interpreter and InvalidateCell is called on the cell to allow it to redraw in a focused state.

virtual const CCell* GetFocus() const;

Retrieves the cell object which designates the cell (row and column) with focus.

virtual void InvalidateRow(long theRow);

Redraws theRow.

virtual void InvalidateColumn(long theColumn);

Redraws theColumn.

virtual void InvalidateCell(const CCell& theCell);

Redraws theCell.

virtual void InvalidateBounds(const CBounds& theBounds);

Redraws the region designated by theBounds.

virtual void InvalidateRegion(const CRegion& theRegion);

Redraws the region designated by theBounds.

virtual void InvalidateSelection();

Redraws the current table view selection.

virtual void CellToParameters(
	const CCell& theCell,
	CTableInterpreterParameters* theParameters);

Retrieves interpreter parameters for the designated cell. Note that pointers in the object theParameters point to static storage and are overwritten with each call. theParameters->itsContext is not set and should be initialized before calling an interperter on this parameters object.

virtual void CellToAttributes(
	const CCell& theCell,
	CTableAttributes* theAttributes);

Retrieve table attributes for the designated cell.

const CTableAttributeArray& GetAttributes() const;
CTableAttributeArray& GetAttributes();

These retrieve the CTableAttributeArray for the table.

const CTableCoordinates 	GetCoordinates() const;
CTableCoordinates& GetCoordinates();

These retrieve the CTableCoordinates for the table.

virtual void SetSource(CTableSource* theSource);

Assigns a new CTableSource for the table view. theSource will not be deleted by the table view destructor.

virtual CTableSource* GetSource();
virtual const CTableSource* GetSource() const;

These retrieve the current table source.

virtual const CTdiValue* GetData(const CCell& theCell);

Retrieves data from the current table source for the table view.

virtual BOOLEAN PutData(
	const CCell& theCell,
	const CTdiValue* theData);

Passes data to the current table source for the table view.

BOOLEAN IsFlushRight() const;
BOOLEAN IsFlushBottom() const;

These query whether the cells are displayed flush right or bottom

virtual void ChangeDrawingContext(
	CDrawingContext* theDrawingContext,
	CTableAttributes& theAttributes);

Changes the table view's foreground, background and font attributes.

virtual void DrawColumnBackground(
	long theColumn,
	long theFirstRow,
	long theLastRow,
	CTableAttributes* theAttributes);

Draws the background of the rectangular region from the left edge of theColumn and the top of theFirstRow to the right edge of theColumn and the bottom of theLastRow.

virtual void DrawRowBackground(
	long theRow,
	long theFirstColumn,
	long theLastColumn,
	CTableAttributes* theAttributes);

Draws the background of the rectangular region from the top of theRow and the left edge of theFirstColumn to the bottom of theRow and the right edge of theLastColumn.

virtual void DrawColumn(
	const CRect& theClip,
	long theColumn,
	long theFirstRow,
	long theLastRow,
	CTableAttributes* theColumnAttributes,
	CTableAttributes* theRowAttributes);

Draw the contents of the designated column for each of the rows from theFirstRow through theLastRow. If any cells in the column have individual CTableAttributes objects, the individual cell object is merged with the supplied column and row attributes objects to form a merged set of attributes before drawing the cell content.

virtual CCell OriginWithinBounds(
	const CCell& aProposedOrigin,
	CPoint* theOffset = NULL);

Internal routine to facilitate proper scroll behavior.

virtual void AdjustVScrollBar();
virtual void AdjustHScrollBar();

Internal routines to adjust scrollbar position and proportion after scrolling data.

CTableView(const CTableView& theTable);
CTableView& operator=(const CTableView& theTable);

Disabled copy constructor and assignment operator.