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

#include <IAGMPortData.h>

Inheritance diagram for IAGMPortData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IAGMPORTDATA }
 

Public Member Functions

virtual void SetPort (AGMPort *port)=0
 
virtual AGMPort * GetPort () const =0
 
virtual int32 GetPortType () 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

Simple data interface for storing an AGMPort. The port is implicitly ref counted.

Member Function Documentation

virtual AGMPort* IAGMPortData::GetPort () const
pure virtual

Returns the current port.

Returns
the current port, or nil if there is no current port.
virtual int32 IAGMPortData::GetPortType () const
pure virtual

Returns the port's type.

Note: Port types are for internal use only and are intentionally not documented.

Returns
the port's type
virtual void IAGMPortData::SetPort (AGMPort * port)
pure virtual

Sets the current AGM port ptr. Implicitly adds a reference to the port.

Parameters
portIN The port to store