IImageViewer Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class DADMgr , Class BaseInterface, Class IMaxBitmapViewer

Description:

This class is available in release 4.0 and later only.

This class represents an abstract interface class for an image viewer.

#include <iimageviewer.h>

Inheritance diagram for IImageViewer:

List of all members.

Classes
class	PostDisplayCallback
class	PreEventHandlerCallback
Public Types
enum	DisplayStyle { IV_FLOATING = 0, IV_DOCKED }
enum	WindowPosition {   WPos_NULL = 0, WPos_UpperLeft, WPos_LowerLeft, WPos_UpperRight,   WPos_LowerRight, WPos_Center, WPos_Renderer = 10, WPos_VideoPostPrimary,   WPos_VideoPostSecondary }
Public Member Functions
virtual void	Show ()=0
virtual void	Hide ()=0
virtual HWND	GetHDisplayWindow ()=0
virtual void	SetPos (int x, int y, int w, int h)=0
virtual DisplayStyle	GetDisplayStyle () const =0
virtual void	SetContextHelpId (DWORD helpID)=0
virtual DWORD	GetContextHelpId () const =0
virtual void	SetDADMgr (DADMgr *pDADMgr)=0
virtual DADMgr *	GetDADMgr () const =0
virtual void	SetPreEventHandlerCallback (PreEventHandlerCallback *pPreEventHandlerCB)=0
virtual PreEventHandlerCallback *	GetPreEventHandlerCallback () const =0
virtual void	SetPostDisplayCallback (PostDisplayCallback *pPostDisplayCB)=0
virtual PostDisplayCallback *	GetPostDisplayCallback () const =0
virtual BaseInterface *	GetInterface (Interface_ID id)

---

Member Enumeration Documentation

enum DisplayStyle

Search for all occurrences

Enumerator:

IV_FLOATING	Search for all occurrences
IV_DOCKED	Search for all occurrences

{ IV_FLOATING = 0, IV_DOCKED };

enum WindowPosition

Search for all occurrences

Enumerator:

WPos_NULL	Search for all occurrences
WPos_UpperLeft	Search for all occurrences
WPos_LowerLeft	Search for all occurrences
WPos_UpperRight	Search for all occurrences
WPos_LowerRight	Search for all occurrences
WPos_Center	Search for all occurrences
WPos_Renderer	Search for all occurrences
WPos_VideoPostPrimary	Search for all occurrences
WPos_VideoPostSecondary	Search for all occurrences

    {
        WPos_NULL = 0,
        WPos_UpperLeft,
        WPos_LowerLeft,
        WPos_UpperRight,
        WPos_LowerRight,
        WPos_Center,

        // the following are used for automatic save and restore
        WPos_Renderer = 10,
        WPos_VideoPostPrimary,
        WPos_VideoPostSecondary,
    };

---

Member Function Documentation

virtual void Show

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method will show the image viewer. In the IMaxBitmapViewer class, the Display() method must initially be used to display the viewer; this method only displays the viewer after using Hide().

virtual void Hide

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method will hide the image viewer. In the IMaxBitmapViewer class, the UnDisplay() method should be used to close the viewer when done; use Hide() to temporarily hide the window.

virtual HWND GetHDisplayWindow

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method returns the handle to the display window of the image viewer.

virtual void SetPos	(	int	x,
		int	y,
		int	w,
		int	h
	)		[pure virtual]

Search for all occurrences

Remarks:

This method allows you to set the position of the image viewer window.

Parameters:

int x, y

The position of the window.

int w, h

The width and height of the window.

virtual DisplayStyle GetDisplayStyle

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method will return the display style used by the image viewer window, which is either IV_FLOATING or IV_DOCKED.

virtual void SetContextHelpId

(

DWORD

helpID

)

[pure virtual]

Search for all occurrences

Remarks:

This method allows you to set the context help identifier for the image viewer.

Parameters:

DWORD helpID

The help identifier.

virtual DWORD GetContextHelpId

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method returns the context help identifier.

virtual void SetDADMgr

(

DADMgr *

pDADMgr

)

[pure virtual]

Search for all occurrences

Remarks:

This method allows you to set the drag and drop manager which should be used for the image viewer.

Parameters:

DADMgr *pDADMgr

A pointer to the drag and drop manager.

virtual DADMgr* GetDADMgr

(

)

const [pure virtual]

Search for all occurrences

virtual void SetPreEventHandlerCallback

(

PreEventHandlerCallback *

pPreEventHandlerCB

)

[pure virtual]

Search for all occurrences

Remarks:

This method allows you to set the pre-event handler callback method.

Parameters:

PreEventHandlerCallback* pPreEventHandlerCB

A pointer to the callback function.

virtual PreEventHandlerCallback* GetPreEventHandlerCallback

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method returns a pointer to the pre-event handler callback function.

virtual void SetPostDisplayCallback

(

PostDisplayCallback *

pPostDisplayCB

)

[pure virtual]

Search for all occurrences

Remarks:

This method allows you to set the post display callback function.

Parameters:

PostDisplayCallback* pPostDisplayCB

A pointer to the callback function.

virtual PostDisplayCallback* GetPostDisplayCallback

(

)

const [pure virtual]

Search for all occurrences

Remarks:

This method returns a pointer to the post display callback function.

virtual BaseInterface* GetInterface

(

Interface_ID

id

)

[inline, virtual]

Search for all occurrences

Remarks:

This method provides a way to extend the class with interfaces.

Parameters:

Interface_ID id

The interface ID.

Default Implementation:

{ return NULL; }

Reimplemented in IMaxBitmapViewer.

{ UNUSED_PARAM(id); return NULL; }