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.
virtual	~PlotCheckbox ()
	Destructor.
virtual String	text () const =0
	Returns the text for this checkbox.
virtual void	setText (const String &text)=0
	Sets the text for this checkbox.
virtual bool	isChecked () const =0
	Returns true if the checkbox is currently checked, false otherwise.
virtual void	setChecked (bool checked=true)=0
	Sets whether the checkbox is checked or not.
virtual void	registerHandler (PlotCheckboxEventHandlerPtr handler)=0
	Register the given event handler for this checkbox.
virtual vector < PlotCheckboxEventHandlerPtr >	allHandlers () const =0
	Returns all event handlers currently registered on this button.
virtual void	unregisterHandler (PlotCheckboxEventHandlerPtr handler)=0
	Unregisters the given event handler.

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.

casa::PlotCheckbox::PlotCheckbox ( ) [inline]

Constructor.

Definition at line 129 of file PlotPanel.h.

virtual casa::PlotCheckbox::~PlotCheckbox ( ) [inline, virtual]

Destructor.

Definition at line 132 of file PlotPanel.h.

virtual 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 String & text ) [pure virtual]

Sets the text for this checkbox.

virtual 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: