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

#include <HObjects.h>

Public Member Functions

void AddImagePanel (HImagePanel *ip)
 
bool DeleteImagePanel (char const *name, bool doDelete=true, HImagePanel **ip=0)
 
bool DeleteImagePanel (HImagePanel *ip, bool doDelete=true)
 
HImagePanelGetImagePanelByName (char const *name)
 
const char * GetName ()
 
 HImagePanelManagerObject ()
 
- Public Member Functions inherited from HObject
 HObject ()
 

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::HImagePanelManagerObject ( )

Constructs an HImagePanelManagerObject object.

Member Function Documentation

◆ AddImagePanel()

void HImagePanelManagerObject::AddImagePanel ( HImagePanel ip)

This method adds a new image panel to the manager class

Parameters
ipImage Panel Identifier of new image region

◆ DeleteImagePanel() [1/2]

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

This method deletes an existing image panel object given its name

Parameters
nameName of image panel
doDeleteTrue: Call destructor of image panel object
ipPointer to Image Panel object
Returns
True: Found

◆ DeleteImagePanel() [2/2]

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

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

Parameters
ipPointer to Image Panel object
doDeleteTrue: Call destructor of image panel object
Returns
True: Found

◆ GetImagePanelByName()

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

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

Parameters
nameName of image panel
Returns
Pointer to Image Panel

◆ GetName()

const char* HImagePanelManagerObject::GetName ( )
virtual
Returns
The name of the object which is 'imagepanel'.

Implements HObject.

◆ GetStaticName()

static const char* HImagePanelManagerObject::GetStaticName ( )
static
Returns
The name of the object which is 'imagepanel'.

Member Data Documentation

◆ m_ImagePanelList

struct vlist_s* HImagePanelManagerObject::m_ImagePanelList
protected

List of Image panels


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