Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HImagePanelManagerObject Class Reference

The HImagePanelManagerObject class manages multipe image panels. More...

#include <HObjects.h>

Inheritance diagram for HImagePanelManagerObject:

HObject

List of all members.

Public Member Functions

void AddImagePanel (HImagePanel *ip)
bool DeleteImagePanel (HImagePanel *ip, bool doDelete=true)
bool DeleteImagePanel (char const *name, bool doDelete=true, HImagePanel **ip=0)
HImagePanelGetImagePanelByName (char const *name)
const char * GetName ()
 HImagePanelManagerObject ()

Static Public Member Functions

static const char * GetStaticName ()

Protected Attributes

struct vlist_s * m_ImagePanelList


Detailed Description

The HImagePanelManagerObject class manages multipe image panels.

Constructor & Destructor Documentation

HImagePanelManagerObject::HImagePanelManagerObject (  ) 

Constructs an HImagePanelManagerObject object.


Member Function Documentation

void HImagePanelManagerObject::AddImagePanel ( HImagePanel ip  ) 

This method adds a new image panel to the manager class

Parameters:
ip Image Panel Identifier of new image region

bool HImagePanelManagerObject::DeleteImagePanel ( HImagePanel ip,
bool  doDelete = true 
)

This method deletes an existing image panel object given a pointer to it

Parameters:
ip Pointer to Image Panel object
doDelete True: Call destructor of image panel object
Returns:
True: Found

bool HImagePanelManagerObject::DeleteImagePanel ( char const *  name,
bool  doDelete = true,
HImagePanel **  ip = 0 
)

This method deletes an existing image panel object given its name

Parameters:
name Name of image panel
doDelete True: Call destructor of image panel object
ip Pointer to Image Panel object
Returns:
True: Found

HImagePanel* HImagePanelManagerObject::GetImagePanelByName ( char const *  name  ) 

This method retrieves a pointer to an image panel object given its name

Parameters:
name Name of image panel
Returns:
Pointer to Image Panel

const char* HImagePanelManagerObject::GetName (  )  [virtual]

Returns:
The name of the object which is 'imagepanel'.

Implements HObject.

static const char* HImagePanelManagerObject::GetStaticName (  )  [static]

Returns:
The name of the object which is 'imagepanel'.


Member Data Documentation

struct vlist_s* HImagePanelManagerObject::m_ImagePanelList [read, protected]

List of Image panels


The documentation for this class was generated from the following file: