Planeshift
pawsBorder Class Reference

This is a class that draws the border around a widget. More...

#include <pawsborder.h>

Public Member Functions

void Draw ()
 
csRect GetRect ()
 
const char * GetTitle ()
 
iPawsImageGetTitleImage ()
 
void Hide ()
 
void JustTitle ()
 Draws just the title bar. More...
 
 pawsBorder (const char *styleName)
 
 pawsBorder (const pawsBorder &origin)
 
void SetParent (pawsWidget *parent)
 
void SetTitle (const char *t, bool shadow=true)
 
void SetTitleAlign (int al)
 
void SetTitleImage (iPawsImage *drawable)
 
void Show ()
 
void UseBorder (const char *style)
 Use a particular style for this border. More...
 
 ~pawsBorder ()
 

Protected Member Functions

void DrawFrame (csRect frame)
 
void DrawTitle (csRect &frame)
 

Protected Attributes

int align
 Alignment of title text. More...
 
csRef< iPawsImageborderImages [PAWS_BORDER_MAX]
 
bool draw
 
csRect frame
 
bool justTitle
 
pawsWidgetparent
 
bool shadowFont
 
int style
 
csString title
 Title bar text. More...
 
csRef< iPawsImagetitleImage
 Title bar image. More...
 
bool usingGraphics
 

Detailed Description

This is a class that draws the border around a widget.

A grapical border consists of 8 images ( as seen in the enum ) that can create a border. The corner images are drawn easily and the images along the sides are tiled to fill in the space.

Definition at line 78 of file pawsborder.h.

Constructor & Destructor Documentation

pawsBorder::pawsBorder ( const char *  styleName)
pawsBorder::pawsBorder ( const pawsBorder origin)
pawsBorder::~pawsBorder ( )

Member Function Documentation

void pawsBorder::Draw ( )
void pawsBorder::DrawFrame ( csRect  frame)
protected
void pawsBorder::DrawTitle ( csRect &  frame)
protected
csRect pawsBorder::GetRect ( )
const char* pawsBorder::GetTitle ( )
inline

Definition at line 124 of file pawsborder.h.

iPawsImage* pawsBorder::GetTitleImage ( )
inline

Definition at line 120 of file pawsborder.h.

void pawsBorder::Hide ( )
inline

Definition at line 100 of file pawsborder.h.

void pawsBorder::JustTitle ( )
inline

Draws just the title bar.

Definition at line 95 of file pawsborder.h.

void pawsBorder::SetParent ( pawsWidget parent)
void pawsBorder::SetTitle ( const char *  t,
bool  shadow = true 
)
void pawsBorder::SetTitleAlign ( int  al)
inline

Definition at line 115 of file pawsborder.h.

void pawsBorder::SetTitleImage ( iPawsImage drawable)
inline

Definition at line 111 of file pawsborder.h.

void pawsBorder::Show ( void  )
inline

Definition at line 104 of file pawsborder.h.

void pawsBorder::UseBorder ( const char *  style)

Use a particular style for this border.

Parameters
styleThe style name to use for the border. lines is the default one that will draw basic lines around the widget. If style is NULL it will default to lines.

Member Data Documentation

int pawsBorder::align
protected

Alignment of title text.

Definition at line 144 of file pawsborder.h.

csRef<iPawsImage> pawsBorder::borderImages[PAWS_BORDER_MAX]
protected

Definition at line 137 of file pawsborder.h.

bool pawsBorder::draw
protected

Definition at line 147 of file pawsborder.h.

csRect pawsBorder::frame
protected

Definition at line 134 of file pawsborder.h.

bool pawsBorder::justTitle
protected

Definition at line 148 of file pawsborder.h.

pawsWidget* pawsBorder::parent
protected

Definition at line 135 of file pawsborder.h.

bool pawsBorder::shadowFont
protected

Definition at line 150 of file pawsborder.h.

int pawsBorder::style
protected

Definition at line 149 of file pawsborder.h.

csString pawsBorder::title
protected

Title bar text.

Definition at line 140 of file pawsborder.h.

csRef<iPawsImage> pawsBorder::titleImage
protected

Title bar image.

Definition at line 142 of file pawsborder.h.

bool pawsBorder::usingGraphics
protected

Definition at line 146 of file pawsborder.h.


The documentation for this class was generated from the following file: