IViewPortArbitrator Class Reference

#include <IViewPortArbitrator.h>

Inheritance diagram for IViewPortArbitrator:

Public Types
enum	{ kDefaultIID = IID_IVIEWPORTARBITRATOR }

Public Member Functions
virtual void	BeginPortFocus (IViewPort *port)=0
virtual void	EndPortFocus (IViewPort *port)=0
virtual IViewPort *	GetPortInFocus () const =0
virtual IRasterPort *	QueryNonMarkingRasterViewPort ()=0
virtual void	ReleaseCaches ()=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

IViewPortArbitrator is a singleton interface responsible for maintaining the internal stack of view ports.

Warning: This interface is intended for internal use only and may be removed in a future release

See Also

IViewPort

Member Function Documentation

virtual void IViewPortArbitrator::BeginPortFocus ( IViewPort *  port )

pure virtual

Pushes a port onto the stack of view ports and gives it the focus. The port currently at the top of the stack, if any, is suspended.

Note: the arbitrator will not take ownership of the port. The caller is responsible for ensuring that it remains valid until a call to EndPortFocus

Parameters

port	IN The port to receive focus

See Also

IViewPort::BeginFocus

virtual void IViewPortArbitrator::EndPortFocus ( IViewPort *  port )

pure virtual

Removes focus from port, which is assumed to be at the top of the stack, and pops it from the stack. The port at the top of the stack at this point, if any, is resumed

Parameters

port	IN The port to be removed from the stack

See Also

IViewPort::EndFocus

virtual IViewPort* IViewPortArbitrator::GetPortInFocus ( ) const

pure virtual

Gets the port at the top of the port stack, if any. The returned pointer is not AddRef'd

Returns

The port with focus

virtual IRasterPort* IViewPortArbitrator::QueryNonMarkingRasterViewPort ( )

pure virtual

Returns a raster based viewport. This viewport is not associated with a window, so any drawing to this port will not appear on screen. Often used to draw into just to check which pixels would be colored by the drawing.

Returns

a global non-marking raster viewport.

virtual void IViewPortArbitrator::ReleaseCaches ( )

pure virtual

Tells the ViewPortArbitrator to release internal caches. Internal use only.