Eaagles::Instruments::LcButton Class Reference

Inherits Eaagles::BasicGL::LcGraphic.

Inherited by Eaagles::Instruments::LcPushButton, and Eaagles::Instruments::LcRotarySwitch.

Inheritance diagram for Eaagles::Instruments::LcButton:

[legend]Collaboration diagram for Eaagles::Instruments::LcButton:

[legend]List of all members.

Public Member Functions
	LcButton ()
virtual bool	setEventId (const int newId)
virtual int	getEventId ()
virtual bool	setType (const int newType)
virtual int	getType ()
virtual bool	setRadius (const float newRadius)
virtual float	getRadius ()
virtual void	drawFunc ()
virtual bool	onSingleClick ()
virtual bool	event (const int event, Basic::LcObject *const obj=0)
Protected Member Functions
bool	setSlotEventId (const Basic::LcNumber *newEvent)
bool	setSlotType (const Basic::LcNumber *newType)
bool	setSlotButtonRadius (const Basic::LcNumber *newRadius)
Private Types
enum	{ SQUARE_BUTTON, CIRCULAR_BUTTON }
Private Attributes
int	eventId
int	type
float	radius

---

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

SQUARE_BUTTON
CIRCULAR_BUTTON

---

Constructor & Destructor Documentation

Eaagles::Instruments::LcButton::LcButton

(

)

---

Member Function Documentation

virtual bool Eaagles::Instruments::LcButton::setEventId

(

const int

newId

)

[inline, virtual]

Sets the Event ID to newID.

virtual int Eaagles::Instruments::LcButton::getEventId

(

)

[inline, virtual]

Returns the event ID.

virtual bool Eaagles::Instruments::LcButton::setType

(

const int

newType

)

[inline, virtual]

Sets the button type to newType. (Square or Circular).

virtual int Eaagles::Instruments::LcButton::getType

(

)

[inline, virtual]

Returns the button type. (Square or Circular).

virtual bool Eaagles::Instruments::LcButton::setRadius

(

const float

newRadius

)

[inline, virtual]

Sets the button radius to newRadius. (Only works when button type is Circular).

virtual float Eaagles::Instruments::LcButton::getRadius

(

)

[inline, virtual]

Returns the button radius.

void Eaagles::Instruments::LcButton::drawFunc

(

)

[virtual]

Draws the button.

Reimplemented from Eaagles::BasicGL::LcGraphic.

bool Eaagles::Instruments::LcButton::onSingleClick

(

)

[virtual]

Right now, this function merely detects when the button has been clicked, but it can be overridden to do anything.

Reimplemented in Eaagles::Instruments::LcPushButton, and Eaagles::Instruments::LcRotarySwitch.

virtual bool Eaagles::Instruments::LcButton::event	(	const int	event,
		Basic::LcObject *const	obj = 0
	)			[virtual]

The event handler for this object.

Reimplemented from Eaagles::Basic::LcComponent.

Reimplemented in Eaagles::Instruments::LcPushButton, and Eaagles::Instruments::LcRotarySwitch.

bool Eaagles::Instruments::LcButton::setSlotEventId

(

const Basic::LcNumber *

newEvent

)

[protected]

Sets the Event ID to newEvent.

bool Eaagles::Instruments::LcButton::setSlotType

(

const Basic::LcNumber *

newType

)

[protected]

Sets the button type to newType. (Square or Circular).

bool Eaagles::Instruments::LcButton::setSlotButtonRadius

(

const Basic::LcNumber *

newRadius

)

[protected]

Sets the button radius to newRadius. (Only works when button is Circular).

---

Member Data Documentation

int Eaagles::Instruments::LcButton::eventId [private]

holds the event number

int Eaagles::Instruments::LcButton::type [private]

holds the type of button being used

float Eaagles::Instruments::LcButton::radius [private]

radius of the button

---