IlvSCGadgetContainerRectangle Class Reference

View rectangle class. More...

#include <ilviews/gadgets/rectscgc.h>

Inheritance diagram for IlvSCGadgetContainerRectangle:

List of all members.

Public Member Functions
	IlvSCGadgetContainerRectangle (IlvDisplay *display, const IlvRect &rect, IlvPalette *palette=0)
	Constructor.
virtual IlvGadgetContainer *	getGadgetContainer () const
	Returns a pointer to the encapsulated gadget container.
IlvScrollBar *	getHorizontalScrollBar () const
	Returns a pointer to the horizontal scroll bar used by this object.
IlvScrolledView *	getScrolledView () const
	Returns a pointer to the scrolled view that contains the gadget container encapsulated by the object.
IlvScrollBar *	getVerticalScrollBar () const
	Returns a pointer to the vertical scroll bar used by this object.
void	hideScrollBar (IlvOrientation direction)
	Hides the scroll bar specified by direction.
IlBoolean	isUsingScrollBar (IlvOrientation direction)
	Indicates whether the specified scroll bar is used.
void	moveScrollBar (IlvOrientation direction, IlvPosition where)
	Moves the scroll bar specified by direction to a new position.
void	showScrollBar (IlvOrientation direction)
	Shows the scroll bar specified by direction.
IlvPosition	whereIsScrollBar (IlvOrientation direction) const
	Returns the location of the specified scroll bar.

---

Detailed Description

View rectangle class.

Library: ilvgadgt

The IlvSCGadgetContainerRectangle class implements an IlvGadgetContainerRectangle with scroll bars. You can decide whether the scroll bars should be shown or hidden. This class actually creates an IlvScrolledView object that contains the gadget container encapsulated by this object.

See also:

IlvScrolledView

---

Constructor & Destructor Documentation

IlvSCGadgetContainerRectangle::IlvSCGadgetContainerRectangle	(	IlvDisplay *	display,
		const IlvRect &	rect,
		IlvPalette *	palette = 0
	)

Constructor.

Initializes a new instance of the IlvSCGadgetContainerRectangle class.

Parameters:

	display	The connection to the display.
	rect	The object size.
	palette	The object palette. The palette background color is set to the background color of the encapsulated gadget container.

---

Member Function Documentation

virtual IlvGadgetContainer* IlvSCGadgetContainerRectangle::getGadgetContainer

(

)

const [virtual]

Returns a pointer to the encapsulated gadget container.

Returns:

A pointer to the gadget container encapsulated by this object.

Reimplemented from IlvGadgetContainerRectangle.

IlvScrollBar* IlvSCGadgetContainerRectangle::getHorizontalScrollBar

(

)

const

Returns a pointer to the horizontal scroll bar used by this object.

Returns:

A pointer to the horizontal scroll bar used by this object.

See also:

getVerticalScrollBar

IlvScrolledView* IlvSCGadgetContainerRectangle::getScrolledView

(

)

const

Returns a pointer to the scrolled view that contains the gadget container encapsulated by the object.

Returns:

A pointer to the scrolled view that contains the gadget container encapsulated by this object.

IlvScrollBar* IlvSCGadgetContainerRectangle::getVerticalScrollBar

(

)

const

Returns a pointer to the vertical scroll bar used by this object.

Returns:

A pointer to the vertical scroll bar used by this object.

See also:

getHorizontalScrollBar

void IlvSCGadgetContainerRectangle::hideScrollBar

(

IlvOrientation

direction

)

Hides the scroll bar specified by direction.

Hides the scroll bar specified by direction and deactivates it.

Parameters:

direction

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

See also:

showScrollBar, getHorizontalScrollBar, getVerticalScrollBar

IlBoolean IlvSCGadgetContainerRectangle::isUsingScrollBar

(

IlvOrientation

direction

)

Indicates whether the specified scroll bar is used.

Parameters:

direction

The scroll bar direction. Valid valued are: IlvHorizontal or IlvVertical.

Returns:

IlTrue if the scroll bar specified by direction is used and IlFalse otherwise.

See also:

useScrollBar

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

Moves the scroll bar specified by direction to a new position.

Parameters:

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

See also:

showScrollBar, hideScrollBar, whereIsScrollBar

void IlvSCGadgetContainerRectangle::showScrollBar

(

IlvOrientation

direction

)

Shows the scroll bar specified by direction.

Displays the scroll bar specified by direction and activates it.

Parameters:

direction

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

See also:

hideScrollBar, getHorizontalScrollBar, getVerticalScrollBar

IlvPosition IlvSCGadgetContainerRectangle::whereIsScrollBar

(

IlvOrientation

direction

)

const

Returns the location of the specified scroll bar.

Parameters:

direction

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

Returns:

The location of the scroll bar indicated by direction.

See also:

moveScrollBar