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

VCF::LightweightComponent Class Reference

#include <vcf/ApplicationKit/LightweightComponent.h>

Inheritance diagram for VCF::LightweightComponent:

List of all members.

Public Member Functions
	LightweightComponent (Control *component)
virtual	~LightweightComponent ()
virtual void	create (Control *owningControl)
	This is called to actually create any neccessary windowing system resources specific to a new control (or widget/window/etc) instance for the platform.
virtual void	destroyControl ()
	Destroy the control peer's resoruces (if neccessary).
virtual OSHandleID	getHandleID ()
	returns a ID that identifies this control.
virtual VCF::String	getText ()
	returns a text associated with the component.
virtual void	setText (const VCF::String &text)
	sets the text for the control
virtual void	setBounds (VCF::Rect *rect)
	sets the bounds for the component.
virtual VCF::Rect	getBounds ()
	returns the bounds of the component in the coordinate system of the parent.
virtual void	setVisible (const bool &visible)
	shows or hides the component.
virtual bool	getVisible ()
	returns wether or not the component is currently visible.
virtual VCF::Control *	getControl ()
	returns the component that this Peer is attached to.
virtual void	setControl (VCF::Control *component)
	attahces the Peer to a particular component.
virtual void	setParent (VCF::Control *parent)
virtual VCF::Control *	getParent ()
virtual bool	isFocused ()
virtual void	setFocused ()
virtual bool	isEnabled ()
virtual void	setEnabled (const bool &enabled)
virtual void	setFont (Font *font)
void	repaint (Rect *repaintRect, const bool &immediately)
virtual void	keepMouseEvents ()
	this keeps the mouse events being sent to this control, even is the mouse leaves the physical bounds of the control
virtual void	releaseMouseEvents ()
	releases mouse events - goes back to normal event handling
virtual void	setCursor (Cursor *cursor)
virtual bool	beginSetBounds (const uint32 &numberOfChildren)
	advanced function for changing the size of multiple child windows.
virtual void	endSetBounds ()
virtual void	translateToScreenCoords (Point *pt)
	Takes the coordinates in pt, which are in the coordinate system of this control, and translates them into the coordinate system of the Screen.
virtual void	translateFromScreenCoords (Point *pt)
	Takes the coordinates in pt, which are in the coordinate system of the Screen, and translates them into the coordinate system of this control.
virtual void	preChildPaint (GraphicsContext *graphicsContext, Control *child, Rect *childClipRect)
	Called by the container instance of the child's parent control during it's paintChildren() function.
virtual void	postChildPaint (GraphicsContext *graphicsContext, Control *child, Rect *oldClipRect)
	Called by the container instance of the child's parent control during it's paintChildren() function.
virtual void	setBorder (Border *border)
	sets the control's border.

---

Constructor & Destructor Documentation

VCF::LightweightComponent::LightweightComponent (  Control *  component  )

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

---

Member Function Documentation

virtual bool VCF::LightweightComponent::beginSetBounds (  const uint32 &  numberOfChildren  )  [virtual]

advanced function for changing the size of multiple child windows. This may have no implementation on some windowing systems Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::create (  Control *  owningControl  )  [virtual]

This is called to actually create any neccessary windowing system resources specific to a new control (or widget/window/etc) instance for the platform. create() must be called by the containing VCF::Control subclass, typically in the classes constructor, after retreiving the new peer instance from the appropriate UIToolkit::createXXX() call. Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::destroyControl (   )  [virtual]

Destroy the control peer's resoruces (if neccessary). Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::endSetBounds (   )  [virtual]

Implements VCF::ControlPeer.

virtual VCF::Rect VCF::LightweightComponent::getBounds (   )  [virtual]

returns the bounds of the component in the coordinate system of the parent. Implements VCF::ControlPeer.

virtual VCF::Control* VCF::LightweightComponent::getControl (   )  [virtual]

returns the component that this Peer is attached to. Implements VCF::ControlPeer.

virtual OSHandleID VCF::LightweightComponent::getHandleID (   )  [virtual]

returns a ID that identifies this control. On Win32 this corresponds to an HWND. Implements VCF::ControlPeer.

virtual VCF::Control* VCF::LightweightComponent::getParent (   )  [virtual]

Implements VCF::ControlPeer.

virtual VCF::String VCF::LightweightComponent::getText (   )  [virtual]

returns a text associated with the component. This usually gets used in the Control::getCaption() method. Implements VCF::ControlPeer.

virtual bool VCF::LightweightComponent::getVisible (   )  [virtual]

returns wether or not the component is currently visible. Implements VCF::ControlPeer.

virtual bool VCF::LightweightComponent::isEnabled (   )  [virtual]

Implements VCF::ControlPeer.

virtual bool VCF::LightweightComponent::isFocused (   )  [virtual]

Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::keepMouseEvents (   )  [virtual]

this keeps the mouse events being sent to this control, even is the mouse leaves the physical bounds of the control Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::postChildPaint (  GraphicsContext *  graphicsContext, Control *  child, Rect *  oldClipRect )  [virtual]

Called by the container instance of the child's parent control during it's paintChildren() function. Called after the child control's paint() and paintBorder() functions. Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::preChildPaint (  GraphicsContext *  graphicsContext, Control *  child, Rect *  childClipRect )  [virtual]

Called by the container instance of the child's parent control during it's paintChildren() function. The implementation should do whatever is neccessary to seup up the child control's cliprect. A pre-calculated cliprect is passed in that was generated by the paintChildren() function. This function is called prior the child control's paint() or paintBorder() functions. Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::releaseMouseEvents (   )  [virtual]

releases mouse events - goes back to normal event handling Implements VCF::ControlPeer.

void VCF::LightweightComponent::repaint (  Rect *  repaintRect, const bool &  immediately )  [virtual]

Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::setBorder (  Border *  border  )  [inline, virtual]

sets the control's border. Called by the control when it's border object changes. This implementation is a no-op because a lightweight component only needs to set border_ but it doesn't need an indipendent peer. Parameters: Border*  border, the border object to assign. Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::setBounds (  VCF::Rect *  rect  )  [virtual]

sets the bounds for the component. Bounds are specified in the coordinate system of the componenents parent. Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::setControl (  VCF::Control *  component  )  [virtual]

attahces the Peer to a particular component. This should only be done once. Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::setCursor (  Cursor *  cursor  )  [virtual]

Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::setEnabled (  const bool &  enabled  )  [virtual]

Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::setFocused (   )  [virtual]

Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::setFont (  Font *  font  )  [virtual]

Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::setParent (  VCF::Control *  parent  )  [virtual]

Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::setText (  const VCF::String &  text  )  [virtual]

sets the text for the control Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::setVisible (  const bool &  visible  )  [virtual]

shows or hides the component. This does NOT close the component (if invoked on a frame based component ). Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::translateFromScreenCoords (  Point *  pt  )  [virtual]

Takes the coordinates in pt, which are in the coordinate system of the Screen, and translates them into the coordinate system of this control. Parameters: Point  the initial point value, in the coordinate system of the Screen. Implements VCF::ControlPeer.

virtual void VCF::LightweightComponent::translateToScreenCoords (  Point *  pt  )  [virtual]

Takes the coordinates in pt, which are in the coordinate system of this control, and translates them into the coordinate system of the Screen. Parameters: Point  the initial point value, in the coordinate system of the control this method is called on. Implements VCF::ControlPeer.

---

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

• vcf/ApplicationKit/LightweightComponent.h

Comments or Suggestions?    License Information