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

FX::FXScrollWindow Class Reference

The ScrollWindow widget manages one single child window and scrolls it when the child is larger than the available area. More...

#include <FXScrollWindow.h>

Inheritance diagram for FX::FXScrollWindow:

FX::FXScrollArea FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject

List of all members.

Public Member Functions

 FXScrollWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
virtual void layout ()
FXWindowcontentWindow () const
virtual FXint getContentWidth ()
virtual FXint getContentHeight ()


Detailed Description

The ScrollWindow widget manages one single child window and scrolls it when the child is larger than the available area.

You can use ScrollWindow when parts of your user interface need to be scrollable, for example when applications may need to run on small screens. ScrollWindow normally contains only one single child window, which could be a VerticalFrame or any other widget. It will measure this widget using getDefaultWidth() and getDefaultHeight() and place the scrollbars when needed, based on options like HSCROLLING_ALWAYS, etc., and the options of the child window. ScrollWindow observes some layout hints of its child window: LAYOUT_FIX_WIDTH, LAYOUT_FIX_HEIGHT are observed at all times, while LAYOUT_FILL_X, LAYOUT_LEFT, LAYOUT_RIGHT, LAYOUT_CENTER_X, as well as LAYOUT_FILL_Y, LAYOUT_TOP, LAYOUT_BOTTOM, LAYOUT_CENTER_Y are only observed if the child window size is smaller than the ScrollWindow's viewport size. If the content size is larger than the viewport size, the content must be scrolled normally. Note that this means that the child window's position is not necessarily equal to the scroll position of the scroll window!


Constructor & Destructor Documentation

FX::FXScrollWindow::FXScrollWindow ( FXComposite p,
FXuint  opts = 0,
FXint  x = 0,
FXint  y = 0,
FXint  w = 0,
FXint  h = 0 
)

Construct a scroll window.


Member Function Documentation

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

Perform layout.

Reimplemented from FX::FXScrollArea.

FXWindow* FX::FXScrollWindow::contentWindow (  )  const

Return a pointer to the contents window.

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

Return the width of the contents.

Reimplemented from FX::FXScrollArea.

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

Return the height of the contents.

Reimplemented from FX::FXScrollArea.

Copyright © 1997-2009 Jeroen van der Zijp