Class TCastleScrollView

Unit

Declaration

type TCastleScrollView = class(TCastleScrollViewCustom)

Description

Container for a user interface children that can be scrolled vertically. Add the children (that should be scrolled) to the ScrollArea. We automatically show a scrollbar, and handle various scrolling inputs to be functional on both desktops and mobile (we handle scrolling by keys, mouse wheel, dragging by scrollbar, dragging the whole area - see EnableDragging).

Hierarchy

Overview

Methods

Protected function GetPageSize: Single; override;
Protected function GetCompleteSize: Single; override;
Protected procedure DoScrollChange; override;
Public constructor Create(AOwner: TComponent); override;

Properties

Published property ClipChildren default true;
Published property ScrollArea: TInternalCastleScrollArea read FScrollArea;

Description

Methods

Protected function GetPageSize: Single; override;

This item has no description. Showing description inherited from TCastleScrollViewCustom.GetPageSize.

How much Scroll is represented by the height of the scrollbar slider. Among other things, this determines how much Scroll changes in response to Page Up and Page Down keys.

Protected function GetCompleteSize: Single; override;

This item has no description. Showing description inherited from TCastleScrollViewCustom.GetCompleteSize.

How much Scroll is represented by the height of the entire scrollbar (that is, the height of this TCastleScrollViewCustom instance).

Protected procedure DoScrollChange; override;

This item has no description.

Public constructor Create(AOwner: TComponent); override;

This item has no description.

Properties

Published property ClipChildren default true;

Scroll view rendering makes sense only when ClipChildren is True.

Published property ScrollArea: TInternalCastleScrollArea read FScrollArea;

Children you add here will be scrolled. To have a useful scrolling area:

  • Add some children to ScrollArea,

  • Set proper size of the ScrollArea (you can set an explicit size, or use TCastleUserInterface.AutoSizeToChildren),

  • Leave the ScrollArea anchors as default: ScrollArea should be anchored to the top-left corner of the parent.


Generated by PasDoc 0.16.0.