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

#include <IViewPort.h>

Inheritance diagram for IViewPort:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IVIEWPORT }
 
enum  FocusState { kNotInFocus, kInFocus, kInFocusSuspended }
 

Public Member Functions

virtual void SetOwner (IPMUnknown *owner)=0
 
virtual IPMUnknownGetOwner ()=0
 
virtual void BeginFocus ()=0
 
virtual void EndFocus ()=0
 
virtual void SuspendFocus ()=0
 
virtual void ResumeFocus ()=0
 
virtual FocusState GetFocusState () 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

IViewPort serves as a generic "handle" to a viewport boss.

See Also
IViewPortArbitrator

Member Enumeration Documentation

The port's focus state

Member Function Documentation

virtual void IViewPort::BeginFocus ()
pure virtual

Called when this port becomes the target of graphic operations. This is called by the raster port arbitrator in its BeginPortFocus implementation.

See Also
IViewPortArbitrator::BeginPortFocus
virtual void IViewPort::EndFocus ()
pure virtual

Called when this port is torn down by the raster port arbitrator. This is called by the raster port arbitrator in its EndPortFocus implementation.

See Also
ViewPortArbitrator::EndPortFocus
virtual FocusState IViewPort::GetFocusState () const
pure virtual

Returns the port's focus state

Returns
the focus state
See Also
IViewPort::FocusState
virtual IPMUnknown* IViewPort::GetOwner ()
pure virtual

Gets the port's owner. This may be any interface

Returns
The port's owner
virtual void IViewPort::ResumeFocus ()
pure virtual

Called when this port is suspended and is once again about to receive the focus

See Also
ViewPortArbitrator::EndPortFocus
virtual void IViewPort::SetOwner (IPMUnknownowner)
pure virtual

Sets the port's owner. This may be any interface

Note: Internal implementations do not take ownership of owner and will not call AddRef or Release on it

Parameters
ownerIN The port's owner
virtual void IViewPort::SuspendFocus ()
pure virtual

Called when this port has the focus and another port is about to receive the focus

See Also
IViewPortArbitrator::BeginPortFocus