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

VCF::OSXScrollPeer Class Reference

Class OSXScrollPeer documentation. More...

#include <OSXScrollPeer.h>

Inheritance diagram for VCF::OSXScrollPeer:

VCF::Object VCF::ScrollPeer VCF::Interface List of all members.

Public Member Functions

 OSXScrollPeer (Control *scrollableControl=NULL)
virtual ~OSXScrollPeer ()
virtual void scrollTo (const double &xPosition, const double &yPosition)
 moves the scrollbox of a scrollbar to the specified position.
virtual void getAdjustedPositions (double &xPosition, double &yPosition)
 gets the position of the scrollbox of a scrollbar adjusted by what the OS decides that position to be.
virtual bool isVerticalScrollbarVisible ()
 tells if the vertical scollbar is actually visible.
virtual bool isHorizontalScrollbarVisible ()
 tells if the horizontal scollbar is actually visible.
virtual void recalcScrollPositions (Scrollable *scrollable)
 recalculates all the positions and visibility status of all the scrollbars connected to a control.
virtual Control * getScrollableControl ()
 gets the control this scroll peer has been assogiated to.
virtual void setScrollableControl (Control *scrollableControl)
 sets the target control for the scrolling operation of this scroll peer instance.
virtual double getHorizontalScrollbarHeight ()
 gets the height ( the 'thickness' ) of an horizontal scrollbar.
virtual double getVerticalScrollbarWidth ()
 gets the width ( the 'thickness' ) of a vertical scrollbar.
virtual void getHorizontalScrollRects (Rect *scrollBounds, Rect *leftBounds=NULL, Rect *rightBounds=NULL)
 this will retrieves the values for three rectangular bounds, the bounds of the scroll bar portion, the bounds of the left most spacer, and the bounds of the right most spacer.
virtual void getVerticalScrollRects (Rect *scrollBounds, Rect *topBounds=NULL, Rect *bottomBounds=NULL)
 this will retrieves the values for three rectangular bounds, the bounds of the scroll bar portion, the bounds of the left most spacer, and the bounds of the right most spacer.

Protected Attributes

Control * scrollableControl_

Detailed Description

Class OSXScrollPeer documentation.

Constructor & Destructor Documentation

VCF::OSXScrollPeer::OSXScrollPeer (  Control *  scrollableControl = NULL  ) 
 

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

Member Function Documentation

virtual void VCF::OSXScrollPeer::getAdjustedPositions (  double &  xPosition,
double &  yPosition
)  [virtual]
 

gets the position of the scrollbox of a scrollbar adjusted by what the OS decides that position to be.

See also:
ScrollPeer::scrollTo()

Implements VCF::ScrollPeer.

virtual double VCF::OSXScrollPeer::getHorizontalScrollbarHeight (   )  [virtual]
 

gets the height ( the 'thickness' ) of an horizontal scrollbar.

Implements VCF::ScrollPeer.

virtual void VCF::OSXScrollPeer::getHorizontalScrollRects (  Rect *  scrollBounds,
Rect *  leftBounds = NULL,
Rect *  rightBounds = NULL
)  [virtual]
 

this will retrieves the values for three rectangular bounds, the bounds of the scroll bar portion, the bounds of the left most spacer, and the bounds of the right most spacer.

If a scroll bar has it's left and/or right scroll space set to 0, then the right and left bounds for the spacers may be null, or a rect of (0,0,0,0).

Parameters:
Rect scrollBounds, the bounds of the actual horizontal scroll bar rect, if this is NULL no value is returned
Rect leftBounds, the bounds of the left spacer rect, if this is NULL no value is set
Rect rightBounds, the bounds of the right spacer rect, if this is NULL no value is set

Implements VCF::ScrollPeer.

virtual Control* VCF::OSXScrollPeer::getScrollableControl (   )  [inline, virtual]
 

gets the control this scroll peer has been assogiated to.

See also:
setScrollableControl()

Implements VCF::ScrollPeer.

virtual double VCF::OSXScrollPeer::getVerticalScrollbarWidth (   )  [virtual]
 

gets the width ( the 'thickness' ) of a vertical scrollbar.

Implements VCF::ScrollPeer.

virtual void VCF::OSXScrollPeer::getVerticalScrollRects (  Rect *  scrollBounds,
Rect *  topBounds = NULL,
Rect *  bottomBounds = NULL
)  [virtual]
 

this will retrieves the values for three rectangular bounds, the bounds of the scroll bar portion, the bounds of the left most spacer, and the bounds of the right most spacer.

If a scroll bar has it's left and/or right scroll space set to 0, then the right and left bounds for the spacers may be null, or a rect of (0,0,0,0).

Parameters:
Rect scrollBounds, the bounds of the actual vertical scroll bar rect, if this is NULL no value is set
Rect topBounds, the bounds of the top spacer rect, if this is NULL no value is set
Rect bottomBounds, the bounds of the bottom spacer rect, if this is NULL no value is set

Implements VCF::ScrollPeer.

virtual bool VCF::OSXScrollPeer::isHorizontalScrollbarVisible (   )  [virtual]
 

tells if the horizontal scollbar is actually visible.

Implements VCF::ScrollPeer.

virtual bool VCF::OSXScrollPeer::isVerticalScrollbarVisible (   )  [virtual]
 

tells if the vertical scollbar is actually visible.

Implements VCF::ScrollPeer.

virtual void VCF::OSXScrollPeer::recalcScrollPositions (  Scrollable *  scrollable  )  [virtual]
 

recalculates all the positions and visibility status of all the scrollbars connected to a control.

This function must be called after some changes have been made on the target, the size of the object to scroll, or any scrollbar.

Implements VCF::ScrollPeer.

virtual void VCF::OSXScrollPeer::scrollTo (  const double &  xPosition,
const double &  yPosition
)  [virtual]
 

moves the scrollbox of a scrollbar to the specified position.

Keep in mind that the final position may differ fom the specified one because the OS may change that actual position because of roundings and other internal considerations related to the position of the involved controls and windows.

See also:
ScrollPeer::getAdjustedPositions()
Parameters:
const double& xPosition, the desired position in the horizontal scrollbar
const double& yPosition, the desired position in the vertical scrollbar

Implements VCF::ScrollPeer.

virtual void VCF::OSXScrollPeer::setScrollableControl (  Control *  scrollableControl  )  [virtual]
 

sets the target control for the scrolling operation of this scroll peer instance.

At this point the content of the control will be scrolled by the scrollable.

See also:
Scrollable::setScrollableControl()

Implements VCF::ScrollPeer.

Member Data Documentation

Control* VCF::OSXScrollPeer::scrollableControl_ [protected]
 

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