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

VCF::OSXControl Class Reference

#include <OSXControl.h>

Inheritance diagram for VCF::OSXControl:

VCF::ObjectWithCallbacks VCF::ControlPeer VCF::Object VCF::Interface VCF::OSXButton VCF::OSXListview VCF::OSXTextEditPeer VCF::OSXToolbar VCF::OSXTree List of all members.

Public Types

enum  MouseState {
  msNoState = 0, msDown, msUp, msEntered,
  msExited
}

Public Member Functions

 OSXControl (Control *control)
virtual ~OSXControl ()
virtual OSHandleID getHandleID ()
 returns a ID that identifies this control.
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 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.

Static Public Member Functions

static OSXControl * getControlFromControlRef (ControlRef control)

Protected Member Functions

virtual OSStatus handleOSXEvent (EventHandlerCallRef nextHandler, EventRef theEvent)
OSStatus handleControlTrack (EventRef theEvent)
OSStatus handleWrappedControlTrack (EventRef theEvent)
OSStatus handleWrappedControlTrackDone (EventRef theEvent)
OSStatus handleWrappedControlHitTest (EventRef theEvent)
OSStatus installStdControlHandler ()

Static Protected Member Functions

static EventHandlerUPP getEventHandlerUPP ()
static OSStatus handleOSXEvents (EventHandlerCallRef nextHandler, EventRef theEvent, void *userData)

Protected Attributes

ControlRef hiView_
Control * control_
EventHandlerRef handlerRef_
MouseState mouseState_
::Point lastMousePt_

Member Enumeration Documentation

enum VCF::OSXControl::MouseState
 

Enumerator:
msNoState 
msDown 
msUp 
msEntered 
msExited 

Constructor & Destructor Documentation

VCF::OSXControl::OSXControl (  Control *  control  ) 
 

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

Member Function Documentation

virtual bool VCF::OSXControl::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::OSXControl::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::OSXButton, VCF::OSXListview, VCF::OSXTextEditPeer, VCF::OSXToolbar, and VCF::OSXTree.

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

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

Implements VCF::ControlPeer.

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

Implements VCF::ControlPeer.

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

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

Implements VCF::ControlPeer.

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

returns the component that this Peer is attached to.

Implements VCF::ControlPeer.

static OSXControl* VCF::OSXControl::getControlFromControlRef (  ControlRef  control  )  [static]
 

static EventHandlerUPP VCF::OSXControl::getEventHandlerUPP (   )  [static, protected]
 

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

returns a ID that identifies this control.

On Win32 this corresponds to an HWND.

Implements VCF::ControlPeer.

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

Implements VCF::ControlPeer.

virtual String VCF::OSXControl::getText (   )  [inline, virtual]
 

returns a text associated with the component.

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

Implements VCF::ControlPeer.

Reimplemented in VCF::OSXButton, and VCF::OSXTextEditPeer.

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

returns wether or not the component is currently visible.

Implements VCF::ControlPeer.

OSStatus VCF::OSXControl::handleControlTrack (  EventRef  theEvent  )  [protected]
 

virtual OSStatus VCF::OSXControl::handleOSXEvent (  EventHandlerCallRef  nextHandler,
EventRef  theEvent
)  [protected, virtual]
 

Reimplemented in VCF::OSXButton, VCF::OSXListview, VCF::OSXTextEditPeer, and VCF::OSXTree.

static OSStatus VCF::OSXControl::handleOSXEvents (  EventHandlerCallRef  nextHandler,
EventRef  theEvent,
void *  userData
)  [static, protected]
 

OSStatus VCF::OSXControl::handleWrappedControlHitTest (  EventRef  theEvent  )  [protected]
 

OSStatus VCF::OSXControl::handleWrappedControlTrack (  EventRef  theEvent  )  [protected]
 

OSStatus VCF::OSXControl::handleWrappedControlTrackDone (  EventRef  theEvent  )  [protected]
 

OSStatus VCF::OSXControl::installStdControlHandler (   )  [protected]
 

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

Implements VCF::ControlPeer.

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

Implements VCF::ControlPeer.

virtual void VCF::OSXControl::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::OSXControl::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::OSXControl::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::OSXControl::releaseMouseEvents (   )  [virtual]
 

releases mouse events - goes back to normal event handling

Implements VCF::ControlPeer.

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

Implements VCF::ControlPeer.

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

virtual void VCF::OSXControl::setBounds (  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::OSXControl::setControl (  Control *  component  )  [virtual]
 

attahces the Peer to a particular component.

This should only be done once.

Implements VCF::ControlPeer.

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

Implements VCF::ControlPeer.

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

Implements VCF::ControlPeer.

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

Implements VCF::ControlPeer.

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

Implements VCF::ControlPeer.

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

Implements VCF::ControlPeer.

virtual void VCF::OSXControl::setText (  const String &  text  )  [inline, virtual]
 

sets the text for the control

Implements VCF::ControlPeer.

Reimplemented in VCF::OSXButton, and VCF::OSXTextEditPeer.

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

Member Data Documentation

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

EventHandlerRef VCF::OSXControl::handlerRef_ [protected]
 

ControlRef VCF::OSXControl::hiView_ [protected]
 

::Point VCF::OSXControl::lastMousePt_ [protected]
 

MouseState VCF::OSXControl::mouseState_ [protected]
 

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