InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
IWindowPort Class Referenceabstract

#include <IWindowPort.h>

Inheritance diagram for IWindowPort:
IPMUnknown

Public Member Functions

virtual void InvalRect (const PMRect &invalidRect)=0
 
virtual void ValidRect (const PMRect &goodRect)=0
 
virtual void InvalRgn (SysRgn invalidRgn)=0
 
virtual void ValidRgn (SysRgn goodRgn)=0
 
virtual void InvalAll ()=0
 
virtual void ValidAll ()=0
 
virtual PMRect GlobalToLocal (const PMRect &convertRect)=0
 
virtual PMPoint GlobalToLocal (const PMPoint &convertPoint)=0
 
virtual PMRect LocalToGlobal (const PMRect &convertRect)=0
 
virtual PMPoint LocalToGlobal (const PMPoint &convertPoint)=0
 
virtual void InvalRect (const SysRect &invalidRect)=0
 
virtual void ValidRect (const SysRect &goodRect)=0
 
virtual SysRect GlobalToLocal (const SysRect &convertRect)=0
 
virtual SysPoint GlobalToLocal (const SysPoint &convertPoint)=0
 
virtual SysRect LocalToGlobal (const SysRect &convertRect)=0
 
virtual SysPoint LocalToGlobal (const SysPoint &convertPoint)=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

IWindowPort is a viewport interface which defines some generic operations which can be done to a window, or which require a window (ie, GlobalToLocal).

Note: This interface dates back to the beginning of Shuksan (it was called ICanvas originally), and should be re-examined.

See Also
IWindow

Member Function Documentation

virtual PMRect IWindowPort::GlobalToLocal (const PMRect & convertRect)
pure virtual

Converts the specified rectangle from global (screen) coordinates to local (window) coordinates.

Parameters
convertRectIN The rectangle (in global coordinates) to convert
Returns
The rectangle in local coordinates
virtual PMPoint IWindowPort::GlobalToLocal (const PMPoint & convertPoint)
pure virtual

Converts the specified point from global (screen) coordinates to local (window) coordinates.

Parameters
convertPointIN The point (in global coordinates) to convert
Returns
The point in local coordinates
virtual SysRect IWindowPort::GlobalToLocal (const SysRect & convertRect)
pure virtual

Converts the specified rectangle from global (screen) coordinates to local (window) coordinates.

Parameters
convertRectIN The rectangle (in global coordinates) to convert
Returns
The rectangle in local coordinates
virtual SysPoint IWindowPort::GlobalToLocal (const SysPoint & convertPoint)
pure virtual

Converts the specified point from global (screen) coordinates to local (window) coordinates.

Parameters
convertPointIN The point (in global coordinates) to convert
Returns
The point in local coordinates
virtual void IWindowPort::InvalAll ()
pure virtual

Invalidates the entire window (ie., adds it to the system update region).

Note: Does not erase.

virtual void IWindowPort::InvalRect (const PMRect & invalidRect)
pure virtual

Invalidates the specified rectangular area of the window (ie., adds it to the system update region).

Note: Does not erase the specified rectangle.

Parameters
invalidRectIN The rectangle to invalidate
virtual void IWindowPort::InvalRect (const SysRect & invalidRect)
pure virtual

Invalidates the specified rectangular area of the window (ie., adds it to the system update region).

Note: Does not erase the specified rectangle.

Parameters
invalidRectIN The rectangle to invalidate
virtual void IWindowPort::InvalRgn (SysRgn invalidRgn)
pure virtual

Invalidates the specified region of the window (ie., adds it to the system update region).

Note: Does not erase the specified region.

Parameters
invalidRgnIN The region to invalidate
virtual PMRect IWindowPort::LocalToGlobal (const PMRect & convertRect)
pure virtual

Converts the specified rectangle from local (window) coordinates to global (screen) coordinates.

Parameters
convertRectIN The rectangle (in local coordinates) to convert
Returns
The rectangle in global coordinates
virtual PMPoint IWindowPort::LocalToGlobal (const PMPoint & convertPoint)
pure virtual

Converts the specified point from local (window) coordinates to global (screen) coordinates.

Parameters
convertPointIN The point (in local coordinates) to convert
Returns
The point in global coordinates
virtual SysRect IWindowPort::LocalToGlobal (const SysRect & convertRect)
pure virtual

Converts the specified rectangle from local (window) coordinates to global (screen) coordinates.

Parameters
convertRectIN The rectangle (in local coordinates) to convert
Returns
The rectangle in global coordinates
virtual SysPoint IWindowPort::LocalToGlobal (const SysPoint & convertPoint)
pure virtual

Converts the specified point from local (window) coordinates to global (screen) coordinates.

Parameters
convertPointIN The point (in local coordinates) to convert
Returns
The point in global coordinates
virtual void IWindowPort::ValidAll ()
pure virtual

Validates the entire window (ie., removes it from the system update region).

Note: Does not erase.

virtual void IWindowPort::ValidRect (const PMRect & goodRect)
pure virtual

Validates the specified rectangular area of the window (ie. removes it from the system update region).

Parameters
goodRectIN The rectangle to validate
virtual void IWindowPort::ValidRect (const SysRect & goodRect)
pure virtual

Validates the specified rectangular area of the window (ie. removes it from the system update region).

Parameters
goodRectIN The rectangle to validate
virtual void IWindowPort::ValidRgn (SysRgn goodRgn)
pure virtual

Validates the specified region of the window (ie., removes it from the system update region).

Parameters
goodRgnIN The region to validate