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

VCF::XCBAbstractControl Class Reference

#include <XCBAbstractControl.h>

Inheritance diagram for VCF::XCBAbstractControl:

VCF::ControlPeer VCF::Interface VCF::XCBButton VCF::XCBWindowPeer List of all members.

Public Member Functions

virtual ~XCBAbstractControl ()
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 String getText ()
 returns a text associated with the component.
virtual void setText (const String &text)
 sets the text for the control
virtual void setBounds (Rect *rect)
 sets the bounds for the component.
virtual bool beginSetBounds (const uint32 &numberOfChildren)
 advanced function for changing the size of multiple child windows.
virtual void endSetBounds ()
virtual 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 Control * getControl ()
 returns the component that this Peer is attached to.
virtual void setControl (Control *component)
 attahces the Peer to a particular component.
virtual void setCursor (Cursor *cursor)
virtual void setParent (Control *parent)
virtual Control * getParent ()
virtual bool isFocused ()
virtual void setFocused ()
virtual bool isEnabled ()
virtual void setEnabled (const bool &enabled)
virtual void setFont (Font *font)
virtual 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 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 setBorder (Border *border)
 Called by the control when it's border object changes.
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.
XCBWindowPeer * getOwnerWindow ()
void setOwnerWindow (XCBWindowPeer *val)
bool mouseEventsCaptured ()
XCBControlArray getXCBChildControls ()
void paintChildren (xcb_connection_t &connection, const xcb_expose_event_t &event, GraphicsContext *sharedCtx)
virtual void paintPeer (xcb_connection_t &connection, const xcb_expose_event_t &event, GraphicsContext *sharedCtx)
virtual void paintPeerControl (xcb_connection_t &connection, const xcb_expose_event_t &event, GraphicsContext *sharedCtx)
virtual void handleMouseEvents (xcb_connection_t &connection, const xcb_generic_event_t &event)

Protected Member Functions

 XCBAbstractControl (Control *control)
void addChild (XCBAbstractControl *child)
void removeChild (XCBAbstractControl *child)
XCBAbstractControl * findControlForMouseEvent (Point pt)

Protected Attributes

Control * control_
Rect bounds_
XCBWindowPeer * owningWindow_
bool enabled_
bool visible_
bool focused_
XCBAbstractControl * parent_
bool mouseEventsCaptured_
XCBControlArray childControls_

Constructor & Destructor Documentation

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

VCF::XCBAbstractControl::XCBAbstractControl (  Control *  control  )  [protected]
 

Member Function Documentation

void VCF::XCBAbstractControl::addChild (  XCBAbstractControl *  child  )  [protected]
 

virtual bool VCF::XCBAbstractControl::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.

Reimplemented in VCF::XCBWindowPeer.

virtual void VCF::XCBAbstractControl::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.

Reimplemented in VCF::XCBWindowPeer.

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

Destroy the control peer's resoruces (if neccessary).

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

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

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

XCBAbstractControl* VCF::XCBAbstractControl::findControlForMouseEvent (  Point  pt  )  [protected]
 

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

returns the bounds of the component in the coordinate system of the parent.

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

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

returns the component that this Peer is attached to.

Implements VCF::ControlPeer.

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

returns a ID that identifies this control.

On Win32 this corresponds to an HWND.

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

XCBWindowPeer* VCF::XCBAbstractControl::getOwnerWindow (   )  [inline]
 

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

Implements VCF::ControlPeer.

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

returns a text associated with the component.

This usually gets used in the Control::getCaption() method.

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

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

returns wether or not the component is currently visible.

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

XCBControlArray VCF::XCBAbstractControl::getXCBChildControls (   )  [inline]
 

virtual void VCF::XCBAbstractControl::handleMouseEvents (  xcb_connection_t &  connection,
const xcb_generic_event_t &  event
)  [virtual]
 

Reimplemented in VCF::XCBButton.

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

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

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

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

virtual void VCF::XCBAbstractControl::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.

Reimplemented in VCF::XCBWindowPeer.

bool VCF::XCBAbstractControl::mouseEventsCaptured (   )  [inline]
 

void VCF::XCBAbstractControl::paintChildren (  xcb_connection_t &  connection,
const xcb_expose_event_t &  event,
GraphicsContext *  sharedCtx
) 
 

virtual void VCF::XCBAbstractControl::paintPeer (  xcb_connection_t &  connection,
const xcb_expose_event_t &  event,
GraphicsContext *  sharedCtx
)  [virtual]
 

Reimplemented in VCF::XCBButton.

virtual void VCF::XCBAbstractControl::paintPeerControl (  xcb_connection_t &  connection,
const xcb_expose_event_t &  event,
GraphicsContext *  sharedCtx
)  [virtual]
 

virtual void VCF::XCBAbstractControl::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.

Reimplemented in VCF::XCBWindowPeer.

virtual void VCF::XCBAbstractControl::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.

Reimplemented in VCF::XCBWindowPeer.

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

releases mouse events - goes back to normal event handling

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

void VCF::XCBAbstractControl::removeChild (  XCBAbstractControl *  child  )  [protected]
 

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

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

virtual void VCF::XCBAbstractControl::setBorder (  Border *  border  )  [virtual]
 

Called by the control when it's border object changes.

May or may not need to be implemented depending on the windowing system.

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

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

sets the bounds for the component.

Bounds are specified in the coordinate system of the componenents parent.

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

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

attahces the Peer to a particular component.

This should only be done once.

Implements VCF::ControlPeer.

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

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

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

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

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

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

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

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

void VCF::XCBAbstractControl::setOwnerWindow (  XCBWindowPeer *  val  )  [inline]
 

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

Implements VCF::ControlPeer.

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

sets the text for the control

Implements VCF::ControlPeer.

Reimplemented in VCF::XCBWindowPeer.

virtual void VCF::XCBAbstractControl::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.

Reimplemented in VCF::XCBWindowPeer.

virtual void VCF::XCBAbstractControl::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.

Reimplemented in VCF::XCBWindowPeer.

virtual void VCF::XCBAbstractControl::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.

Reimplemented in VCF::XCBWindowPeer.

Member Data Documentation

Rect VCF::XCBAbstractControl::bounds_ [protected]
 

XCBControlArray VCF::XCBAbstractControl::childControls_ [protected]
 

Control* VCF::XCBAbstractControl::control_ [protected]
 

bool VCF::XCBAbstractControl::enabled_ [protected]
 

bool VCF::XCBAbstractControl::focused_ [protected]
 

bool VCF::XCBAbstractControl::mouseEventsCaptured_ [protected]
 

XCBWindowPeer* VCF::XCBAbstractControl::owningWindow_ [protected]
 

XCBAbstractControl* VCF::XCBAbstractControl::parent_ [protected]
 

bool VCF::XCBAbstractControl::visible_ [protected]
 

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