The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::Button Class Reference

The Button interface represents a standard set of behaviours for any control that wishes to act like a button. More...

#include <vcf/ApplicationKit/Button.h>

Inheritance diagram for VCF::Button:

List of all members.

Public Member Functions
virtual	~Button ()
virtual void	click ()=0
	This represents the user pressing the button, which then invokes whatever command is associated with the button.
virtual void	setDefault (const bool &defaultButton)=0
	sets this button as the default button.
virtual bool	isDefault ()=0
virtual void	addButtonClickHandler (EventHandler *handler)=0
	Adds a new EventHandler for button click events.
virtual void	removeButtonClickHandler (EventHandler *handler)=0
	Removes an EventHandler for button click events.

---

Detailed Description

The Button interface represents a standard set of behaviours for any control that wishes to act like a button.

Currently the basic behaviour is to fire click events when the click() method is invoked.

---

Constructor & Destructor Documentation

virtual VCF::Button::~Button (   )  [inline, virtual]

---

Member Function Documentation

virtual void VCF::Button::addButtonClickHandler (  EventHandler *  handler  )  [pure virtual]

Adds a new EventHandler for button click events. Implemented in VCF::CommandButton, VCF::PushButton, VCF::ToggledButton, and VCF::ToolbarItem.

virtual void VCF::Button::click (   )  [pure virtual]

This represents the user pressing the button, which then invokes whatever command is associated with the button. It should be called in the implementing controls class whenever the control is "clicked" on (see Control::mouseClick() ), it can also be called programmatically as well. Implemented in VCF::CommandButton, VCF::PushButton, VCF::ToggledButton, and VCF::ToolbarItem.

virtual bool VCF::Button::isDefault (   )  [pure virtual]

Implemented in VCF::CommandButton, VCF::PushButton, VCF::ToggledButton, and VCF::ToolbarItem.

virtual void VCF::Button::removeButtonClickHandler (  EventHandler *  handler  )  [pure virtual]

Removes an EventHandler for button click events. Implemented in VCF::CommandButton, VCF::PushButton, VCF::ToggledButton, and VCF::ToolbarItem.

virtual void VCF::Button::setDefault (  const bool &  defaultButton  )  [pure virtual]

sets this button as the default button. A default button will have it's click() event called whenever the enter key is hit. Implemented in VCF::CommandButton, VCF::PushButton, VCF::ToggledButton, and VCF::ToolbarItem.

---

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

• vcf/ApplicationKit/Button.h

Comments or Suggestions?    License Information