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

Base class for GUI controls. More...

Inheritance diagram for os::Control:

os::View os::Invoker os::Handler os::Button os::CheckBox os::ColorSelector os::IconView os::ListView os::RadioButton os::ScrollBar os::Slider os::Spinner os::TextView List of all members.

Public Member Functions

 Control (const Rect &cFrame, const String &cName, const String &cLabel, Message *pcMessage, uint32 nResizeMask, uint32 nFlags=WID_WILL_DRAW|WID_CLEAR_BACKGROUND)
 ~Control ()
virtual void AttachedToWindow (void)
virtual void DetachedFromWindow (void)
virtual bool PreValueChange (Variant *pcNewValue)
virtual void PostValueChange (const Variant &cNewValue)
virtual void LabelChanged (const String &cNewLabel)
virtual void EnableStatusChanged (bool bIsEnabled)=0
virtual bool Invoked (Message *pcMessage)
 Intercept outgoing messages.
virtual void SetEnable (bool bEnabled)
virtual bool IsEnabled (void) const
virtual void SetLabel (const String &cLabel)
virtual String GetLabel (void) const
virtual void SetValue (Variant cValue, bool bInvoke=true)
virtual Variant GetValue () const
virtual void __CTRL_reserved1__ ()
virtual void __CTRL_reserved2__ ()
virtual void __CTRL_reserved3__ ()
virtual void __CTRL_reserved4__ ()
virtual void __CTRL_reserved5__ ()


class  Private

Detailed Description

See also:
Kurt Skauen ([email protected])

Constructor & Destructor Documentation

Control::Control ( const Rect cFrame,
const String cName,
const String cLabel,
Message pcMessage,
uint32  nResizeMask,

Control::~Control (  ) 

Member Function Documentation

void Control::AttachedToWindow ( void   )  [virtual]

Reimplemented from os::View.

Reimplemented in os::ColorSelector, os::DirectoryView, os::IconDirectoryView, os::RadioButton, and os::Slider.

void Control::DetachedFromWindow ( void   )  [virtual]

Reimplemented from os::View.

Reimplemented in os::DirectoryView, and os::IconDirectoryView.

bool Control::PreValueChange ( Variant pcNewValue  )  [virtual]

void Control::PostValueChange ( const Variant cNewValue  )  [virtual]

Reimplemented in os::Button, os::CheckBox, os::ColorSelector, os::RadioButton, os::ScrollBar, os::Slider, and os::Spinner.

void Control::LabelChanged ( const String cNewLabel  )  [virtual]

Reimplemented in os::Button, os::CheckBox, os::ListView, os::RadioButton, os::ScrollBar, os::Spinner, and os::TextView.

virtual void os::Control::EnableStatusChanged ( bool  bIsEnabled  )  [pure virtual]

Implemented in os::Button, os::CheckBox, os::ColorSelector, os::IconView, os::ListView, os::RadioButton, os::ScrollBar, os::Slider, os::Spinner, and os::TextView.

bool Control::Invoked ( Message pcMessage  )  [virtual]

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.
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).
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()
Kurt Skauen ([email protected])

Reimplemented from os::Invoker.

Reimplemented in os::Button, os::CheckBox, os::ListView, os::RadioButton, os::ScrollBar, os::Slider, os::Spinner, and os::TextView.

void Control::SetEnable ( bool  bEnabled  )  [virtual]

Reimplemented in os::Spinner.

bool Control::IsEnabled ( void   )  const [virtual]

Reimplemented in os::Spinner.

void Control::SetLabel ( const String cLabel  )  [virtual]

String Control::GetLabel ( void   )  const [virtual]

void Control::SetValue ( Variant  cValue,
bool  bInvoke = true 
) [virtual]

Reimplemented in os::ColorSelector, and os::TextView.

Variant Control::GetValue (  )  const [virtual]

Reimplemented in os::TextView.

void Control::__CTRL_reserved1__ (  )  [virtual]

void Control::__CTRL_reserved2__ (  )  [virtual]

void Control::__CTRL_reserved3__ (  )  [virtual]

void Control::__CTRL_reserved4__ (  )  [virtual]

void Control::__CTRL_reserved5__ (  )  [virtual]

Generated on Sat May 9 22:51:22 2009 for Syllable higlevel API by  doxygen 1.5.1