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

VCF::Light3DBorder Class Reference

Class Light3DBorder documentation. More...

#include <vcf/ApplicationKit/Light3DBorder.h>

Inheritance diagram for VCF::Light3DBorder:

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

Public Member Functions

 Light3DBorder ()
 Light3DBorder (bool inverted)
 Light3DBorder (Component *owner)
virtual ~Light3DBorder ()
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.
void setInverted (const bool &inverted)
bool isInverted ()

Protected Attributes

bool inverted_

Detailed Description

Class Light3DBorder documentation.

Constructor & Destructor Documentation

VCF::Light3DBorder::Light3DBorder (   ) 
 

VCF::Light3DBorder::Light3DBorder (  bool  inverted  ) 
 

VCF::Light3DBorder::Light3DBorder (  Component *  owner  ) 
 

virtual VCF::Light3DBorder::~Light3DBorder (   )  [virtual]
 

Member Function Documentation

virtual Rect VCF::Light3DBorder::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.

bool VCF::Light3DBorder::isInverted (   )  [inline]
 

virtual void VCF::Light3DBorder::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::Light3DBorder::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::Light3DBorder::setInverted (  const bool &  inverted  )  [inline]
 

Member Data Documentation

bool VCF::Light3DBorder::inverted_ [protected]
 

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