IImageViewer Class Reference

#include <iimageviewer.h>

Inheritance diagram for IImageViewer:

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)

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

See also

Class DADMgr , Class BaseInterface, Class IMaxBitmapViewer

Description:

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

Member Enumeration Documentation

DisplayStyle

enum DisplayStyle

Enumerator
IV_FLOATING
IV_DOCKED

{ IV_FLOATING = 0, IV_DOCKED };

WindowPosition

enum WindowPosition

Enumerator
WPos_NULL
WPos_UpperLeft
WPos_LowerLeft
WPos_UpperRight
WPos_LowerRight
WPos_Center
WPos_Renderer
WPos_VideoPostPrimary
WPos_VideoPostSecondary

    {
        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

Show()

virtual void Show ( )

pure virtual

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().

Hide()

virtual void Hide ( )

pure virtual

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.

GetHDisplayWindow()

virtual HWND GetHDisplayWindow ( )

pure virtual

Remarks

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

SetPos()

virtual void SetPos ( int  x, int  y, int  w, int  h  )

pure virtual

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.

GetDisplayStyle()

virtual DisplayStyle GetDisplayStyle ( ) const

pure virtual

Remarks

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

SetContextHelpId()

virtual void SetContextHelpId ( DWORD  helpID )

pure virtual

Remarks

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

Parameters:

DWORD helpID

The help identifier.

GetContextHelpId()

virtual DWORD GetContextHelpId ( ) const

pure virtual

Remarks

This method returns the context help identifier.

SetDADMgr()

virtual void SetDADMgr ( DADMgr *  pDADMgr )

pure virtual

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.

GetDADMgr()

virtual DADMgr * GetDADMgr ( ) const

pure virtual

SetPreEventHandlerCallback()

virtual void SetPreEventHandlerCallback ( PreEventHandlerCallback *  pPreEventHandlerCB )

pure virtual

Remarks

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

Parameters:

PreEventHandlerCallback* pPreEventHandlerCB

A pointer to the callback function.

GetPreEventHandlerCallback()

virtual PreEventHandlerCallback * GetPreEventHandlerCallback ( ) const

pure virtual

Remarks

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

SetPostDisplayCallback()

virtual void SetPostDisplayCallback ( PostDisplayCallback *  pPostDisplayCB )

pure virtual

Remarks

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

Parameters:

PostDisplayCallback* pPostDisplayCB

A pointer to the callback function.

GetPostDisplayCallback()

virtual PostDisplayCallback * GetPostDisplayCallback ( ) const

pure virtual

Remarks

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

GetInterface()

virtual BaseInterface * GetInterface ( Interface_ID  id )

inlinevirtual

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; }