Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::RadioButtonControl Class Reference

class RadioButtonControl documentation. More...

#include <vcf/ApplicationKit/RadioButtonControl.h>

Inheritance diagram for VCF::RadioButtonControl:

VCF::ToggledButton VCF::CustomControl VCF::Button VCF::Control VCF::UIComponent VCF::AbstractView VCF::Component VCF::View VCF::ObjectWithCallbacks VCF::Object List of all members.

Public Member Functions

 RadioButtonControl ()
virtual ~RadioButtonControl ()
virtual void paint (GraphicsContext *context)
 Paints the control.
virtual double getPreferredHeight ()
 returns the preferred height for this control.
virtual double getPreferredWidth ()
 returns the preferred width for this control.
bool getUseFixedRadioButtonSize ()
void setUseFixedRadioButtonSize (const bool &fixedRadioButtonSize)
double getFixedRadioButtonHeight ()
void setFixedRadioButtonHeight (const double &fixedRadioButtonHeight)
void setGroupID (const int32 &groupID)
int32 getGroupID ()
virtual void setChecked (const bool &checked)
RadioButtonControlgetSelectedRadioButtonFromGroup ()
bool generatePropertyValue (const String &fullPropertyName, Property *property, VariantData *value, String &strValue)

Protected Member Functions

void internal_setChecked (const bool &val)
 This is for internal use only - it simply calls the super class's setChecked() method - no other functionality is provided.

Protected Attributes

bool useFixedRadioButtonSize_
double fixedRadioButtonHeight_
int32 groupID_

Detailed Description

class RadioButtonControl documentation.


Constructor & Destructor Documentation

VCF::RadioButtonControl::RadioButtonControl  ) 
 

virtual VCF::RadioButtonControl::~RadioButtonControl  )  [virtual]
 


Member Function Documentation

bool VCF::RadioButtonControl::generatePropertyValue const String fullPropertyName,
Property property,
VariantData value,
String strValue
[virtual]
 

Reimplemented from VCF::Control.

double VCF::RadioButtonControl::getFixedRadioButtonHeight  )  [inline]
 

int32 VCF::RadioButtonControl::getGroupID  )  [inline]
 

virtual double VCF::RadioButtonControl::getPreferredHeight  )  [virtual]
 

returns the preferred height for this control.

This is used when determing the height of the control when it is first created. Override it to provide a different value that is more acceptable for your control's initial display size.

Reimplemented from VCF::Control.

virtual double VCF::RadioButtonControl::getPreferredWidth  )  [virtual]
 

returns the preferred width for this control.

This is used when determing the width of the control when it is first created. Override it to provide a different value that is more acceptable for your control's initial display size.

Reimplemented from VCF::Control.

RadioButtonControl* VCF::RadioButtonControl::getSelectedRadioButtonFromGroup  ) 
 

bool VCF::RadioButtonControl::getUseFixedRadioButtonSize  )  [inline]
 

void VCF::RadioButtonControl::internal_setChecked const bool &  val  )  [inline, protected]
 

This is for internal use only - it simply calls the super class's setChecked() method - no other functionality is provided.

virtual void VCF::RadioButtonControl::paint GraphicsContext context  )  [virtual]
 

Paints the control.

Called by the underlying windowing system whenever the control needs to be painted. Note that in some cases the GraphicsContext passed in to this method may not be the same pointer as the GraphicsContext that the control holds itself. During the paint() method you should only use the context value for all your drawing and not the one returned in getContext(). The value returned by getContext() should be used for drawing that takes place outside of the paint() method.

If the control allows paint notification, then the framework will fire an event to the BeforeControlPainted delegate prior to calling the control's paint() method. After the paint() method has returned, if the control allows paint notification, the framework will fire an event to the AfterControlPainted delegate. This allows outside observers to take part in the paint cycle, but beware that this does come at a bit of a cost, so use this feature sparingly.

Note: This should NEVER be called by programmers using the VCF, it will be called for you during the course of your applications native event loop, and is only here for providing custom drawing routines for controls. In other words: you implement it, you never call it yourself.

See also:
getAllowPaintNotification

Reimplemented from VCF::CustomControl.

virtual void VCF::RadioButtonControl::setChecked const bool &  checked  )  [virtual]
 

Reimplemented from VCF::ToggledButton.

void VCF::RadioButtonControl::setFixedRadioButtonHeight const double &  fixedRadioButtonHeight  ) 
 

void VCF::RadioButtonControl::setGroupID const int32 groupID  ) 
 

void VCF::RadioButtonControl::setUseFixedRadioButtonSize const bool &  fixedRadioButtonSize  ) 
 


Member Data Documentation

double VCF::RadioButtonControl::fixedRadioButtonHeight_ [protected]
 

int32 VCF::RadioButtonControl::groupID_ [protected]
 

bool VCF::RadioButtonControl::useFixedRadioButtonSize_ [protected]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information