IlvScrolledView Class Reference

View container class. More...

#include <ilviews/gadgets/scview.h>

Inheritance diagram for IlvScrolledView:

List of all members.

Public Member Functions
	IlvScrolledView (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties, IlBoolean visible=IlTrue, IlvSystemView transientFor=0)
	Constructor.
	IlvScrolledView (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlBoolean visible=IlTrue)
	Constructor.
	IlvScrolledView (IlvDisplay *display, IlvSystemView window)
	Constructor.
	IlvScrolledView (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlBoolean visible=IlTrue)
	Constructor.
	IlvScrolledView (IlvAbstractView *parent, const IlvRect &rect, IlBoolean visible=IlTrue)
	Constructor.
IlvView *	getClipView () const
	Returns the clipping view.
IlvScrollBar *	getHorizontalScrollBar () const
	Returns the horizontal scroll bar.
IlvAbstractView *	getScrolledView () const
	Returns the view that is being scrolled.
IlvScrollBar *	getVerticalScrollBar () const
	Returns the vertical scroll bar.
void	hideScrollBar (IlvOrientation direction)
	Hides the specified scroll bar.
void	moveScrollBar (IlvOrientation direction, IlvPosition where)
	Moves the specified scroll bar to a new position.
void	showScrollBar (IlvOrientation direction)
	Shows the specified scroll bar.
IlvPosition	whereIsScrollBar (IlvOrientation direction) const
	Indicates the position of the specified scroll bar.

---

Detailed Description

View container class.

Library: ilvadvgdt

The IlvScrolledView class is a predefined gadget container class that lets you create scrolled views. This class builds the necessary view hierarchy to create a window with scroll bars. Once you have created an IlvScrolledView, you add the scrollable view as a subview of the clipping view of this object. The logical representation of the hierarchy looks like this:

Layout Of A Scrolled View

See also:

IlvScrollView, IlvSCGadgetContainerRectangle

---

Constructor & Destructor Documentation

IlvScrolledView::IlvScrolledView	(	IlvAbstractView *	parent,
		const IlvRect &	rect,
		IlBoolean	visible = IlTrue
	)

Constructor.

Initializes a new instance of the IlvScrolledView class as a child view of parent.

Parameters:

	parent	The parent view of the scrolled view.
	rect	The size and position of the scrolled view.
	visible	A Boolean value specifying whether the view should be visible.

IlvScrolledView::IlvScrolledView	(	IlvDisplay *	display,
		IlvSystemView	parent,
		const IlvRect &	rect,
		IlBoolean	visible = IlTrue
	)

Constructor.

Initializes a new instance of the IlvScrolledView class as a child view of the system view specified by parent.

Parameters:

	display	The connection to the display.
	parent	The parent view of the scrolled view.
	rect	The size and position of the scrolled view.
	visible	A Boolean value specifying whether the view should be visible.

IlvScrolledView::IlvScrolledView	(	IlvDisplay *	display,
		IlvSystemView	window
	)

Constructor.

Initializes a new instance of the IlvScrolledView class mapped to the existing system view specified by window.

Parameters:

	display	The connection to the display.
	window	The system view to which the scrolled view is mapped.

IlvScrolledView::IlvScrolledView	(	IlvDisplay *	display,
		const char *	name,
		const char *	title,
		const IlvRect &	rect,
		IlBoolean	visible = IlTrue
	)

Constructor.

Initializes a new instance of the IlvScrolledView class as a top view.

Parameters:

	display	The connection to the display.
	name	The name of the scrolled view.
	title	The title of the scrolled view.
	rect	The size and position of the scrolled view.
	visible	A Boolean value specifying whether the view should be visible.

IlvScrolledView::IlvScrolledView	(	IlvDisplay *	display,
		const char *	name,
		const char *	title,
		const IlvRect &	rect,
		IlUInt	properties,
		IlBoolean	visible = IlTrue,
		IlvSystemView	transientFor = 0
	)

Constructor.

Initializes a new instance of the IlvScrolledView class as a top view.

Parameters:

	display	The connection to the display.
	name	The name of the scrolled view.
	title	The title of the scrolled view.
	rect	The size and position of the scrolled view.
	properties	The properties of the scrolled view. For details, see the IlvView constructors.
	visible	A Boolean value specifying whether the view should be visible.
	transientFor	The system view for which the scrolled view is transient. For details, see the IlvView constructors.

---

Member Function Documentation

IlvView* IlvScrolledView::getClipView

(

)

const

Returns the clipping view.

This view must be the parent of the view to be scrolled.

Returns:

The clipping view.

See also:

getScrolledView

IlvScrollBar* IlvScrolledView::getHorizontalScrollBar

(

)

const

Returns the horizontal scroll bar.

Returns:

The horizontal scroll bar.

See also:

getVerticalScrollBar

IlvAbstractView* IlvScrolledView::getScrolledView

(

)

const

Returns the view that is being scrolled.

Returns:

The view that is being scrolled.

See also:

getClipView

IlvScrollBar* IlvScrolledView::getVerticalScrollBar

(

)

const

Returns the vertical scroll bar.

Returns:

The vertical scroll bar.

See also:

getHorizontalScrollBar

void IlvScrolledView::hideScrollBar

(

IlvOrientation

direction

)

Hides the specified scroll bar.

Hides the scroll bar that has the specified direction and deactivates it.

Parameters:

direction

The scroll bar direction. Valid values are: IlvHorizontal and IlvVertical.

See also:

showScrollBar, getHorizontalScrollBar, getVerticalScrollBar

void IlvScrolledView::moveScrollBar	(	IlvOrientation	direction,
		IlvPosition	where
	)

Moves the specified scroll bar to a new position.

Parameters:

	direction	The direction of the scroll bar to be moved to a new position. Valid values are: IlvHorizontal and IlvVertical.
	where	The new position of the scroll bar. Valid values are: IlvLeft and IlvRight for horizontal scroll bars, and IlvTop and IlvBottom for vertical scroll bars.

See also:

showScrollBar, hideScrollBar, whereIsScrollBar

void IlvScrolledView::showScrollBar

(

IlvOrientation

direction

)

Shows the specified scroll bar.

Displays the scroll bar that has the specified direction and activates it.

Parameters:

direction

The scroll bar direction. Valid values are: IlvHorizontal and IlvVertical.

See also:

hideScrollBar, getHorizontalScrollBar, getVerticalScrollBar

IlvPosition IlvScrolledView::whereIsScrollBar

(

IlvOrientation

direction

)

const

Indicates the position of the specified scroll bar.

Parameters:

direction

The direction of the scroll bar to be located. Valid values are: IlvHorizontal and IlvVertical.

Returns:

The position of the scroll bar indicated by direction.

See also:

moveScrollBar