ITableLayout::Frame Class Reference

#include <ITableLayout.h>

Public Types
enum	Damage {   fdt_none = 0, fdt_inval = 1, fdt_content_notnotified = 2, fdt_content = 3,   fdt_geometry = 4 }

Public Member Functions
virtual bool16	operator== (const Frame &other) const =0
	comparison operators
virtual bool16	operator!= (const Frame &other) const =0
virtual UIDRef	GetFrameRef () const =0
	The kTableFrameBoss.
virtual ITableFrame *	QueryFrame () const =0
virtual bool16	GetIsFirst () const =0
	Indicates if the Frame is the first and/or last Layout Frame.
virtual bool16	GetIsLast () const =0
virtual Damage	GetDamage () const =0
virtual RowRange	GetHeaderRows () const =0
virtual bool16	GetHasAnySubHeaderRows () const =0
virtual bool16	GetIsASubHeaderRow (GridCoord mR) const =0
virtual RowRange	GetBodyRows () const =0
virtual RowRange	GetFooterRows () const =0
virtual bool16	GetAreRowsInSameRange (GridCoord mR1, GridCoord mR2) const =0
virtual ParcelKey	GetParcelKey () const =0
virtual PMPoint	GetStrokeXYOffset () const =0
virtual PMMatrix	GetToParcelMatrix () const =0
virtual PMMatrix	GetToTextFrameMatrix () const =0
virtual PMMatrix	GetToPasteboardMatrix () const =0
virtual PMRect	GetStrokeBounds () const =0
virtual PMRect	GetPathBounds () const =0
virtual PMRect	GetInkBounds () const =0

Detailed Description

Layout Frames contain one more Body Rows and zero or more Header and/or Footer Rows. Each Frame is mapped to a single persistent kTableFrameBoss object.

Member Enumeration Documentation

enum ITableLayout::Frame::Damage

Enumerator
fdt_none	None of the Rows or Parcels are Damaged.
fdt_inval	One or more Rows or Parcels were invalidated due to an attribute change which does not require composition but due to Text system limitations we need to trigger composition of the underlying Story so invalidation will occur.
fdt_content_notnotified	The same as fdt_content except that the WaxLine containing the Frame has NOT been damaged. This state only occurs when the Frame is in overset.
fdt_content	One or more Rows or Parcels have some type of damage (rdt_geometry, pdt_content, etc). Frames with this damage state have a trustworthy ParcelKey and the WaxLine containing the Frame has been damaged.
fdt_geometry	The location of Frame anchor has been changed and the ParcelKey is no longer trusted.

Member Function Documentation

virtual Damage ITableLayout::Frame::GetDamage ( ) const

pure virtual

Frames which are damaged require recomposition.

virtual RowRange ITableLayout::Frame::GetHeaderRows ( ) const

pure virtual

Row spans are ordered and in terms of Model Rows. Since a Model Row can only appear once in any Layout Row this is sufficient to uniquely identify the Layout Row.

virtual PMRect ITableLayout::Frame::GetInkBounds ( ) const

pure virtual

In Frame coordinates.

virtual ParcelKey ITableLayout::Frame::GetParcelKey ( ) const

pure virtual

The ParcelKey is for the containing ParcelList.

virtual PMRect ITableLayout::Frame::GetPathBounds ( ) const

pure virtual

In Frame coordinates.

virtual PMRect ITableLayout::Frame::GetStrokeBounds ( ) const

pure virtual

The Frame coordinate system has (0,0) as the value at the top left corner of the Stroke Bounds.

virtual PMPoint ITableLayout::Frame::GetStrokeXYOffset ( ) const

pure virtual

Returns the XYOffset from the Parcel Content Bounds, which are the same as returned by ITextTiler, to the Left Top corner of the Frame.