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

VCF::ScrollPeer Class Reference

Class ScrollPeer documentation. More...

#include <vcf/ApplicationKit/ScrollPeer.h>

Inheritance diagram for VCF::ScrollPeer:

List of all members.

Public Member Functions
virtual	~ScrollPeer ()
	destructor should be virtual
virtual void	scrollTo (const double &xPosition, const double &yPosition)=0
	moves the scrollbox of a scrollbar to the specified position.
virtual void	getAdjustedPositions (double &xPosition, double &yPosition)=0
	gets the position of the scrollbox of a scrollbar adjusted by what the OS decides that position to be.
virtual bool	isVerticalScrollbarVisible ()=0
	tells if the vertical scollbar is actually visible.
virtual bool	isHorizontalScrollbarVisible ()=0
	tells if the horizontal scollbar is actually visible.
virtual void	recalcScrollPositions (Scrollable *scrollable)=0
	recalculates all the positions and visibility status of all the scrollbars connected to a control.
virtual Control *	getScrollableControl ()=0
	gets the control this scroll peer has been assogiated to.
virtual void	setScrollableControl (Control *scrollableControl)=0
	sets the target control for the scrolling operation of this scroll peer instance.
virtual double	getHorizontalScrollbarHeight ()=0
	gets the height ( the 'thickness' ) of an horizontal scrollbar.
virtual double	getVerticalScrollbarWidth ()=0
	gets the width ( the 'thickness' ) of a vertical scrollbar.
virtual void	getHorizontalScrollRects (Rect *scrollBounds, Rect *leftBounds=NULL, Rect *rightBounds=NULL)=0
	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)=0
	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.

---

Detailed Description

Class ScrollPeer documentation.

---

Constructor & Destructor Documentation

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

destructor should be virtual

---

Member Function Documentation

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

gets the position of the scrollbox of a scrollbar adjusted by what the OS decides that position to be. See also: ScrollPeer::scrollTo() Implemented in VCF::OSXScrollPeer, and VCF::Win32ScrollPeer.

virtual double VCF::ScrollPeer::getHorizontalScrollbarHeight (   )  [pure virtual]

gets the height ( the 'thickness' ) of an horizontal scrollbar. Implemented in VCF::OSXScrollPeer, and VCF::Win32ScrollPeer.

virtual void VCF::ScrollPeer::getHorizontalScrollRects (  Rect *  scrollBounds, Rect *  leftBounds = NULL, Rect *  rightBounds = NULL )  [pure 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 Implemented in VCF::OSXScrollPeer, and VCF::Win32ScrollPeer.

virtual Control* VCF::ScrollPeer::getScrollableControl (   )  [pure virtual]

gets the control this scroll peer has been assogiated to. See also: setScrollableControl() Implemented in VCF::OSXScrollPeer, and VCF::Win32ScrollPeer.

virtual double VCF::ScrollPeer::getVerticalScrollbarWidth (   )  [pure virtual]

gets the width ( the 'thickness' ) of a vertical scrollbar. Implemented in VCF::OSXScrollPeer, and VCF::Win32ScrollPeer.

virtual void VCF::ScrollPeer::getVerticalScrollRects (  Rect *  scrollBounds, Rect *  topBounds = NULL, Rect *  bottomBounds = NULL )  [pure 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 Implemented in VCF::OSXScrollPeer, and VCF::Win32ScrollPeer.

virtual bool VCF::ScrollPeer::isHorizontalScrollbarVisible (   )  [pure virtual]

tells if the horizontal scollbar is actually visible. Implemented in VCF::OSXScrollPeer, and VCF::Win32ScrollPeer.

virtual bool VCF::ScrollPeer::isVerticalScrollbarVisible (   )  [pure virtual]

tells if the vertical scollbar is actually visible. Implemented in VCF::OSXScrollPeer, and VCF::Win32ScrollPeer.

virtual void VCF::ScrollPeer::recalcScrollPositions (  Scrollable *  scrollable  )  [pure 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. Implemented in VCF::OSXScrollPeer, and VCF::Win32ScrollPeer.

virtual void VCF::ScrollPeer::scrollTo (  const double &  xPosition, const double &  yPosition )  [pure 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 Implemented in VCF::OSXScrollPeer, and VCF::Win32ScrollPeer.

virtual void VCF::ScrollPeer::setScrollableControl (  Control *  scrollableControl  )  [pure 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() Implemented in VCF::OSXScrollPeer, and VCF::Win32ScrollPeer.

---

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

• vcf/ApplicationKit/ScrollPeer.h

Comments or Suggestions?    License Information