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

VCF::Basic3DBorder Class Reference

Draws a basic 3D border around a component. More...

#include <vcf/ApplicationKit/Basic3DBorder.h>

Inheritance diagram for VCF::Basic3DBorder:

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

Public Member Functions

 Basic3DBorder ()
 Basic3DBorder (bool inverted)
 Basic3DBorder (Component *owner)
virtual ~Basic3DBorder ()
virtual void paint (Control *control, GraphicsContext *context)
 Paint the border on context.
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

Draws a basic 3D border around a component.

The border is 2 pixels thick

Version:
1.0
Author:
Jim Crafton


Constructor & Destructor Documentation

VCF::Basic3DBorder::Basic3DBorder  ) 
 

VCF::Basic3DBorder::Basic3DBorder bool  inverted  ) 
 

VCF::Basic3DBorder::Basic3DBorder Component owner  ) 
 

virtual VCF::Basic3DBorder::~Basic3DBorder  )  [virtual]
 


Member Function Documentation

virtual Rect VCF::Basic3DBorder::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::Basic3DBorder::isInverted  )  [inline]
 

virtual void VCF::Basic3DBorder::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::Basic3DBorder::paint Control control,
GraphicsContext context
[virtual]
 

Paint the border on context.

Implements VCF::Border.

void VCF::Basic3DBorder::setInverted const bool &  inverted  )  [inline]
 


Member Data Documentation

bool VCF::Basic3DBorder::inverted_ [protected]
 


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