Rogue Wave Views
Gadgets Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvSCGadgetContainerRectangle Class Reference

View rectangle class. More...

#include <ilviews/gadgets/rectscgc.h>

Inheritance diagram for IlvSCGadgetContainerRectangle:
IlvGadgetContainerRectangle IlvContainerRectangle IlvViewRectangle IlvFilledRectangle IlvRectangle IlvSimpleGraphic IlvGraphic IlvValueInterface

Public Member Functions

 IlvSCGadgetContainerRectangle (IlvDisplay *display, const IlvRect &rect, IlvPalette *palette=0)
 Constructor. More...
 
virtual IlvGadgetContainergetGadgetContainer () const
 Returns a pointer to the encapsulated gadget container. More...
 
IlvScrollBargetHorizontalScrollBar () const
 Returns a pointer to the horizontal scroll bar used by this object. More...
 
IlvScrolledViewgetScrolledView () const
 Returns a pointer to the scrolled view that contains the gadget container encapsulated by the object. More...
 
IlvScrollBargetVerticalScrollBar () const
 Returns a pointer to the vertical scroll bar used by this object. More...
 
void hideScrollBar (IlvOrientation direction)
 Hides the scroll bar specified by direction. More...
 
IlBoolean isUsingScrollBar (IlvOrientation direction)
 Indicates whether the specified scroll bar is used. More...
 
void moveScrollBar (IlvOrientation direction, IlvPosition where)
 Moves the scroll bar specified by direction to a new position. More...
 
void showScrollBar (IlvOrientation direction)
 Shows the scroll bar specified by direction. More...
 
IlvPosition whereIsScrollBar (IlvOrientation direction) const
 Returns the location of the specified scroll bar. More...
 
- Public Member Functions inherited from IlvGadgetContainerRectangle
 IlvGadgetContainerRectangle (IlvDisplay *display, const IlvRect &rect, IlvPalette *palette=0)
 Constructor. More...
 

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 creates an IlvScrolledView object containing the gadget container encapsulated by this object.

See also
IlvScrolledView

Styling

This class supports the following CSS properties:

Graphic property CSS property Type
Background color background-colorColor

Constructor & Destructor Documentation

§ IlvSCGadgetContainerRectangle()

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

Constructor.

Initializes a new instance of the IlvSCGadgetContainerRectangle class.

Parameters
displayThe connection to the display.
rectThe object size.
paletteThe object palette. The palette background color is set to the background color of the encapsulated gadget container.

Member Function Documentation

§ getGadgetContainer()

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.

§ getHorizontalScrollBar()

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().

§ getScrolledView()

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.

§ getVerticalScrollBar()

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().

§ hideScrollBar()

void IlvSCGadgetContainerRectangle::hideScrollBar ( IlvOrientation  direction)

Hides the scroll bar specified by direction.

Hides the scroll bar specified by direction and deactivates it.

Parameters
directionThe scroll bar direction. Valid values are: IlvHorizontal or IlvVertical.
See also
showScrollBar(), getHorizontalScrollBar(), getVerticalScrollBar().

§ isUsingScrollBar()

IlBoolean IlvSCGadgetContainerRectangle::isUsingScrollBar ( IlvOrientation  direction)

Indicates whether the specified scroll bar is used.

Parameters
directionThe 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

§ moveScrollBar()

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

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

Parameters
directionThe direction of the scroll bar to be moved. Valid values are: IlvHorizontal and IlvVertical.
whereThe 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().

§ showScrollBar()

void IlvSCGadgetContainerRectangle::showScrollBar ( IlvOrientation  direction)

Shows the scroll bar specified by direction.

Displays the scroll bar specified by direction and activates it.

Parameters
directionThe scroll bar direction. Valid values are: IlvHorizontal or IlvVertical.
See also
hideScrollBar(), getHorizontalScrollBar(), getVerticalScrollBar().

§ whereIsScrollBar()

IlvPosition IlvSCGadgetContainerRectangle::whereIsScrollBar ( IlvOrientation  direction) const

Returns the location of the specified scroll bar.

Parameters
directionThe direction of the scroll bar. Valid values are: IlvHorizontal and IlvVertical.
Returns
The location of the scroll bar indicated by direction.
See also
moveScrollBar()

© Copyright 2018, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.