IStandOff Class Reference

#include <IStandOff.h>

Inheritance diagram for IStandOff:

Public Types
enum	{ kDefaultIID = IID_ISTANDOFF }
enum	mode {   kNone = 0, kBand = 1, kNextFrame = 2, kBoundingBox = 3,   kManualContour = 6, kDefaultMode = kNone }
enum	form { kRegular, kInvert, kDefaultForm = kRegular }
enum	side {   kBoth, kLeft, kRight, kToBinding,   kAwayBinding, kLargest, kDefaultSide = kBoth }

Public Member Functions
virtual void	GetBounds (PBPMRect *pRect) const =0
virtual IGeometry *	QueryStandOffGeometry () const =0
virtual bool16	UpdateStandOffGeometry ()=0
virtual IGeometry *	DeleteStandOff ()=0
virtual void	IgnoreUpdateStandOffGeometryCalls (bool bIgnore)=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

Holds the standoff information which is used to cause text in text frames to wrap around the "standoffs of pageitems".

Member Enumeration Documentation

anonymous enum

StandOff's default IID.

enum IStandOff::form

StandOff form.

Enumerator
kRegular	the shape of the StandOff
kInvert	dintrusions become extrusions
kDefaultForm	default StandOff form

enum IStandOff::mode

StandOff mode.

Enumerator
kNone	no effect on text
kBand	text leads past area of strip
kNextFrame	text continues in next column, aka jump wrap
kBoundingBox	text on follows the bounding box of the shape (PM)
kManualContour	text follows the standoff shape
kDefaultMode	default StandOff mode

enum IStandOff::side

StandOff side. Valid with non-kInvert kBoundingBox and kManualContour

Enumerator
kBoth	both sides of the StandOff
kLeft	left side of the StandOff
kRight	right side of the StandOff
kToBinding	side closest to binding
kAwayBinding	side farthest from binding
kLargest	the largest piece. may not actually be a side
kDefaultSide	default StandOff form

Member Function Documentation

virtual IGeometry* IStandOff::DeleteStandOff ( )

pure virtual

called by MainItemObserver on kDeletePageItemCmdBoss, returns always 0

Returns

always nil.

virtual void IStandOff::GetBounds ( PBPMRect *  pRect ) const

pure virtual

This returns the bounding box of the StandOff's geometry

Parameters

pRect

is assigned to bounding box of the standoff's geometry.

virtual void IStandOff::IgnoreUpdateStandOffGeometryCalls ( bool  bIgnore )

pure virtual

IgnoreUpdateStandOffGeometryCalls provides a mechanism for ignoring updates while doing something such as document conversion. Be careful when using this method because it will prevent the composition engine from being notified that anything has changed.

Parameters

bIgnore

[IN]: if true, calls to UpdateStandOffGeometry will become noops until this method is called with 'false'

virtual IGeometry* IStandOff::QueryStandOffGeometry ( ) const

pure virtual

The StandOff itself has a IGeometry which is different from the pageitem's geometry

Returns

the IGeometry interface of the StandOff.

virtual bool16 IStandOff::UpdateStandOffGeometry ( )

pure virtual

If the geometry of the pageitem changes then the the StandOff's geometry has to be adapted.

Returns

kTrue if StandOff was updated.