Engine.UIScrollFrame

Extends

UIContainer

Modifiers

placeable native ( UIPrivate )

This widget defines a region in which its child widgets can be placed. If any of its children lay outside of its defined region then a scroll bar will be made visible to allow the region to be scrolled to the outside widgets. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIContainer
            |   
            +-- Engine.UIScrollFrame

Direct Known Subclasses:

UTUIStatsList

Functions Summary
		AddedChild (UIScreenObject WidgetOwner, UIObject NewChild ))
	float	GetClientRegionPosition (EUIOrientation Orientation ) con)
	vector2D	GetClientRegionPositionVector () con)
	float	GetClientRegionSize (EUIOrientation Orientation ) con)
	vector2D	GetClientRegionSizeVector () con)
		GetClipRegion (out float MinX, out float MinY, out float MaxX, out float MaxY ) con)
	float	GetVisibleRegionPercentage (EUIOrientation Orientation ) con)
		OnApplyScrolling (UIAction_ApplyScrolling Action ))
		OnChildRepositioned (UIScreenObject Sender ))
		ReapplyFormatting (optional bool bImmediately)
		RefreshScrollbars (optional bool bImmediately)
		RemovedChild (UIScreenObject WidgetOwner, UIObject OldChild, optional array ExclusionSet ))
	bool	ScrollRegion (UIScrollbar Sender, float PositionChange, optional bool bPositionMaxed)
		ScrollZoneClicked (UIScrollbar Sender, float PositionPerc, int PlayerIndex ))
	bool	SetClientRegionPosition (EUIOrientation Orientation, float NewPosition)
	bool	SetClientRegionPositionVector (Vector2D NewPosition)

bRecalculateClientRegion Source code

indicates that the client region is out of date and needs to be recalculated

bRefreshScrollbars Source code

indicates when the scrollbars need to be updated

ClientRegionPosition Source code

Represents the position of the client region with respect to this scrollframe. Values are from 0.0 - 1.0, where 0,0 means that the top-left of the client region is at the top-left corner of this widget, and a value of 1,1 means that the bottom-right of the client region is at the top-left corner of this widget.

FrameBounds[EUIWidgetFace.UIFACE_MAX] Source code

caches the value of the frame's bounding region extent (includes any rotation)

ScrollbarHorizontal Source code

A scrollbar widget that allows the entire RegionExtent to be scrolled to for the horizontal dimension.

ScrollbarVertical Source code

A scrollbar widget that allows the entire RegionExtent to be scrolled to for the horizontal dimension.

Image

StaticBackgroundImage Source code

Component for rendering the background image. If given a value, this image will not move when the user scrolls, whereas the background image for the client panel will.

UIScrollFrame

HorizontalClientRegion Source code

The horizontal extent of the region which contains this widget's children. If this region is greater than the horizontal extent of this scrollframe, the horizontal scrollbar will be made visible.

VerticalClientRegion Source code

The vertical extent of the region which contains this widget's children. If this region is greater than the vertical extent of this scrollframe, the vertical scrollbar will be made visible.

AddedChild Source code

Called immediately after a child has been added to this screen object. Sets up NotifyPositionChanged delegate in the added child
@param WidgetOwner the screen object that the NewChild was added as a child for
@param NewChild the widget that was added

GetClientRegionPosition Source code

Gets the position of either the left or top side of the client region.
@param Orientation specify UIORIENT_Horizontal to retrieve the position of the left side; specify UIORIENT_Vertical to retrieve the position of the top side.
@return the position of the client region, in canvas coordinates relative to the top left corner of this widget.

GetClientRegionPositionVector Source code

Gets the position of the upper-left corner of the client region.
@return the position of the client region, in canvas coordinates relative to the top left corner of this widget.

GetClientRegionSize Source code

Returns the size of a single orientation of the client region, in pixels.
@param Orientation specify UIORIENT_Horizontal to retrieve the width of the client region or UIORIENT_Vertical to get the height of the client region.
@return the width or height of the client region, in pixels.

GetClientRegionSizeVector Source code

Returns the size of the client region, in pixels.
@return the size of the client region, in pixels.

GetClipRegion Source code

Returns a vector containing the size of the region (in pixels) available for rendering inside this scrollframe, taking account whether the scrollbars are visible.

GetVisibleRegionPercentage Source code

Returns the percentage of the client region that is visible within the scrollframe's bounds.
@param Orientation specifies whether to return the vertical or horizontal percentage.
@return a value from 0.0 to 1.0 representing the percentage of the client region that can be visible at once.

OnApplyScrolling Source code

Handler for the ApplyScrolling action.

OnChildRepositioned Source code

Handler for NotifyPositionChanged delegate for children of this panel. Sets the flag indicating that the panel should recalculate the client region.
@param Sender Child widget which has been repositioned

ReapplyFormatting Source code

Sets the flag indicating that the client region needs to be recalculated. Does not necessarily trigger a scene update.
@param bImmediately specify TRUE to immediately recalculate the client region instead of batching up and waiting until the next scene update.

RefreshScrollbars Source code

Sets the flag indicating that the scrollbars need to be re-resolved. Does not necessarily trigger a scene update.
@param bImmediately specify TRUE to resolve the scrollbars immediately instead of batching until the next scene update.

RemovedChild Source code

Called immediately after a child has been removed from this screen object. Clears the NotifyPositionChanged delegate in the removed child
@param WidgetOwner the screen object that the widget was removed from.
@param OldChild the widget that was removed
@param ExclusionSet used to indicate that multiple widgets are being removed in one batch; useful for preventing references between the widgets being removed from being severed. NOTE: If a value is specified, OldChild will ALWAYS be part of the ExclusionSet, since it is being removed.

ScrollRegion Source code

Scrolls all of the child widgets by the specified amount in the specified direction.
@param Sender the scrollbar that generated the event.
@param PositionChange indicates the amount that the scrollbar has travelled.
@param bPositionMaxed indicates that the scrollbar's marker has reached its farthest available position, used to achieve pixel exact scrolling

ScrollZoneClicked Source code

Handler for the scrollbars' OnClickedScrollZone delegate. Scrolls the client region by a full page.
@param Sender the scrollbar that was clicked.
@param PositionPerc a value from 0.0 - 1.0, representing the location of the click within the region between the increment and decrement buttons. Values closer to 0.0 means that the user clicked near the decrement button; values closer to 1.0 are nearer the increment button.
@param PlayerIndex index of the player that generated the scrollzone click.

SetClientRegionPosition Source code

Changes the position of the client region and synchronizes the scrollbars to the new position.
@param Orientation specify UIORIENT_Horizontal to set the position of the left side; specify UIORIENT_Vertical to set the position of the top side.
@param NewPosition the position to move the client region to, in pixels.
@return TRUE if the client region was moved successfully.

SetClientRegionPositionVector Source code

Changes the position of the client region and synchronizes the scrollbars to the new position.
@param NewPosition the position to move the client region to, in pixels.
@return TRUE if the client region was moved successfully.

defaultproperties
{
   ScrollbarHorizontal=UIScrollbar'Engine.Default__UIScrollFrame:HorzScrollbarTemplate'
   ScrollbarVertical=UIScrollbar'Engine.Default__UIScrollFrame:VertScrollbarTemplate'
   VerticalClientRegion=(Orientation=UIORIENT_Vertical)
   PrimaryStyle=(DefaultStyleTag="DefaultImageStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   bSupportsPrimaryStyle=False
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIContainer:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIContainer:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UIScrollFrame"
   ObjectArchetype=UIContainer'Engine.Default__UIContainer'
}