Rogue Wave Views 5.6
Rogue Wave Views
Gadgets Package API Reference Guide
Rogue Wave Views
Documentation Home
Rogue Wave Views 5.6 |
Rogue Wave Views |
Rogue Wave Views Documentation Home |
View container class. More...
#include <ilviews/gadgets/scview.h>
Public Member Functions | |
| IlvScrolledView (IlvAbstractView *parent, const IlvRect &rect, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvScrolledView (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvScrolledView (IlvDisplay *display, IlvSystemView window) | |
| Constructor. More... | |
| IlvScrolledView (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvScrolledView (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties, IlBoolean visible=IlTrue, IlvSystemView transientFor=0) | |
| Constructor. More... | |
| IlvView * | getClipView () const |
| Returns the clipping view. More... | |
| IlvScrollBar * | getHorizontalScrollBar () const |
| Returns the horizontal scroll bar. More... | |
| IlvAbstractView * | getScrolledView () const |
| Returns the view that is being scrolled. More... | |
| IlvScrollBar * | getVerticalScrollBar () const |
| Returns the vertical scroll bar. More... | |
| void | hideScrollBar (IlvOrientation direction) |
| Hides the specified scroll bar. More... | |
| void | moveScrollBar (IlvOrientation direction, IlvPosition where) |
| Moves the specified scroll bar to a new position. More... | |
| void | showScrollBar (IlvOrientation direction) |
| Shows the specified scroll bar. More... | |
| IlvPosition | whereIsScrollBar (IlvOrientation direction) const |
| Indicates the position of the specified scroll bar. More... | |
 Public Member Functions inherited from IlvGadgetContainer | |
| IlvGadgetContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvGadgetContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue, IlvSystemView transientFor=0) | |
| Constructor. More... | |
| IlvGadgetContainer (IlvAbstractView *parent, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvGadgetContainer (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue) | |
| Constructor. More... | |
| IlvGadgetContainer (IlvDisplay *display, IlvSystemView window, IlBoolean useacc=IlFalse) | |
| Constructor. More... | |
| virtual IlBoolean | allowFocus (IlBoolean value) |
| Specifies whether the container manages the focus. More... | |
| virtual void | applyResize (IlFloat sx, IlFloat sy, IlBoolean redraw=IlTrue) |
| Is called to carry out the resize events applying to the gadget container. More... | |
| IlBoolean | autoResize (IlBoolean a) |
| Sets the auto resize mode of the gadget container. More... | |
| IlvButton * | getDefaultButton () const |
| Returns the default button of the gadget container. More... | |
| virtual IlvGraphic * | getFirstFocusGraphic () const |
| Returns the first object that receives the focus in this container. More... | |
| virtual IlvGraphic * | getFocus () const |
| Returns the object that has the keyboard focus in the gadget container. More... | |
| virtual IlvGraphic * | getGrab () const |
| Returns the object that is currently grabbing events in the container. More... | |
| virtual IlvGraphic * | getLastFocusGraphic () const |
| Returns the last object that receives the focus in this container. More... | |
| IlvLookFeelHandler * | getLookFeelHandler () const |
| Returns the look and feel handler associated with this container. More... | |
| virtual IlvGraphic * | getNextFocusGraphic (IlvGraphic *object) const |
| Returns the next object that will receive the focus after the specified object. More... | |
| IlvGraphic * | getOverriddenFocus () const |
Returns the object that will receive the focus after calling setFocus. More... | |
| virtual IlvGraphic * | getPreviousFocusGraphic (IlvGraphic *object) const |
| Returns the previous object that received the focus before the specified object. More... | |
| IlBoolean | isAutoResizing () const |
| Indicates whether the gadget container gets resized when loading a file. More... | |
| virtual IlBoolean | isFocusAllowed () const |
| Indicates whether the focus is allowed in the container. More... | |
| virtual void | moveFocusAfter (IlBoolean redraw=IlTrue) |
| Is called to find the next focusable object. More... | |
| virtual void | moveFocusBefore (IlBoolean redraw=IlTrue) |
| Is called to find the previous focusable object. More... | |
| void | overrideFocus (IlvGraphic *obj) |
Sets the object that will receive the focus after calling setFocus. More... | |
| virtual void | removeGrab () |
Cancels the grabbing settings defined with setGrab. More... | |
| void | setDefaultButton (IlvButton *, IlBoolean redraw=IlTrue) |
| Sets the default button of the gadget container. More... | |
| virtual void | setFocus (IlvGraphic *graphic=0, IlBoolean redraw=IlTrue) |
| Sets the focus to the specified object of the gadget container. More... | |
| virtual void | setGrab (IlvGraphic *object) |
| Sets the specified object as the grabbing object. More... | |
| void | setLookFeelHandler (IlvLookFeelHandler *lfh) |
| Sets the look and feel handler of this container. More... | |
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
| 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.
| 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.
| 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.
| 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.
| 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.
| 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. |
| IlvView* IlvScrolledView::getClipView | ( | ) | const |
Returns the clipping view.
This view must be the parent of the view to be scrolled.
| IlvScrollBar* IlvScrolledView::getHorizontalScrollBar | ( | ) | const |
| IlvAbstractView* IlvScrolledView::getScrolledView | ( | ) | const |
Returns the view that is being scrolled.
| IlvScrollBar* IlvScrolledView::getVerticalScrollBar | ( | ) | const |
| void IlvScrolledView::hideScrollBar | ( | IlvOrientation | direction | ) |
Hides the specified scroll bar.
Hides the scroll bar that has the specified direction and deactivates it.
| direction | The scroll bar direction. Valid values are: IlvHorizontal and IlvVertical. |
| void IlvScrolledView::moveScrollBar | ( | IlvOrientation | direction, |
| IlvPosition | where | ||
| ) |
Moves the specified scroll bar to a new position.
| 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. |
| void IlvScrolledView::showScrollBar | ( | IlvOrientation | direction | ) |
Shows the specified scroll bar.
Displays the scroll bar that has the specified direction and activates it.
| direction | The scroll bar direction. Valid values are: IlvHorizontal and IlvVertical. |
| IlvPosition IlvScrolledView::whereIsScrollBar | ( | IlvOrientation | direction | ) | const |
Indicates the position of the specified scroll bar.
| direction | The direction of the scroll bar to be located. Valid values are: IlvHorizontal and IlvVertical. |
© Copyright 2012, 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.