casa::QtSingleRegionShape Class Reference

Widget for displaying a single region in the list of a QtRegionShapeManager. More...

#include <QtSingleRegionShape.qo.h>

List of all members.

Public Slots
void	edit ()
	Show a QtEditRegionShape for editing.
Public Member Functions
	QtSingleRegionShape (RegionShape *shape, QtRegionShapeManager *parent, bool reportDrawErrors=false, RegionShape *compositeParent=NULL)
	Constructor which takes the RegionShape, the manager parent, and the optional composite parent.
	~QtSingleRegionShape ()
	Destructor.
RegionShape *	shape ()
	Returns the RegionShape.
RegionShape *	compositeParent ()
	Returns this shape's composite parent, or NULL if it has none.
QtRegionShapeManager *	manager ()
	Returns the parent manager.
QtDisplayPanel *	panel ()
	Returns the display panel.
void	setShouldDelete (bool shouldDelete=true)
	Sets whether the QtSingleRegionShape should delete its RegionShape during destruction or not.
void	refresh ()
	Refreshes the GUI display.
bool	isShown () const
	Returns whether this shape is currently showing (registered) on the panel or not.
void	showHide (bool show, bool reportErrors=true)
	Show/hide the region shape by registering/unregistering.
Private Slots
void	showHide_ (bool show)
	Slot for checkbox.
void	deleteShape ()
	Deletes this shape by unregistering the region shape and then calling the manager's delete method.
Private Member Functions
void	setupGUI ()
	Sets up the GUI widgets to display information from the underlying region shape.
void	registerShape ()
	Registers the shape on the underlying display panel, if applicable.
void	unregisterShape ()
	Unregisters the shape on the underlying display panel, if applicable.
Private Attributes
RegionShape *	m_shape
RegionShape *	m_compositeParent
QtRegionShapeManager *	m_parent
QtDisplayPanel *	m_panel
bool	m_shouldDelete
Friends
class	QtEditRegionShape

---

Detailed Description

Widget for displaying a single region in the list of a QtRegionShapeManager.

QtSingleRegionShape is the main interaction between the GUI classes and the underlying RegionShape. Provides widgets for:

• showing/hiding the region shape
• deleting the region shape
• editing the region shape

Is also responsible for registering/unregistering the region shape on the parent QtDisplayPanel as necessary.

Definition at line 53 of file QtSingleRegionShape.qo.h.

---

Constructor & Destructor Documentation

casa::QtSingleRegionShape::QtSingleRegionShape	(	RegionShape *	shape,
		QtRegionShapeManager *	parent,
		bool	reportDrawErrors = false,
		RegionShape *	compositeParent = NULL
	)

Constructor which takes the RegionShape, the manager parent, and the optional composite parent.

If a composite parent is given, some behaviors are different. The constructor will register the RegionShape IF compositeParent is NULL.

casa::QtSingleRegionShape::~QtSingleRegionShape

(

)

Destructor.

---

Member Function Documentation

RegionShape* casa::QtSingleRegionShape::compositeParent

(

)

Returns this shape's composite parent, or NULL if it has none.

void casa::QtSingleRegionShape::deleteShape

(

)

[private, slot]

Deletes this shape by unregistering the region shape and then calling the manager's delete method.

void casa::QtSingleRegionShape::edit

(

)

[slot]

Show a QtEditRegionShape for editing.

bool casa::QtSingleRegionShape::isShown

(

)

const

Returns whether this shape is currently showing (registered) on the panel or not.

QtRegionShapeManager* casa::QtSingleRegionShape::manager

(

)

Returns the parent manager.

QtDisplayPanel* casa::QtSingleRegionShape::panel

(

)

Returns the display panel.

void casa::QtSingleRegionShape::refresh

(

)

Refreshes the GUI display.

void casa::QtSingleRegionShape::registerShape

(

)

[private]

Registers the shape on the underlying display panel, if applicable.

void casa::QtSingleRegionShape::setShouldDelete

(

bool

shouldDelete = true

)

Sets whether the QtSingleRegionShape should delete its RegionShape during destruction or not.

void casa::QtSingleRegionShape::setupGUI

(

)

[private]

Sets up the GUI widgets to display information from the underlying region shape.

RegionShape* casa::QtSingleRegionShape::shape

(

)

Returns the RegionShape.

void casa::QtSingleRegionShape::showHide	(	bool	show,
		bool	reportErrors = true
	)

Show/hide the region shape by registering/unregistering.

Referenced by showHide_().

void casa::QtSingleRegionShape::showHide_

(

bool

show

)

[inline, private, slot]

Slot for checkbox.

Definition at line 119 of file QtSingleRegionShape.qo.h.

References showHide().

void casa::QtSingleRegionShape::unregisterShape

(

)

[private]

Unregisters the shape on the underlying display panel, if applicable.

---

Friends And Related Function Documentation

friend class QtEditRegionShape [friend]

Definition at line 56 of file QtSingleRegionShape.qo.h.

---

Member Data Documentation

RegionShape* casa::QtSingleRegionShape::m_compositeParent [private]

Definition at line 102 of file QtSingleRegionShape.qo.h.

QtDisplayPanel* casa::QtSingleRegionShape::m_panel [private]

Definition at line 104 of file QtSingleRegionShape.qo.h.

QtRegionShapeManager* casa::QtSingleRegionShape::m_parent [private]

Definition at line 103 of file QtSingleRegionShape.qo.h.

RegionShape* casa::QtSingleRegionShape::m_shape [private]

Definition at line 101 of file QtSingleRegionShape.qo.h.

bool casa::QtSingleRegionShape::m_shouldDelete [private]

Definition at line 105 of file QtSingleRegionShape.qo.h.

---

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

• code/display/RegionShapes/QtSingleRegionShape.qo.h