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

VCF::TitledBorder Class Reference

#include <vcf/ApplicationKit/TitledBorder.h>

Inheritance diagram for VCF::TitledBorder:

VCF::Border VCF::Component VCF::ObjectWithEvents VCF::Object List of all members.

Public Member Functions

 TitledBorder ()
 TitledBorder (const String &title)
 TitledBorder (const String &title, int32 sidesToPaint)
 TitledBorder (const String &title, int32 sidesToPaint, const Font &font)
 TitledBorder (Component *owner)
virtual ~TitledBorder ()
virtual void paint (Control *control, GraphicsContext *context)
 Draw the border, using the passed in context to draw on.
virtual void paint (Rect *bounds, GraphicsContext *context)
 paints a border in the given bounds on the context
virtual Rect getClientRect (Rect *initialBounds, Control *control)
 Returns a client rect in which contained components may live.
String getCaption ()
void setCaption (const String &val)
FontgetFont ()
void setFont (Font *val)
void setSidesToPaint (const int32 &sidesToPaint)
int32 getSidesToPaint ()

Protected Attributes

String caption_
int32 sidesToPaint_
Font font_

Constructor & Destructor Documentation

VCF::TitledBorder::TitledBorder  ) 
 

VCF::TitledBorder::TitledBorder const String title  ) 
 

VCF::TitledBorder::TitledBorder const String title,
int32  sidesToPaint
 

VCF::TitledBorder::TitledBorder const String title,
int32  sidesToPaint,
const Font font
 

VCF::TitledBorder::TitledBorder Component owner  ) 
 

virtual VCF::TitledBorder::~TitledBorder  )  [inline, virtual]
 


Member Function Documentation

String VCF::TitledBorder::getCaption  )  [inline]
 

virtual Rect VCF::TitledBorder::getClientRect Rect initialBounds,
Control control
[virtual]
 

Returns a client rect in which contained components may live.

Thus if a particular implementation required a 3 pixel border at the edges to draw itself, then it would retrieve the component's border and then reduce it by 3 pixels. This new value is the available area that the component could use to place child components

Parameters:
Rect* - the initial bounds to calculate a new client rectangle from.
Control* - a control that may provide additional information
Returns:
Rect the new (possibly adjusted) client rectangle

Implements VCF::Border.

Font* VCF::TitledBorder::getFont  )  [inline]
 

int32 VCF::TitledBorder::getSidesToPaint  )  [inline]
 

virtual void VCF::TitledBorder::paint Rect bounds,
GraphicsContext context
[virtual]
 

paints a border in the given bounds on the context

Parameters:
Rect the rectangle that makes up the outer most region of the border
GraphicsContext the context on which to paint the border

Implements VCF::Border.

virtual void VCF::TitledBorder::paint Control control,
GraphicsContext context
[virtual]
 

Draw the border, using the passed in context to draw on.

The control argument may be used for specific purposes, but typically it's just used to get the initial bounds for the border to draw within.

Implements VCF::Border.

void VCF::TitledBorder::setCaption const String val  )  [inline]
 

void VCF::TitledBorder::setFont Font val  )  [inline]
 

void VCF::TitledBorder::setSidesToPaint const int32 sidesToPaint  )  [inline]
 


Member Data Documentation

String VCF::TitledBorder::caption_ [protected]
 

Font VCF::TitledBorder::font_ [protected]
 

int32 VCF::TitledBorder::sidesToPaint_ [protected]
 


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