The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::ContextPeer Class Reference

The ContextPeer serves as a platform neutral interface for a set of standard drawing methods that should provide the following functionality:. More...

#include <vcf/GraphicsKit/ContextPeer.h>

Inheritance diagram for VCF::ContextPeer:

List of all members.

Public Member Functions
virtual	~ContextPeer ()
virtual void	setContext (GraphicsContext *context)=0
virtual GraphicsContext *	getContext ()=0
virtual OSHandleID	getContextID ()=0
virtual void	setContextID (OSHandleID contextID)=0
virtual bool	prepareForDrawing (int32 drawingOperation)=0
	this method is called for the peer to initialize any graphics resources before calling the following methods:
virtual void	finishedDrawing (int32 drawingOperation)=0
virtual void	setClippingPath (Path *clippingPath)=0
	sets the current clipping path to be used for the duration of the Contexts lifetime or until it has been changed
virtual void	setClippingRect (Rect *clipRect)=0
virtual void	setTextAlignment (const bool &alignTobaseline)=0
	this is used to determine how to align text when the windowing systems draws it.
virtual bool	isTextAlignedToBaseline ()=0
virtual void	textAt (const Rect &bounds, const String &text, const int32 &drawOptions=0)=0
virtual double	getTextWidth (const String &text)=0
virtual double	getTextHeight (const String &text)=0
virtual void	rectangle (const double &x1, const double &y1, const double &x2, const double &y2)=0
virtual void	roundRect (const double &x1, const double &y1, const double &x2, const double &y2, const double &xc, const double &yc)=0
virtual void	ellipse (const double &x1, const double &y1, const double &x2, const double &y2)=0
virtual void	arc (const double &x1, const double &y1, const double &x2, const double &y2, const double &x3, const double &y3, const double &x4, const double &y4)=0
virtual void	polyline (const std::vector< Point > &pts)=0
virtual void	curve (const double &x1, const double &y1, const double &x2, const double &y2, const double &x3, const double &y3, const double &x4, const double &y4)=0
virtual void	moveTo (const double &x, const double &y)=0
virtual void	lineTo (const double &x, const double &y)=0
virtual void	closePath ()=0
virtual void	setOrigin (const double &x, const double &y)=0
virtual Point	getOrigin ()=0
virtual void	copyContext (const Rect &sourceRect, const Rect &destRect, ContextPeer *sourceContext)=0
virtual bool	isMemoryContext ()=0
	is this context Peer in memory or does it associated with a component ?
virtual bool	isAntiAliasingOn ()=0
	Turns the XOR mode on or off.
virtual void	setAntiAliasingOn (bool antiAliasingOn)=0
virtual void	drawImage (const double &x, const double &y, Rect *imageBounds, Image *image, int compositeMode)=0
virtual void	bitBlit (const double &x, const double &y, Rect *imageBounds, Image *image)=0
	"Blits" the image to the underlying graphics context.
virtual void	drawThemeSelectionRect (Rect *rect, DrawUIState &state)=0
virtual void	drawThemeFocusRect (Rect *rect, DrawUIState &state)=0
	Draws a focus rect, which is an inverted gray dotted line around the rect.
virtual void	drawThemeButtonRect (Rect *rect, ButtonState &state, Rect *captionRect=NULL)=0
	Draws a button's background, the border, and its caption.
virtual void	drawThemeButtonFocusRect (Rect *rect)=0
	Similar to drawThemeFocusRect, but dimension of the focus rect is chosen by the peer.
virtual void	drawThemeCheckboxRect (Rect *rect, ButtonState &state)=0
virtual void	drawThemeRadioButtonRect (Rect *rect, ButtonState &state)=0
virtual void	drawThemeComboboxRect (Rect *rect, ButtonState &state)=0
virtual void	drawThemeScrollButtonRect (Rect *rect, ScrollBarState &state)=0
virtual void	drawThemeDisclosureButton (Rect *rect, DisclosureButtonState &state)=0
	Draws a button that is used to open up more details, for example the button that opens up a tree node to reveal it's children, that is compliant with the native windowing systems default look and feel.
virtual void	drawThemeTab (Rect *rect, TabState &state)=0
	Draws a tab, the part of the TabbedPages control that acts like a little button to activate a page, that is compliant with the native windowing systems default look and feel.
virtual void	drawThemeTabPage (Rect *rect, DrawUIState &state)=0
	Draws a tab page - the page on which other controls for the page are parented to, that is compliant with the native windowing systems default look and feel.
virtual void	drawThemeTabContent (Rect *rect, DrawUIState &state)=0
virtual void	drawThemeTabs (Rect *rect, DrawUIState &paneState, TabState &selectedTabState, TabState &otherTabs, const std::vector< String > &tabNames, int selectedTabIndex)=0
virtual void	drawThemeTickMarks (Rect *rect, SliderState &state)=0
	Draws a tick mark, like that used for a slider control, that is compliant with the native windowing systems default look and feel.
virtual void	drawThemeSlider (Rect *rect, SliderState &state)=0
	Draws a slider control, like that used for a slider control, that is compliant with the native windowing systems default look and feel.
virtual void	drawThemeProgress (Rect *rect, ProgressState &state)=0
	Draws a progress bar control, that is compliant with the native windowing systems default look and feel.
virtual void	drawThemeImage (Rect *rect, Image *image, DrawUIState &state)=0
virtual void	drawThemeHeader (Rect *rect, ButtonState &state)=0
	Draws a header control that is compliant with the native windowing systems default look and feel.
virtual void	drawThemeEdge (Rect *rect, DrawUIState &state, const int32 &edgeSides, const int32 &edgeStyle)=0
	draws edges, useful for separators, that is compliant with the native windowing systems default look and feel.
virtual void	drawThemeBorder (Rect *rect, DrawUIState &state)=0
virtual void	drawThemeSizeGripper (Rect *rect, DrawUIState &state)=0
	Draws a size gripper for resizing a control/window that is compliant with the native windowing systems default look and feel.
virtual void	drawThemeBackground (Rect *rect, BackgroundState &state)=0
	Draws a them compliant background.
virtual void	drawThemeMenuItem (Rect *rect, MenuState &state)=0
	Draws the background appropriate for a menu item that is compliant with the native windowing systems default look and feel.
virtual void	drawThemeMenuItemText (Rect *rect, MenuState &state)=0
virtual void	drawThemeText (Rect *rect, TextState &state)=0

---

Detailed Description

The ContextPeer serves as a platform neutral interface for a set of standard drawing methods that should provide the following functionality:.

• A base set of 2D drawing primitives, like lines, ellipse, rectangles, etc.
• The ability to specify line width, line color, and simple line patterns
• The ability to fill or stroke the various graphics primitives
• Basic text functions
• a set of utility methods for drawing common UI shapes, like a selection rectangle, tab, scroll buttons, or a 3D button frame, etc. These may be drawn differently depending on the underlying windowing system

---

Constructor & Destructor Documentation

virtual VCF::ContextPeer::~ContextPeer (   )  [inline, virtual]

---

Member Function Documentation

virtual void VCF::ContextPeer::arc (  const double &  x1, const double &  y1, const double &  x2, const double &  y2, const double &  x3, const double &  y3, const double &  x4, const double &  y4 )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::bitBlit (  const double &  x, const double &  y, Rect *  imageBounds, Image *  image )  [pure virtual]

"Blits" the image to the underlying graphics context. No attempt is made to transform the image. The image is blitted to the coordinates specified by the x and y arguments, and the image's width and height are used to determine the bounds. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::closePath (   )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::copyContext (  const Rect &  sourceRect, const Rect &  destRect, ContextPeer *  sourceContext )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::curve (  const double &  x1, const double &  y1, const double &  x2, const double &  y2, const double &  x3, const double &  y3, const double &  x4, const double &  y4 )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawImage (  const double &  x, const double &  y, Rect *  imageBounds, Image *  image, int  compositeMode )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeBackground (  Rect *  rect, BackgroundState &  state )  [pure virtual]

Draws a them compliant background. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeBorder (  Rect *  rect, DrawUIState &  state )  [pure virtual]

Implemented in VCF::OSXContext, and VCF::Win32Context.

virtual void VCF::ContextPeer::drawThemeButtonFocusRect (  Rect *  rect  )  [pure virtual]

Similar to drawThemeFocusRect, but dimension of the focus rect is chosen by the peer. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeButtonRect (  Rect *  rect, ButtonState &  state, Rect *  captionRect = NULL )  [pure virtual]

Draws a button's background, the border, and its caption. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeCheckboxRect (  Rect *  rect, ButtonState &  state )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeComboboxRect (  Rect *  rect, ButtonState &  state )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeDisclosureButton (  Rect *  rect, DisclosureButtonState &  state )  [pure virtual]

Draws a button that is used to open up more details, for example the button that opens up a tree node to reveal it's children, that is compliant with the native windowing systems default look and feel. On Win32 this is usually represented by the "+" and "-" look as found on the tree controls, while on OSX it is the little triangles Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeEdge (  Rect *  rect, DrawUIState &  state, const int32 &  edgeSides, const int32 &  edgeStyle )  [pure virtual]

draws edges, useful for separators, that is compliant with the native windowing systems default look and feel. use a mask or 1 or more values of type ContextPeer::EdgeType to indicate which sides of the rect to draw an edge on Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeFocusRect (  Rect *  rect, DrawUIState &  state )  [pure virtual]

Draws a focus rect, which is an inverted gray dotted line around the rect. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeHeader (  Rect *  rect, ButtonState &  state )  [pure virtual]

Draws a header control that is compliant with the native windowing systems default look and feel. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeImage (  Rect *  rect, Image *  image, DrawUIState &  state )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeMenuItem (  Rect *  rect, MenuState &  state )  [pure virtual]

Draws the background appropriate for a menu item that is compliant with the native windowing systems default look and feel. This is typically called first by a menu item to give it a standard look and feel in it's background before drawing any thing else Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeMenuItemText (  Rect *  rect, MenuState &  state )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeProgress (  Rect *  rect, ProgressState &  state )  [pure virtual]

Draws a progress bar control, that is compliant with the native windowing systems default look and feel. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeRadioButtonRect (  Rect *  rect, ButtonState &  state )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeScrollButtonRect (  Rect *  rect, ScrollBarState &  state )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeSelectionRect (  Rect *  rect, DrawUIState &  state )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeSizeGripper (  Rect *  rect, DrawUIState &  state )  [pure virtual]

Draws a size gripper for resizing a control/window that is compliant with the native windowing systems default look and feel. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeSlider (  Rect *  rect, SliderState &  state )  [pure virtual]

Draws a slider control, like that used for a slider control, that is compliant with the native windowing systems default look and feel. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeTab (  Rect *  rect, TabState &  state )  [pure virtual]

Draws a tab, the part of the TabbedPages control that acts like a little button to activate a page, that is compliant with the native windowing systems default look and feel. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeTabContent (  Rect *  rect, DrawUIState &  state )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeTabPage (  Rect *  rect, DrawUIState &  state )  [pure virtual]

Draws a tab page - the page on which other controls for the page are parented to, that is compliant with the native windowing systems default look and feel. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeTabs (  Rect *  rect, DrawUIState &  paneState, TabState &  selectedTabState, TabState &  otherTabs, const std::vector< String > &  tabNames, int  selectedTabIndex )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeText (  Rect *  rect, TextState &  state )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::drawThemeTickMarks (  Rect *  rect, SliderState &  state )  [pure virtual]

Draws a tick mark, like that used for a slider control, that is compliant with the native windowing systems default look and feel. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::ellipse (  const double &  x1, const double &  y1, const double &  x2, const double &  y2 )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::finishedDrawing (  int32  drawingOperation  )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual GraphicsContext* VCF::ContextPeer::getContext (   )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual OSHandleID VCF::ContextPeer::getContextID (   )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual Point VCF::ContextPeer::getOrigin (   )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual double VCF::ContextPeer::getTextHeight (  const String &  text  )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual double VCF::ContextPeer::getTextWidth (  const String &  text  )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual bool VCF::ContextPeer::isAntiAliasingOn (   )  [pure virtual]

Turns the XOR mode on or off. Parameters: bool  XORModeOn, if true then turns the XORMode on otherwise if it's false it turns it off. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual bool VCF::ContextPeer::isMemoryContext (   )  [pure virtual]

is this context Peer in memory or does it associated with a component ? Returns: bool true if the context is on memory, otherwise false Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual bool VCF::ContextPeer::isTextAlignedToBaseline (   )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::lineTo (  const double &  x, const double &  y )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::moveTo (  const double &  x, const double &  y )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::polyline (  const std::vector< Point > &  pts  )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual bool VCF::ContextPeer::prepareForDrawing (  int32  drawingOperation  )  [pure virtual]

this method is called for the peer to initialize any graphics resources before calling the following methods: textAt getTextWidth getTextHeight rectangle ellipse arc polyline curve moveTo lineTo Since the drawing primitives like (rectangle, moveTo, etc) are executed as a series of operations by the GraphicsContext, this means that prepareForDrawing() will get called as part of the GraphicsContext::fillPath(), GraphicsContext::strokePath(), or GraphicsContext::textAtXXX() methods. prepareForDrawing() will be called prior to any of the drawing primitive functions in the above list, allowing the peer to initialize whatever graphics resources need to be as specified by the GraphicsContext. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::rectangle (  const double &  x1, const double &  y1, const double &  x2, const double &  y2 )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::roundRect (  const double &  x1, const double &  y1, const double &  x2, const double &  y2, const double &  xc, const double &  yc )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::setAntiAliasingOn (  bool  antiAliasingOn  )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::setClippingPath (  Path *  clippingPath  )  [pure virtual]

sets the current clipping path to be used for the duration of the Contexts lifetime or until it has been changed Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::setClippingRect (  Rect *  clipRect  )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::setContext (  GraphicsContext *  context  )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, VCF::XCBContextPeer, VCF::OSXControlContextPeer, VCF::Win32ControlContext, and VCF::XCBControlContextPeer.

virtual void VCF::ContextPeer::setContextID (  OSHandleID  contextID  )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::setOrigin (  const double &  x, const double &  y )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::setTextAlignment (  const bool &  alignTobaseline  )  [pure virtual]

this is used to determine how to align text when the windowing systems draws it. Currently the choices are 2: either it is aligned to the top, or in other words the coordinates specified represent the top, left position to start rendering the text, or aligned to the baseline, in which the top, left coordinates represent the baseline point of origin. The latter setting is useful when drawing text whith different font styles. Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

virtual void VCF::ContextPeer::textAt (  const Rect &  bounds, const String &  text, const int32 &  drawOptions = 0 )  [pure virtual]

Implemented in VCF::OSXContext, VCF::Win32Context, and VCF::XCBContextPeer.

---

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

• vcf/GraphicsKit/ContextPeer.h

Comments or Suggestions?    License Information