InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITableCellData Class Referenceabstract

#include <ITableCellData.h>

Inheritance diagram for ITableCellData:
IPMUnknownCPMUnknown< ITableCellData >TableCellData

Public Types

enum  { kDefaultIID = IID_ITABLECELLDATA }
 
enum  { kNoSelected = -1 }
 

Public Member Functions

virtual int32 GetMaxColumn (void) const =0
 
virtual int32 GetMaxRow (void) const =0
 
virtual int32 GetCellNumberOfColumns (void) const =0
 
virtual int32 GetCellNumberOfRows (void) const =0
 
virtual int32 GetTableWidth (void) const =0
 
virtual int32 GetTableHeight (void) const =0
 
virtual int32 GetCellWidth (void) const =0
 
virtual int32 GetCellHeight (void) const =0
 
virtual int32 GetViewTopRow (void) const =0
 
virtual void SetViewTopRow (const int32 row)=0
 
virtual int32 GetViewLeftColumn (void) const =0
 
virtual void SetViewLeftColumn (const int32 column)=0
 
virtual int32 GetSelectRow (void) const =0
 
virtual void SetSelectRow (const int32 row)=0
 
virtual int32 GetSelectColumn (void) const =0
 
virtual void SetSelectColumn (const int32 column)=0
 
virtual bool isSelection (const int32 column, const int32 row) const =0
 
virtual const WideStringGetCellString (int32 column, int32 row) const =0
 
virtual const WideStringGetCellString (void) const =0
 
virtual bool16 SetCellString (const WideString &string, int32 column, int32 row)=0
 
virtual bool SetCellString (const WideString &string)=0
 
virtual void Invalidate (bool16 forceInvalidate=false)=0
 
virtual PMPoint ConstrainDimensions (const PMPoint &desiredDimen) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

From SDK sample; an interface for an implementation that manages the data in TableCell.

Member Function Documentation

virtual PMPoint ITableCellData::ConstrainDimensions (const PMPointdesiredDimen) const
pure virtual

Before resizing a table of panel widget, Calculate height and width of the table for resizing of the panel. The client can ask if the size makes sense by calling this method. Return size constraints. This method is called from ConstrainDimensions method of panel view widget.

Parameters
desiredDimenThe size of the adjusted table

Implemented in TableCellData.

virtual int32 ITableCellData::GetCellHeight (void ) const
pure virtual

Get the height of each cell.

Implemented in TableCellData.

virtual int32 ITableCellData::GetCellNumberOfColumns (void ) const
pure virtual

Calculate of how many cells go into each column of the table.

Implemented in TableCellData.

virtual int32 ITableCellData::GetCellNumberOfRows (void ) const
pure virtual

Calculate of how many cells go into each row of the table.

Implemented in TableCellData.

virtual const WideString& ITableCellData::GetCellString (int32 column,
int32 row 
) const
pure virtual

Acquire the string data of specified cell.

Parameters
columnSpecifies the column number of the cell.
rowSpecifiesthe row number of the cell.
Returns
String of the specified cell

Implemented in TableCellData.

virtual const WideString& ITableCellData::GetCellString (void ) const
pure virtual

Acquire the string data of chosen Cell.

Implemented in TableCellData.

virtual int32 ITableCellData::GetCellWidth (void ) const
pure virtual

Get the width of each cell.

Implemented in TableCellData.

virtual int32 ITableCellData::GetMaxColumn (void ) const
pure virtual

Get the maximum number of columns.

Implemented in TableCellData.

virtual int32 ITableCellData::GetMaxRow (void ) const
pure virtual

Get the maximum number of rows.

Implemented in TableCellData.

virtual int32 ITableCellData::GetSelectColumn (void ) const
pure virtual

Acquire column of chosen cell.

Implemented in TableCellData.

virtual int32 ITableCellData::GetSelectRow (void ) const
pure virtual

Acquire row of chosen cell.

Implemented in TableCellData.

virtual int32 ITableCellData::GetTableHeight (void ) const
pure virtual

Calculate the height of the table.

Implemented in TableCellData.

virtual int32 ITableCellData::GetTableWidth (void ) const
pure virtual

Calculate the width of the table.

Implemented in TableCellData.

virtual int32 ITableCellData::GetViewLeftColumn (void ) const
pure virtual

Get the column to show at the left of the visible area.

Implemented in TableCellData.

virtual int32 ITableCellData::GetViewTopRow (void ) const
pure virtual

Get the row to show at the top of the visible area.

Implemented in TableCellData.

virtual void ITableCellData::Invalidate (bool16 forceInvalidate = false)
pure virtual

Invalidate the table cells by calling IControlView::Invalidate() on the kTableCellWidgetID widget.

Parameters
forceInvalidatedefault is false.

Implemented in TableCellData.

virtual bool ITableCellData::isSelection (const int32 column,
const int32 row 
) const
pure virtual

Examine whether cell is chosen.

Parameters
rowSpecify row number to examine.
columnSpecify column number to examine.

Implemented in TableCellData.

virtual bool16 ITableCellData::SetCellString (const WideStringstring,
int32 column,
int32 row 
)
pure virtual

Set up the string data of specified Cell.

Parameters
stringString to set in specified cell.
columnSpecifies the column number of the cell.
rowSpecifies the row number of the cell.

Implemented in TableCellData.

virtual bool ITableCellData::SetCellString (const WideStringstring)
pure virtual

Set up a string in chosen cell.

Parameters
stringString to set in selected cell.

Implemented in TableCellData.

virtual void ITableCellData::SetSelectColumn (const int32 column)
pure virtual

Set up column number of chosen cell.

Parameters
rowis 32 bit integer.

Implemented in TableCellData.

virtual void ITableCellData::SetSelectRow (const int32 row)
pure virtual

Set up row number of chosen cell.

Parameters
rowis 32 bit integer.

Implemented in TableCellData.

virtual void ITableCellData::SetViewLeftColumn (const int32 column)
pure virtual

Set up column to show at the left of the visible area.

Parameters
columnis 32 bit integer.

Implemented in TableCellData.

virtual void ITableCellData::SetViewTopRow (const int32 row)
pure virtual

Set up row to show at the top of the visible area.

Parameters
Rowis 32 bit integer.

Implemented in TableCellData.