Engine.UIScrollbar

Extends

UIObject

Modifiers

native ( UIPrivate ) hidecategories ( Object , UIScreenObject , UIObject , Focus , Presentation , Splitscreen , States ) notplaceable

This component when integrated into a widget allows for scrolling the contents of the widget, i.e. UIList. UIScrollbar has built-in functionality to autoposition itself within the owner widget depending on its orientation Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- Engine.UIScrollbar

Delegates Summary
		OnClickedScrollZone (UIScrollbar Sender, float PositionPerc, int PlayerIndex)
	bool	OnScrollActivity (UIScrollbar Sender, float PositionChange, optional bool bPositionMaxed=false)

Functions Summary
		DragScroll (UIScrollbarMarkerButton Sender, int PlayerIndex)
		DragScrollBegin (UIScreenObject Sender, int PlayerIndex)
		DragScrollEnd (UIScreenObject Sender, int PlayerIndex)
		EnableCornerPadding (bool FlagValue)
	float	GetMarkerButtonPosition () con)
	float	GetMarkerPosPercent ()))
	float	GetMarkerSizePercent ()))
	float	GetNudgePercent ()))
	float	GetNudgeValue ()))
	float	GetScrollZoneExtent (optional out float ScrollZoneStart ) con)
	float	GetScrollZoneWidth () con)
		Initialized ()))
		PostInitialize ()))
		ScrollDecrement (UIScreenObject Sender, int PlayerIndex)
		ScrollIncrement (UIScreenObject Sender, int PlayerIndex)
		SetMarkerPosition (float PositionPercentage)
		SetMarkerSize (float SizePercentage)
		SetNudgeSizePercent (float NudgePercentage)
		SetNudgeSizePixels (float NudgePixels)

bInitializeMarker Source code

A private flag indicating that the marker needs to be repositioned and resized to the bounds of the uiscrollbar

DecrementButton Source code

DecrementStyle Source code

IncrementButton Source code

Buttons that can be used to increment and decrement the marker of the scrollbar.

IncrementStyle Source code

The styles used for the increment, decrement and marker buttons

MarkerButton Source code

The marker which can be manipulated to change the value of the scrollbar

MarkerPosPercent Source code

MarkerSizePercent Source code

MarkerStyle Source code

MousePosition Source code

The current position of the mouse cursor, used in dragging handling

MousePositionDelta Source code

The accumulated mouse position delta during dragging. The change in mouse position is accumulated until it is greater than the nudge value, at which point it will then call the OnScrollActivity delegate to move the content.

NudgePercent Source code

Values which store current state of the scrollbar's marker

NudgeValue Source code

The nudge value indicates how much marker movement will cause one position update "tick", value is stored in pixels. It can be set to 1 as is the case with the UIScrollframe, or it can be evaluated based on some percentage of the total available size as is the case with the UIList

Image

BackgroundImageComponent Source code

Component for rendering the background image

UIScrollbar

bAddCornerPadding Source code

Specifies wheather to leave extra space between the bottom/right corner of the scrollbar and its owner widget. Extra space prevents ovelapping if both horizontal and vertical scrollbars exist within one widget

BarWidth Source code

Determines scrollbar's thickness

ButtonsExtent Source code

Determines the length of the Increment/Decrement buttons

MinimumMarkerSize Source code

Specifies the minimum size for the scrollbar marker. Useful to prevent the marker from becoming too small if there are lots of items in the list.

NudgeMultiplier Source code

The NudgeMultiplier value indicates by how many NudgeValues will the marker move when the increment or decrement button is pressed, NudgeValue is multiplied by NudgeMultiplier to obtain final pixel amount

ScrollbarOrientation Source code

Controls whether this scrollbar is vertical or horizontal

OnClickedScrollZone Source code

Called when the user clicks anywhere in the scrollbar other than on one of the buttons.
@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 Player that performed the action that issued the event.

OnScrollActivity Source code

Delegate invoked on scrolling activity
@param Sender the scrollbar that generated the event.
@param PositionChange the number of nudge values by which the marker was moved
@param bPositionMaxed indicates that the scrollbar's marker has reached its farthest available position, used to obtain pixel exact scrolling
@return currently unused.

DragScroll Source code

Called during the dragging process
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

DragScrollBegin Source code

Initiates mouse drag scrolling. The scroll bar marker will slide on its axis with the mouse cursor until DragScrollEnd is called.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

DragScrollEnd Source code

Terminates mouse drag scrolling.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.
@return return TRUE to prevent the kismet OnClick event from firing.

EnableCornerPadding Source code

Sets the value of the bAddCornerPadding flag

GetMarkerButtonPosition Source code

Returns the position of this scrollbar's top face (if orientation is vertical) or left face (for horizontal), in pixels.

GetMarkerPosPercent Source code

GetMarkerSizePercent Source code

GetNudgePercent Source code

GetNudgeValue Source code

Simple accessors

GetScrollZoneExtent Source code

Returns the size of the scroll-zone (the region between the decrement and increment buttons), along the same orientation as the scrollbar.
@param ScrollZoneStart receives the value of the location of the beginning of the scroll zone, in pixels relative to the scrollbar.
@return the height (if the scrollbar's orientation is vertical) or width (if horizontal) of the region between the increment and decrement buttons, in pixels.
@note: noexport so that the native implementation can declare the optional out as a * will default value of NULL.

GetScrollZoneWidth Source code

Returns the size of the scroll-zone (the region between the decrement and increment buttons), for the orientation opposite that of the scrollbar.
@return the height (if the scrollbar's orientation is vertical) or width (if horizontal) of the region between the increment and decrement buttons, in pixels.

Initialized Source code

Initializes the clicked delegates in the increment, decrement and marker buttons.

PostInitialize Source code

Propagate the enabled state of this widget.

ScrollDecrement Source code

Decrements marker position by the amount of nudges specified in the NudgeMultiplier. Decrement direction is either up or left, depending on marker's orientation
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

ScrollIncrement Source code

Increments marker position by the amount of nudges specified in the NudgeMultiplier. Increment direction is either down or right, depending on scrollbar's orientation.
@param EventObject Object that issued the event.
@param PlayerIndex Player that performed the action that issued the event.

SetMarkerPosition Source code

Sets marker's top or left face position to start at some percentage of total scrollbar extent
@param PositionPercentage determines where the marker should start, value needs to be in the range [ 0 , 1 ] and should correspond to the position of the topmost or leftmost item in the viewing area

SetMarkerSize Source code

Sets marker's extent to a percentage of scrollbar size, the direction will be vertical or horizontal depending scrollbar's orientation
@param SizePercentage determines the size of the marker, value needs to be in the range [ 0 , 1 ] and should be equal to the ratio of viewing area to total widget scroll area

SetNudgeSizePercent Source code

Sets the amount by which the marker will move to cause one position tick
@param NudgePercentage percentage of total scrollbar area which will amount to one tick value needs to be in the range [ 0 , 1 ]

SetNudgeSizePixels Source code

Sets the amount by which the marker will move to cause one position tick
@param NudgePixels Number of pixels by which the marker will need to be moved to cause one tick

defaultproperties
{
   Begin Object Class=UIComp_DrawImage Name=ScrollBarBackgroundImageTemplate ObjName=ScrollBarBackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
      StyleResolverTag="Background Image Style"
      ImageStyle=(DefaultStyleTag="DefaultScrollZoneStyle")
      Name="ScrollBarBackgroundImageTemplate"
      ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage'
   End Object
   BackgroundImageComponent=ScrollBarBackgroundImageTemplate
   IncrementStyle=(DefaultStyleTag="DefaultIncrementButtonStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   DecrementStyle=(DefaultStyleTag="DefaultDecrementButtonStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   MarkerStyle=(DefaultStyleTag="DefaultScrollBarStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   NudgeMultiplier=1.000000
   BarWidth=(Value=16.000000)
   MinimumMarkerSize=(Value=12.000000,Orientation=UIORIENT_Vertical)
   ButtonsExtent=(Value=16.000000,Orientation=UIORIENT_Vertical)
   ScrollbarOrientation=UIORIENT_Vertical
   bAddCornerPadding=True
   PrimaryStyle=(DefaultStyleTag="DefaultScrollZoneStyle",RequiredStyleClass=Class'Engine.UIStyle_Image')
   PrivateFlags=1044
   bSupportsPrimaryStyle=False
   DefaultStates(2)=Class'Engine.UIState_Focused'
   DefaultStates(3)=Class'Engine.UIState_Pressed'
   DefaultStates(4)=Class'Engine.UIState_Active'
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIObject:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'Engine.Default__UIObject:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UIScrollbar"
   ObjectArchetype=UIObject'Engine.Default__UIObject'
}