os::CheckBox Class Reference
[The Syllable Graphical User Interface API]

2-state check box. More...

Inheritance diagram for os::CheckBox:

List of all members.

Public Member Functions
	CheckBox (Rect cFrame, const String &cName, const String &cLabel, Message *pcMessage, uint32 nResizeMask=CF_FOLLOW_LEFT|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW|WID_CLEAR_BACKGROUND|WID_FULL_UPDATE_ON_RESIZE)
	~CheckBox ()
virtual Point	GetPreferredSize (bool bLargest) const
virtual void	MouseDown (const Point &cPosition, uint32 nButtons)
	Hook called by the system when a mouse button is pressed.
virtual void	MouseUp (const Point &cPosition, uint32 nButtons, Message *pcData)
	Hook called by the system when a mouse button is release.
virtual void	KeyDown (const char *pzString, const char *pzRawString, uint32 nQualifiers)
	Hook called by the system when a key is pressed while the view has focus.
virtual void	KeyUp (const char *pzString, const char *pzRawString, uint32 nQualifiers)
	Hook called by the system when a key is released while the view has focus.
virtual void	Paint (const Rect &cUpdateRect)
	Called by the system update "damaged" areas of the view.
virtual void	PostValueChange (const Variant &cNewValue)
virtual void	LabelChanged (const String &cNewLabel)
virtual void	EnableStatusChanged (bool bIsEnabled)
virtual bool	Invoked (Message *pcMessage)
	Intercept outgoing messages.
virtual void	Activated (bool bIsActive)
	Hook called when the view gain or loose focus.
Classes
class	Private

---

Detailed Description

Description:

See also:

Author:

Kurt Skauen ([email protected])

---

Constructor & Destructor Documentation

CheckBox::CheckBox	(	Rect	cFrame,
		const String &	cName,
		const String &	cLabel,
		Message *	pcMessage,
		uint32	nResizeMask = CF_FOLLOW_LEFT|CF_FOLLOW_TOP,
		uint32	nFlags = WID_WILL_DRAW|WID_CLEAR_BACKGROUND|WID_FULL_UPDATE_ON_RESIZE
	)

CheckBox::~CheckBox

(

)

---

Member Function Documentation

Point CheckBox::GetPreferredSize

(

bool

bLargest

)

const [virtual]

Reimplemented from os::View.

void CheckBox::MouseDown	(	const Point &	cPosition,
		uint32	nButtons
	)			[virtual]

Description:

This member is called from the window thread whenever a mouse button is clicked above the view. You can overload this member if your view need to know about mouse-down events.

A view will not automatically take focus when clicked so if you want that behaviour you must call MakeFocus() from an overloaded version of this member.

The default implementation of this member will call MouseDown() on it's parent view if one exists.

Parameters:

	cPosition	Mouse position in the views coordinate system at the time the mouse was pressed.
	nButtons	Index of the pressed button. Buttons start at 1 for the left button, 2 for the right button, 3 for the middle button. Additional buttons might be supported by the mouse driver and will then be assigned numbers from 4 and up.

See also:

MouseUp(), MouseMove(), WheelMoved()

Author:

Kurt Skauen ([email protected])

Reimplemented from os::View.

void CheckBox::MouseUp	(	const Point &	cPosition,
		uint32	nButtons,
		Message *	pcData
	)			[virtual]

Description:

This member is called from the window thread whenever a mouse button is released above the view. You can overload this member if your view need to know about mouse-up events or if your view support drag and drop.

If mouse-up was the result of ending a drag and drop operation the pcData member will point to a Message containing the dragged data. Look at BeginDrag() for a more detailed description of the drag and drop system.

The default implementation of this member will call MouseDown() on it's parent view if one exists.

Parameters:

	cPosition	Mouse position in the views coordinate system at the time the mouse was pressed.
	nButtons	Index of the pressed button. Buttons start at 1 for the left button, 2 for the right button, 3 for the middle button. Additional buttons might be supported by the mouse driver and will then be assigned numbers from 4 and up.
	pcData	Pointer to a Message object containing the dragged data if this mouse-up was the end of a drag and drop operation. If no data was dragged it will be NULL.

See also:

MouseDown(), MouseMove(), WheelMoved()

Author:

Kurt Skauen ([email protected])

Reimplemented from os::View.

void CheckBox::KeyDown	(	const char *	pzString,
		const char *	pzRawString,
		uint32	nQualifiers
	)			[virtual]

Description:

Overload this member if your view need to handle keyboard input. This member is called to allow the view to handle M_KEY_DOWN messages. The most common members are exctracted from the message and passed as parameters but you might need to obtain the raw message with os::Looper::GetCurrentMessage() and find some members yourself if you the data you needed are not passed in.

For example if you need the raw key-code for the pressed key you will have to lookup the "_raw_key" member from the message.

Parameters:

	pzString	String containing a single UTF-8 encoded character. This is the character generated by the pressed key according to the current keymap accounting for any qualifiers that might be pressed.
	pzRawString	Same as pzString except that the key is converted without accounting for qualifiers. Ie. if 'A' is pressed while pressing <SHIFT> pzString will contain 'A' and pzRawString will contain 'a'.
	nQualifiers	Bitmask describing which qualifiers that was active when the key was pressed.

See also:

KeyUp(), os::Looper::GetCurrentMessage()

Author:

Kurt Skauen ([email protected])

Reimplemented from os::View.

void CheckBox::KeyUp	(	const char *	pzString,
		const char *	pzRawString,
		uint32	nQualifiers
	)			[virtual]

Description:

This is the counterpart to KeyDown().

See also:

KeyDown()

Author:

Kurt Skauen ([email protected])

Reimplemented from os::View.

void CheckBox::Paint

(

const Rect &

cUpdateRect

)

[virtual]

Description:

Note:

Warning:

Parameters:

cUpdateRect

A rectangle enclosing all damaged areas. This is just a rough "worst-case", further fine-grained clipping will be performed by the Application Server to avoid updating non-damaged pixels and make the update as fast and flicker-free as possible.

See also:

Invalidate(), Flush()

Author:

Kurt Skauen ([email protected])

Reimplemented from os::View.

void CheckBox::PostValueChange

(

const Variant &

cNewValue

)

[virtual]

Reimplemented from os::Control.

void CheckBox::LabelChanged

(

const String &

cNewLabel

)

[virtual]

Reimplemented from os::Control.

void CheckBox::EnableStatusChanged

(

bool

bIsEnabled

)

[virtual]

Implements os::Control.

bool CheckBox::Invoked

(

Message *

pcMessage

)

[virtual]

Description:

This member is called from Invoke() just before a message is sendt to the target.

This allow classes that inherits from os::Invoker to add data to or otherwhice modify the message before it is sendt. The message can also be canceled entirely by returning false from this member.

The message passed to Invoked() is a copy of the internal message or the message passed to Invoke() (if any) so any changes made here will not affect the internal message or the message passed to Invoke(). When this method returns the message will imidiatly be sendt to the target and then discarded (unless false is returned in which case the message is simply discarded).

The default implementation of this member does nothing and return true.

Parameters:

pcMessage

Pointer to the message that is about to be sendt. You can do any modification you like to this message (but never delete it).

Returns:

Normally you should return true to indicate that the message should be sendt. You can however return false if you for some reason want to cancel the invokation.

See also:

Invoke(), SetMessage(), SetTarget()

Author:

Kurt Skauen ([email protected])

Reimplemented from os::Control.

void CheckBox::Activated

(

bool

bIsActive

)

[virtual]

Description:

This is a callback member that can be overloaded by derived classes to learn when the view is activated and when it is deactivated. The bIsActive parameter tell whether the focus was lost or gained.

The view has focus when it is the active view in the active window.

Note:

This is a hook function that is called by the system to notify about an event. You should never call this member yourself.

The window is locked when this member is called.

Parameters:

bIsActive

- true if the view gain and false if it loose focus.

See also:

MakeFocus(), WindowActivated()

Author:

Kurt Skauen ([email protected])

Reimplemented from os::View.

---