ScrollArea (gb.qt4)

This control is a scrollable DrawingArea. You use the ScrollArea exactly like a DrawingArea, except that:

You must define the contents size with the ResizeContents method.
You must take the value of ScrollX and ScrollY properties into account when drawing inside the Draw event handler (at least for things that must move when the user scrolls).
A ScrollArea has no Cached property. You must implement the Draw event handler.
You have a Shadow property. If you set it to TRUE, then nice shadows are drawn on borders where scrolling is possible.

This class inherits UserContainer. This class is creatable .

Properties

Background Returns or sets the background color used by the control.

Border Returns or sets the border type of the control.

ClientH A synonymous for the ClientHeight property.

ClientHeight Returns the visible height of the contents.

ClientW A synonymous for the ClientWidth property.

ClientWidth Returns the visible width of the contents.

ContentsH A synonymous for ScrollHeight.

ContentsHeight A synonymous for ScrollHeight.

ContentsW A synonymous for ScrollWidth.

ContentsWidth A synonymous for ScrollWidth.

DefaultBackground

Since 3.21

Return ot set the default background color used when the Background property is set to Color.Default.

Focus Returns or sets if the control accepts keyboard events and focus.

NoAnimation Return or set if animations are allowed when scrolling the ScrollArea.

NoBackground Return or set if the control automatically draws its background.

NoShadow Return or set if shadows are explicitly disabled.

Painted Return or set if the Paint class must be used to draw on the scrollarea instead of the draw class.

ScrollBar Return or set which scrollbars are displayed.

ScrollH A synonymous for ScrollHeight.

ScrollHeight Returns the contents height.

ScrollW A synonymous for ScrollWidth.

ScrollWidth Returns the contents width.

ScrollX Returns or sets the horizontal scrolling position.

ScrollY Returns or sets the vertical scrolling position.

Scrolling Return if the ScrollArea is scrolling (because of the smooth scrolling animation).

Shadow

Since 3.3

Return or set if all scrollarea controls display an inner shadow to indicate that scrolling is possible.

Shape

Since 3.21

Return or set the custom shape used for drawing the border.

Tablet

Since 3.3

Return or set if the ScrollArea will receive tablet events as mouse events.

Tracking Returns or sets if the control will receive MouseMove events.

UseMouse Return or set if the ScrollArea handles mouse wheel events.

View Return the internal DrawingArea used by the control.

Inherited properties

Action Returns or sets the action string associated with the control.

Arrangement Returns or sets how this container arrange its children controls.

AutoResize Indicates that the container automatically resizes to the size of its contents.

Centered

Since 3.16

Center controls horizontally or vertically according to the container arrangement.

Children Returns a collection of each control included in the container.

ClientX Returns the position of the left border of the area containing the controls.

ClientY Returns the position of the top border of the area containing the controls.

Cursor Use this property for assigning a custom cursor to a control.

Design Indicates that the control is in design mode.

Direction

Since 3.17

Return or set the control text direction.

Drop Returns or sets if a control accepts drops.

Enabled Indicates that the control is enabled.

Expand Returns or sets if a control will expand if included in a container that arranges its contents.

Font Returns or sets the font used to draw text in the control.

Foreground Returns or sets the foreground color used by the control.

H A synonymous for the Height property.

Handle Returns the internal X11 window handle of the control.

HasFocus Returns whether the control has the focus.

Height Returns or sets the height of the control.

Hovered Returns whether the mouse cursor is inside the control.

Id A synonymous for the Handle property.

Ignore Returns or sets if a control must be ignored when its parent arranges its children.

Indent Returns or sets if the children controls of the container are indented.

Invert Return or set if the horizontal or vertical arrangement direction is inverted.

Left Returns or sets the position of the left border of the control relative to its parent.

Margin Returns or sets if there is a margin between the container border and all its children.

Mouse Returns or sets the appearence of the cursor when it points inside the control.

Name Returns or sets the name of the control.

Next Returns the next control having the same parent.

NoTabFocus Return or set if a control cannot be focused with the TAB key.

Padding Returns or sets the number of pixels used as space between children controls, or container inner margin.

Parent Returns the control container.

PopupMenu Return or set the name of the menu that will be popped-up when the user presses the right mouse button or the keyboard MENU key.

Previous Returns the previous control having the same parent.

Proxy Return or set the "proxy" of a control.

ProxyFor Return which control that control is a proxy for.

RightToLeft Return if the control is right to left oriented.

ScreenX Returns the position of the left border of the control in screen coordinates.

ScreenY Returns the position of the top border of the control in screen coordinates.

Spacing Returns or sets if the children of the container are spaced out.

Tag Returns or sets the control tag.

Tooltip Returns or sets the tooltip shown when the mouse stays on the control for a short time.

Top Returns or sets the position of the top border of the control relative to its parent.

TopLevel

Since 3.21

Return the top-level window this control belongs to.

Visible Indicates if the control is visible or not.

W A synonymous for the Width property.

Width Returns or sets the width of the control.

Window Returns the window that contains the control.

X Returns or sets the position of the left border of the control relative to its parent.

Y Returns or sets the position of the top border of the control relative to its parent.

Methods

EnsureVisible Ensure that a specific area of the scrollarea is visible.

RefreshRect Refresh a specific rectangular part of the ScrollArea contents, defined by the

ResizeContents Define the size of the ScrollArea contents.

Scroll Scroll the ScrollArea contents to the given position.

Inherited methods

Delete Destroys the control.

Drag Starts a drag & drop process.

FindChild

Since 3.4

Finds the first child control pointed by the X and Y coordinates.

Grab Grab the keyboard and the mouse so that all keyboard and mouse events are received by the control.

Hide Hides the control.

Lower Sends the control to the background of its parent.

Move Moves and/or resizes the control.

MoveScaled Moves and/or resizes the control.

Raise Sends the control to the foreground of its parent.

Refresh Trigger a redraw of the control.

Reparent Changes the container of a control.

Resize Resizes the control.

ResizeScaled Resizes the control.

SetFocus Gives the focus to the control.

Show Shows the control.

Events

Change This event is raised when a global desktop configuration has changed.

Draw Raised when something must be redrawn.

Font This event is raised when the font of the ScrollArea has changed.

Resize Raised when the ScrollArea contents is resized.

Scroll Raised whent the scrollarea has scrolled.

Inherited events

Arrange This event is raised when a container has just finished arranging its contents.

BeforeArrange This event is raised just before a container arranges its contents.

DblClick Raised when the user quickly clicks twice on the control.

Drag This event is raised when the mouse enters the control during a drag & drop process.

DragLeave This event is raised when the mouse leaves the control during a drag & drop operation.

DragMove This event is raised while the mouse moves inside the control during a drag & drop process.

Drop This event is raised when a drag is dropped in the control.

Enter Raised when the mouse enters the control.

GotFocus Raised when the control has got the focus.

KeyPress Raised when a key is pressed while the control has the focus.

KeyRelease Raised when a key is released while the control has the focus.

Leave Raised when the mouse leaves the control.

LostFocus Raised when the control has lost the focus.

Menu Raised when the user clicks on the control with the right mouse button, or if it hits the MENU key.

MouseDown Raised when a mouse button is pressed while the cursor is inside the control.

MouseDrag This event is raised when a drag operation should be started.

MouseMove Raised when the mouse moves inside the control while a mouse button is pressed.

MouseUp Raised when a mouse button is depressed while the cursor is inside the control.

MouseWheel This event is raised when the user moves or presses the mouse wheel while the mouse is inside the control.

NewChild This event is raised when a new child Control has just been inserted into the container.