FX::FXScrollArea Class Reference

The scroll area widget manages a content area and a viewport area through which the content is viewed. More...

#include <FXScrollArea.h>

Inheritance diagram for FX::FXScrollArea:

List of all members.

Public Member Functions
virtual FXint	getDefaultWidth ()
virtual FXint	getDefaultHeight ()
virtual void	layout ()
virtual FXint	getViewportHeight ()
virtual FXint	getViewportWidth ()
virtual FXint	getContentWidth ()
virtual FXint	getContentHeight ()
void	setScrollStyle (FXuint style)
FXuint	getScrollStyle () const
FXbool	isHorizontalScrollable () const
FXbool	isVerticalScrollable () const
FXScrollBar *	horizontalScrollBar () const
FXScrollBar *	verticalScrollBar () const
FXint	getXPosition () const
FXint	getYPosition () const
void	setPosition (FXint x, FXint y)
void	getPosition (FXint &x, FXint &y) const
virtual	~FXScrollArea ()

---

Detailed Description

The scroll area widget manages a content area and a viewport area through which the content is viewed.

When the content area becomes larger than the viewport area, scrollbars are placed to permit viewing of the entire content by scrolling the content. Depending on the mode, scrollbars may be displayed on an as-needed basis, always, or never. Normally, the scroll area's size and the content's size are independent; however, it is possible to disable scrolling in the horizontal (vertical) direction. In this case, the content width (height) will influence the width (height) of the scroll area widget. For content which is time-consuming to repaint, continuous scrolling may be turned off.

See also:

• Scrollbar options.

---

Constructor & Destructor Documentation

virtual FX::FXScrollArea::~FXScrollArea (   )  [virtual]

Destructor.

---

Member Function Documentation

virtual FXint FX::FXScrollArea::getDefaultWidth (   )  [virtual]

Return default width. Reimplemented from FX::FXComposite. Reimplemented in FX::FXFoldingList, FX::FXList, FX::FXTable, FX::FXText, and FX::FXTreeList.

virtual FXint FX::FXScrollArea::getDefaultHeight (   )  [virtual]

Return default height. Reimplemented from FX::FXComposite. Reimplemented in FX::FXFoldingList, FX::FXList, FX::FXTable, FX::FXText, and FX::FXTreeList.

virtual void FX::FXScrollArea::layout (   )  [virtual]

Perform layout. Reimplemented from FX::FXComposite. Reimplemented in FX::FXBitmapView, FX::FXFoldingList, FX::FXIconList, FX::FXImageView, FX::FXList, FX::FXScrollWindow, FX::FXTable, FX::FXText, and FX::FXTreeList.

virtual FXint FX::FXScrollArea::getViewportHeight (   )  [virtual]

Return viewport height. Reimplemented in FX::FXIconList.

virtual FXint FX::FXScrollArea::getViewportWidth (   )  [virtual]

Return viewport width.

virtual FXint FX::FXScrollArea::getContentWidth (   )  [virtual]

Return content width. Reimplemented in FX::FXBitmapView, FX::FXFoldingList, FX::FXIconList, FX::FXImageView, FX::FXList, FX::FXScrollWindow, FX::FXTable, FX::FXText, and FX::FXTreeList.

virtual FXint FX::FXScrollArea::getContentHeight (   )  [virtual]

Return content height. Reimplemented in FX::FXBitmapView, FX::FXFoldingList, FX::FXIconList, FX::FXImageView, FX::FXList, FX::FXScrollWindow, FX::FXTable, FX::FXText, and FX::FXTreeList.

void FX::FXScrollArea::setScrollStyle (  FXuint  style  )

Change scroll style.

FXuint FX::FXScrollArea::getScrollStyle (   )  const

Return scroll style.

FXbool FX::FXScrollArea::isHorizontalScrollable (   )  const

Return TRUE if horizontally scrollable.

FXbool FX::FXScrollArea::isVerticalScrollable (   )  const

Return TRUE if vertically scrollable.

FXScrollBar* FX::FXScrollArea::horizontalScrollBar (   )  const [inline]

Return a pointer to the horizontal scrollbar.

FXScrollBar* FX::FXScrollArea::verticalScrollBar (   )  const [inline]

Return a pointer to the vertical scrollbar.

FXint FX::FXScrollArea::getXPosition (   )  const [inline]

Return the current x-position.

FXint FX::FXScrollArea::getYPosition (   )  const [inline]

Return the current y-position.

void FX::FXScrollArea::setPosition (  FXint  x, FXint  y )

Set the current position.

void FX::FXScrollArea::getPosition (  FXint &  x, FXint &  y )  const [inline]

Get the current position.

Copyright © 1997-2005 Jeroen van der Zijp