Class TCastleScrollViewManual

Unit

Declaration

type TCastleScrollViewManual = class(TCastleScrollViewCustom)

Description

Control with a scrollbar. This user interface control shows a vertical scrollbar on the right side, and allows to operate on it using keyboard, mouse, touch.

The scrollbar automatically doesn't affect anything (hence the name of this class contains the word "manual"). You need to assign OnChange event to react to the scrollbar dragging to actually do something. Usually you also want to adjust PageSize and CompleteSize.

If you want to easily scroll a tall user interface contents, it is easier to use TCastleScrollView than this control.

Hierarchy

Overview

Fields

Public nested const DefaultPageSize = 1;
Public nested const DefaultCompleteSize = 10;

Methods

Protected function GetPageSize: Single; override;
Protected function GetCompleteSize: Single; override;
Protected procedure DoScrollChange; override;
Protected function GetScroll: Single; override;
Protected procedure SetScroll(Value: Single); override;
Protected function GetScrollStored: Boolean; override;
Public constructor Create(AOwner: TComponent); override;

Properties

Published property OnChange: TNotifyEvent read FOnChange write FOnChange;
Published property PageSize: Single read GetPageSize write SetPageSize default DefaultPageSize;
Published property CompleteSize: Single read GetCompleteSize write SetCompleteSize default DefaultCompleteSize;

Description

Fields

Public nested const DefaultPageSize = 1;

This item has no description.

Public nested const DefaultCompleteSize = 10;

This item has no 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.

Protected function GetScroll: Single; override;

This item has no description.

Protected procedure SetScroll(Value: Single); override;

This item has no description.

Protected function GetScrollStored: Boolean; override;

This item has no description.

Public constructor Create(AOwner: TComponent); override;

This item has no description.

Properties

Published property OnChange: TNotifyEvent read FOnChange write FOnChange;

Event sent when Scroll value was changed, in any way.

Published property PageSize: Single read GetPageSize write SetPageSize default DefaultPageSize;

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.

Published property CompleteSize: Single read GetCompleteSize write SetCompleteSize default DefaultCompleteSize;

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


Generated by PasDoc 0.16.0-snapshot.