casa::PlotCheckbox Class Reference

Generic class for a checkbox that goes on a PlotPanel. More...

#include <PlotPanel.h>

Inheritance diagram for casa::PlotCheckbox:

Public Member Functions
	PlotCheckbox ()
	Constructor. More...
virtual	~PlotCheckbox ()
	Destructor. More...
virtual casacore::String	text () const =0
	Returns the text for this checkbox. More...
virtual void	setText (const casacore::String &text)=0
	Sets the text for this checkbox. More...
virtual bool	isChecked () const =0
	Returns true if the checkbox is currently checked, false otherwise. More...
virtual void	setChecked (bool checked=true)=0
	Sets whether the checkbox is checked or not. More...
virtual void	registerHandler (PlotCheckboxEventHandlerPtr handler)=0
	Register the given event handler for this checkbox. More...
virtual std::vector < PlotCheckboxEventHandlerPtr >	allHandlers () const =0
	Returns all event handlers currently registered on this button. More...
virtual void	unregisterHandler (PlotCheckboxEventHandlerPtr handler)=0
	Unregisters the given event handler. More...
Public Member Functions inherited from casa::PlotWidget
	PlotWidget ()
	Constructor. More...
virtual	~PlotWidget ()
	Destructor. More...
virtual bool	isEnabled () const =0
	Returns true if the widget is currently enabled, false otherwise. More...
virtual void	setEnabled (bool enabled=true)=0
	Enables/disables the widget. More...
virtual bool	isVisible () const =0
	Returns true if the widget is currently visible. More...
virtual void	setVisible (bool visible=true)=0
	Show/hide the widget. More...
virtual casacore::String	tooltip () const =0
	Returns the tooltip for this widget. More...
virtual void	setTooltip (const casacore::String &text)=0
	Sets the tooltip for this widget. More...

Detailed Description

Generic class for a checkbox that goes on a PlotPanel.

A checkbox has properties that can be set, as well as registration for event handlers. A checkbox can only be seen/interacted with on a PlotPanel.

Definition at line 126 of file PlotPanel.h.

Constructor & Destructor Documentation

casa::PlotCheckbox::PlotCheckbox ( )

inline

Constructor.

Definition at line 129 of file PlotPanel.h.

virtual casa::PlotCheckbox::~PlotCheckbox ( )

inlinevirtual

Destructor.

Definition at line 132 of file PlotPanel.h.

Member Function Documentation

virtual std::vector<PlotCheckboxEventHandlerPtr> casa::PlotCheckbox::allHandlers ( ) const

pure virtual

Returns all event handlers currently registered on this button.

virtual bool casa::PlotCheckbox::isChecked ( ) const

pure virtual

Returns true if the checkbox is currently checked, false otherwise.

virtual void casa::PlotCheckbox::registerHandler ( PlotCheckboxEventHandlerPtr  handler )

pure virtual

Register the given event handler for this checkbox.

virtual void casa::PlotCheckbox::setChecked ( bool  checked = true )

pure virtual

Sets whether the checkbox is checked or not.

virtual void casa::PlotCheckbox::setText ( const casacore::String &  text )

pure virtual

Sets the text for this checkbox.

virtual casacore::String casa::PlotCheckbox::text ( ) const

pure virtual

Returns the text for this checkbox.

virtual void casa::PlotCheckbox::unregisterHandler ( PlotCheckboxEventHandlerPtr  handler )

pure virtual

Unregisters the given event handler.

---

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

• casa/code/graphics/GenericPlotter/PlotPanel.h