Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

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:

FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject FX::FXBitmapView FX::FXConsole FX::FXFoldingList FX::FXIconList FX::FXImageView FX::FXList FX::FXRulerView FX::FXScrollWindow FX::FXTable FX::FXText FX::FXTreeList

List of all members.

Public Member Functions

virtual FXint getDefaultWidth ()
virtual FXint getDefaultHeight ()
virtual void layout ()
FXint getContentX () const
FXint getContentY () const
virtual FXint getContentWidth ()
virtual FXint getContentHeight ()
virtual FXint getVisibleX () const
virtual FXint getVisibleY () const
virtual FXint getVisibleWidth () const
virtual FXint getVisibleHeight () const
FXbool isHorizontalScrollable () const
FXbool isVerticalScrollable () const
void setScrollStyle (FXuint style)
FXuint getScrollStyle () const
FXScrollBarhorizontalScrollBar () const
FXScrollBarverticalScrollBar () const
void setPosition (FXint x, FXint y)
void getPosition (FXint &x, FXint &y) const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
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:


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::FXConsole, FX::FXFoldingList, FX::FXList, FX::FXRulerView, FX::FXTable, FX::FXText, and FX::FXTreeList.

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

Return default height.

Reimplemented from FX::FXComposite.

Reimplemented in FX::FXConsole, FX::FXFoldingList, FX::FXList, FX::FXRulerView, FX::FXTable, FX::FXText, and FX::FXTreeList.

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

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

Return content area x position.

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

Return content area y position.

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

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

virtual FXint FX::FXScrollArea::getVisibleX (  )  const [virtual]

Return visible scroll-area x position.

Reimplemented in FX::FXRulerView, FX::FXTable, and FX::FXText.

virtual FXint FX::FXScrollArea::getVisibleY (  )  const [virtual]

Return visible scroll-area y position.

Reimplemented in FX::FXFoldingList, FX::FXIconList, FX::FXRulerView, FX::FXTable, and FX::FXText.

virtual FXint FX::FXScrollArea::getVisibleWidth (  )  const [virtual]

Return visible scroll-area width.

Reimplemented in FX::FXRulerView, FX::FXTable, and FX::FXText.

virtual FXint FX::FXScrollArea::getVisibleHeight (  )  const [virtual]

Return visible scroll-area height.

Reimplemented in FX::FXFoldingList, FX::FXIconList, FX::FXRulerView, FX::FXTable, and FX::FXText.

FXbool FX::FXScrollArea::isHorizontalScrollable (  )  const

Return true if horizontally scrollable.

FXbool FX::FXScrollArea::isVerticalScrollable (  )  const

Return true if vertically scrollable.

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

Change scroll style.

FXuint FX::FXScrollArea::getScrollStyle (  )  const

Return scroll style.

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.

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.

virtual void FX::FXScrollArea::save ( FXStream store  )  const [virtual]

virtual void FX::FXScrollArea::load ( FXStream store  )  [virtual]

Copyright © 1997-2009 Jeroen van der Zijp