CDrawContext Class Reference

A drawing context encapsulates the drawing context of the underlying OS. More...

#include <vstgui.h>

Inheritance diagram for CDrawContext:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ~CDrawContext ()
void * getWindow ()
void setWindow (void *ptr)
void getLoc (CPoint &where) const
CFramegetFrame () const
void * getSystemContext () const
void forget ()
 decrease refcount and delete object if refcount == 0
DEPRECATED_ATTRIBUTE CColor getPoint (const CPoint &point)
DEPRECATED_ATTRIBUTE void floodFill (const CPoint &start)
DEPRECATED_ATTRIBUTE void drawArc (const CRect &rect, const CPoint &point1, const CPoint &point2)
DEPRECATED_ATTRIBUTE void fillArc (const CRect &rect, const CPoint &point1, const CPoint &point2)
DEPRECATED_ATTRIBUTE void polyLine (const CPoint *pPoint, long numberOfPoints)
DEPRECATED_ATTRIBUTE void fillPolygon (const CPoint *pPoint, long numberOfPoints)
DEPRECATED_ATTRIBUTE void fillRect (const CRect &rect)
DEPRECATED_ATTRIBUTE void fillEllipse (const CRect &rect)
DEPRECATED_ATTRIBUTE long getMouseButtons ()
DEPRECATED_ATTRIBUTE void getMouseLocation (CPoint &point)
DEPRECATED_ATTRIBUTE bool waitDoubleClick ()
DEPRECATED_ATTRIBUTE bool waitDrag ()

Public Attributes

CPoint offsetScreen
CPoint offset

Protected Attributes

void * pSystemContext
void * pWindow
CFramepFrame
CFontRef font
CColor fontColor
CPoint penLoc
CCoord frameWidth
CColor frameColor
CColor fillColor
CLineStyle lineStyle
CDrawMode drawMode
CRect clipRect

Constructor



 CDrawContext (CFrame *pFrame, void *pSystemContext, void *pWindow=0)

Draw primitives



void moveTo (const CPoint &point)
 move line position to point
void lineTo (const CPoint &point)
 draw a line from current position to point
void drawLines (const CPoint *points, const long &numberOfLines)
 draw multiple lines at once
void drawPolygon (const CPoint *pPoints, long numberOfPoints, const CDrawStyle drawStyle=kDrawStroked, bool closePolygon=true)
 draw a polygon
void drawRect (const CRect &rect, const CDrawStyle drawStyle=kDrawStroked)
 draw a rect
void drawArc (const CRect &rect, const float startAngle1, const float endAngle2, const CDrawStyle drawStyle=kDrawStroked)
 draw an arc, angles are in degree
void drawEllipse (const CRect &rect, const CDrawStyle drawStyle=kDrawStroked)
 draw an ellipse
void drawPoint (const CPoint &point, CColor color)
 draw a point

Line Mode



void setLineStyle (CLineStyle style)
 set the current line style
CLineStyle getLineStyle () const
 get the current line style
void setLineWidth (CCoord width)
 set the current line width
CCoord getLineWidth () const
 get the current line width

Draw Mode



void setDrawMode (CDrawMode mode)
 set the current draw mode, see CDrawMode
CDrawMode getDrawMode () const
 get the current draw mode, see CDrawMode

Clipping



void setClipRect (const CRect &clip)
 set the current clip
CRectgetClipRect (CRect &clip) const
 get the current clip
void resetClipRect ()
 reset the clip to the default state

Color



void setFillColor (const CColor color)
 set current fill color
CColor getFillColor () const
 get current fill color
void setFrameColor (const CColor color)
 set current stroke color
CColor getFrameColor () const
 get current stroke color

Font



void setFontColor (const CColor color)
 set current font color
CColor getFontColor () const
 get current font color
void setFont (const CFontRef font, const long &size=0, const long &style=-1)
 set current font
const CFontRefgetFont () const
 get current font
long getFontSize () const
 get current font size

Text



CCoord getStringWidth (const char *pStr)
 get the width of an ASCII encoded string
void drawString (const char *pString, const CRect &rect, const short opaque=false, const CHoriTxtAlign hAlign=kCenterText)
 draw an ASCII encoded string
CCoord getStringWidthUTF8 (const char *pStr)
 get the width of an UTF-8 encoded string
void drawStringUTF8 (const char *pString, const CRect &rect, const CHoriTxtAlign hAlign=kCenterText, bool antialias=true)
 draw an UTF-8 encoded string
void drawStringUTF8 (const char *string, const CPoint &_point, bool antialias=true)
 draw an UTF-8 encoded string

Reference Counting Methods



virtual void remember ()
 increase refcount
long getNbReference () const
 get refcount

Message Methods



virtual CMessageResult notify (CBaseObject *sender, const char *message)

Detailed Description

A drawing context encapsulates the drawing context of the underlying OS.


Constructor & Destructor Documentation

CDrawContext ( CFrame inFrame,
void *  inSystemContext,
void *  inWindow = 0 
)

CDrawContext constructor.

Parameters:
inFrame the parent CFrame
inSystemContext the platform system context, can be NULL
inWindow the platform window object
~CDrawContext (  ) 

Member Function Documentation

void drawArc ( const CRect rect,
const CPoint point1,
const CPoint point2 
)
void drawArc ( const CRect rect,
const float  startAngle1,
const float  endAngle2,
const CDrawStyle  drawStyle = kDrawStroked 
)

draw an arc, angles are in degree

void drawEllipse ( const CRect rect,
const CDrawStyle  drawStyle = kDrawStroked 
)

draw an ellipse

void drawLines ( const CPoint points,
const long &  numberOfLines 
)

draw multiple lines at once

void drawPoint ( const CPoint point,
CColor  color 
)

draw a point

void drawPolygon ( const CPoint pPoints,
long  numberOfPoints,
const CDrawStyle  drawStyle = kDrawStroked,
bool  closePolygon = true 
)

draw a polygon

void drawRect ( const CRect rect,
const CDrawStyle  drawStyle = kDrawStroked 
)

draw a rect

void drawString ( const char *  pString,
const CRect rect,
const short  opaque = false,
const CHoriTxtAlign  hAlign = kCenterText 
)

draw an ASCII encoded string

void drawStringUTF8 ( const char *  string,
const CPoint _point,
bool  antialias = true 
)

draw an UTF-8 encoded string

void drawStringUTF8 ( const char *  pString,
const CRect rect,
const CHoriTxtAlign  hAlign = kCenterText,
bool  antialias = true 
)

draw an UTF-8 encoded string

void fillArc ( const CRect rect,
const CPoint point1,
const CPoint point2 
)
void fillEllipse ( const CRect rect  ) 
Deprecated:
use VSTGUI::CDrawContext::drawEllipse with kDrawFilled as draw style
void fillPolygon ( const CPoint pPoint,
long  numberOfPoints 
)
Deprecated:
use VSTGUI::CDrawContext::drawPolygon with kDrawFilled as draw style
void fillRect ( const CRect rect  ) 
Deprecated:
use VSTGUI::CDrawContext::drawRect with kDrawFilled as draw style
void floodFill ( const CPoint start  ) 
void forget (  )  [virtual]

decrease refcount and delete object if refcount == 0

Reimplemented from CBaseObject.

CRect& getClipRect ( CRect clip  )  const [inline]

get the current clip

CDrawMode getDrawMode (  )  const [inline]

get the current draw mode, see CDrawMode

CColor getFillColor (  )  const [inline]

get current fill color

const CFontRef& getFont (  )  const [inline]

get current font

CColor getFontColor (  )  const [inline]

get current font color

long getFontSize (  )  const [inline]

get current font size

CFrame* getFrame (  )  const [inline]
CColor getFrameColor (  )  const [inline]

get current stroke color

CLineStyle getLineStyle (  )  const [inline]

get the current line style

CCoord getLineWidth (  )  const [inline]

get the current line width

void getLoc ( CPoint where  )  const [inline]
long getMouseButtons (  ) 
void getMouseLocation ( CPoint point  ) 
long getNbReference (  )  const [inline, inherited]

get refcount

CColor getPoint ( const CPoint point  ) 
CCoord getStringWidth ( const char *  pStr  ) 

get the width of an ASCII encoded string

CCoord getStringWidthUTF8 ( const char *  pStr  ) 

get the width of an UTF-8 encoded string

void* getSystemContext (  )  const [inline]
void* getWindow (  )  [inline]
void lineTo ( const CPoint point  ) 

draw a line from current position to point

void moveTo ( const CPoint point  ) 

move line position to point

virtual CMessageResult notify ( CBaseObject sender,
const char *  message 
) [inline, virtual, inherited]
void polyLine ( const CPoint pPoint,
long  numberOfPoints 
)
virtual void remember (  )  [inline, virtual, inherited]

increase refcount

void resetClipRect (  ) 

reset the clip to the default state

void setClipRect ( const CRect clip  ) 

set the current clip

void setDrawMode ( CDrawMode  mode  ) 

set the current draw mode, see CDrawMode

void setFillColor ( const CColor  color  ) 

set current fill color

void setFont ( const CFontRef  font,
const long &  size = 0,
const long &  style = -1 
)

set current font

void setFontColor ( const CColor  color  ) 

set current font color

void setFrameColor ( const CColor  color  ) 

set current stroke color

void setLineStyle ( CLineStyle  style  ) 

set the current line style

void setLineWidth ( CCoord  width  ) 

set the current line width

void setWindow ( void *  ptr  )  [inline]
bool waitDoubleClick (  ) 
Deprecated:
use kDoubleClick in the buttons parameter of the mouse methods instead
bool waitDrag (  ) 
Deprecated:
use the new mouse methods instead

Member Data Documentation

CRect clipRect [protected]
CDrawMode drawMode [protected]
CColor fillColor [protected]
CFontRef font [protected]
CColor fontColor [protected]
CColor frameColor [protected]
CCoord frameWidth [protected]
CLineStyle lineStyle [protected]
CPoint penLoc [protected]
CFrame* pFrame [protected]
void* pSystemContext [protected]
void* pWindow [protected]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated on Fri Nov 22 11:09:21 2013 for VSTGUI by  doxygen 1.6.1