InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ITableAttrReport Class Referenceabstract

#include <ITableAttrReport.h>

Inheritance diagram for ITableAttrReport:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITABLEATTRREPORT }
 
enum  EAttributeType { eRow, eColumn, eCell, eTable }
 
enum  ETableDamageNotification {
  tan_geometry_first = 0x00000001, tan_geometry_last = 0x00000002, tan_bodyDraw = 0x00000004, tan_allDraw = 0x0000000c,
  tan_bodyTopBottomInval = 0x00000010, tan_bodyTopBottomStroke = 0x00000030, tan_allTopBottomInval = 0x00000050, tan_allTopBottomStroke = 0x000000f0,
  tan_allLeftRightInval = 0x00000100, tan_bodyStructure = 0x00000200, tan_allStructure = 0x00000600, tan_headerGeometry = 0x00000800,
  tan_footerGeometry = 0x00001000, tan_outerLeftDraw = 0x00002000, tan_outerLeftInval = 0x00004000, tan_outerLeftStroke = 0x0000c000,
  tan_outerTopDraw = 0x00010000, tan_outerTopInval = 0x00020000, tan_outerTopStroke = 0x00060000, tan_outerRightDraw = 0x00080000,
  tan_outerRightInval = 0x00100000, tan_outerRightStroke = 0x00300000, tan_outerBottomDraw = 0x00400000, tan_outerBottomInval = 0x00800000,
  tan_outerBottomStroke = 0x01800000, tan_all = 0x01b6bff3
}
 
enum  ERowDamageNotification { ran_geometry = 0x01, ran_structure = 0x02, ran_height = 0x07, ran_all = 0x07 }
 
enum  EColumnDamageNotification { can_structure = 0x01, can_width = 0x03, can_all = 0x03 }
 
enum  ECellDamageNotification {
  clan_draw = 0x0001, clan_inval = 0x0002, clan_content = 0x0004, clan_structure = 0x0008,
  clan_leftStroke = 0x001a, clan_topStroke = 0x002a, clan_rightStroke = 0x004a, clan_bottomStroke = 0x008a,
  clan_all = 0x00fe
}
 

Public Member Functions

virtual void AppendDescription (PMString &into, IDataBase *db) const =0
 
virtual EAttributeType GetType (void) const =0
 
virtual int32 GetDamageNotification (void) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface is on every table attribute and is the "designator" interface. It is used to get info about the attribute. Similar to IAttrReport for text.

Member Function Documentation

virtual void ITableAttrReport::AppendDescription (PMString & into,
IDataBase * db 
) const
pure virtual

Add a descriptive name to the end of the passed in string.

Parameters
intoOUT parameter for description of this attribute
dbparameter apparently not required, can be nil
virtual int32 ITableAttrReport::GetDamageNotification (void ) const
pure virtual

Determine the type of damage this attribute causes

Returns
A value from the cooresponding damage enum. For example, if it's a cell attribute return a value from the ECellDamageNotification enum.
virtual EAttributeType ITableAttrReport::GetType (void ) const
pure virtual

Determine the type of this attribute.

Returns
the type of this attribute.