The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall
Difference between revisions of "UE3:UIScrollFrame (UDK)"
(Talk) |
m (1 revision: class descriptions for UDK January update (part 7)) |
(No difference)
|
Latest revision as of 06:51, 17 January 2010
Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UIScrollFrame |
Contents
- 1 Properties
- 2 Functions
- 2.1 Native functions
- 2.1.1 GetClientRegionPosition
- 2.1.2 GetClientRegionPositionVector
- 2.1.3 GetClientRegionSize
- 2.1.4 GetClientRegionSizeVector
- 2.1.5 GetClipRegion
- 2.1.6 GetVisibleRegionPercentage
- 2.1.7 ReapplyFormatting
- 2.1.8 RefreshScrollbars
- 2.1.9 ScrollRegion
- 2.1.10 SetClientRegionPosition
- 2.1.11 SetClientRegionPositionVector
- 2.2 Events
- 2.3 Other instance functions
- 2.1 Native functions
- Package:
- Engine
- Direct subclass:
- UTUIStatsList
- This class in other games:
- UT3
This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
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.
Properties[edit]
Property group 'Components'[edit]
StaticBackgroundImage[edit]
Type: UIComp_DrawImage
Modifiers: editinline, const
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.
Property group 'ZDebug'[edit]
HorizontalClientRegion[edit]
Type: UIRoot.UIScreenValue_Extent
Modifiers: editinline, editconst, private, transient
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[edit]
Type: UIRoot.UIScreenValue_Extent
Modifiers: editinline, editconst, private, transient
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.
Default value:
Member | Value |
---|---|
Orientation | UIORIENT_Vertical |
Internal variables[edit]
bRecalculateClientRegion[edit]
Type: bool
Modifiers: private, const, transient
indicates that the client region is out of date and needs to be recalculated
bRefreshScrollbars[edit]
Type: bool
Modifiers: private, const, transient
indicates when the scrollbars need to be updated
ClientRegionPosition[edit]
Type: Object.Vector2D
Modifiers: private, transient
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[edit]
Type: float
Array size: 4 (EUIWidgetFace.UIFACE_MAX
)
Modifiers: private, transient
caches the value of the frame's bounding region extent (includes any rotation)
ScrollbarHorizontal[edit]
Type: UIScrollbar
Modifiers: const, private
A scrollbar widget that allows the entire RegionExtent to be scrolled to for the horizontal dimension.
Default value: UIScrollbar'Engine.Default__UIScrollFrame:HorzScrollbarTemplate'
ScrollbarVertical[edit]
Type: UIScrollbar
Modifiers: const, private
A scrollbar widget that allows the entire RegionExtent to be scrolled to for the horizontal dimension.
Default value: UIScrollbar'Engine.Default__UIScrollFrame:VertScrollbarTemplate'
Default values[edit]
Property | Value | ||||||
---|---|---|---|---|---|---|---|
bSupportsPrimaryStyle | False | ||||||
DefaultStates[2] | Class'Engine.UIState_Focused' | ||||||
PrimaryStyle |
|
Subobjects[edit]
WidgetEventComponent[edit]
Class: Engine.UIComp_Event
Inherits from: UIContainer.WidgetEventComponent
No new values.
Functions[edit]
Native functions[edit]
GetClientRegionPosition[edit]
Gets the position of either the left or top side of the client region.
Parameters:
- Orientation - specify UIORIENT_Horizontal to retrieve the position of the left side; specify UIORIENT_Vertical to retrieve the position of the top side.
Returns:
- the position of the client region, in canvas coordinates relative to the top left corner of this widget.
GetClientRegionPositionVector[edit]
Gets the position of the upper-left corner of the client region.
Returns:
- the position of the client region, in canvas coordinates relative to the top left corner of this widget.
GetClientRegionSize[edit]
Returns the size of a single orientation of the client region, in pixels.
Parameters:
- Orientation - specify UIORIENT_Horizontal to retrieve the width of the client region or UIORIENT_Vertical to get the height of the client region.
Returns:
- the width or height of the client region, in pixels.
GetClientRegionSizeVector[edit]
Returns the size of the client region, in pixels.
Returns:
- the size of the client region, in pixels.
GetClipRegion[edit]
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[edit]
Returns the percentage of the client region that is visible within the scrollframe's bounds.
Parameters:
- Orientation - specifies whether to return the vertical or horizontal percentage.
Returns:
- a value from 0.0 to 1.0 representing the percentage of the client region that can be visible at once.
ReapplyFormatting[edit]
Sets the flag indicating that the client region needs to be recalculated. Does not necessarily trigger a scene update.
Parameters:
- bImmediately - specify TRUE to immediately recalculate the client region instead of batching up and waiting until the next scene update.
RefreshScrollbars[edit]
Sets the flag indicating that the scrollbars need to be re-resolved. Does not necessarily trigger a scene update.
Parameters:
- bImmediately - specify TRUE to resolve the scrollbars immediately instead of batching until the next scene update.
ScrollRegion[edit]
Scrolls all of the child widgets by the specified amount in the specified direction.
Parameters:
- Sender - the scrollbar that generated the event.
- PositionChange - indicates the amount that the scrollbar has travelled.
- bPositionMaxed - indicates that the scrollbar's marker has reached its farthest available position, used to achieve pixel exact scrolling
SetClientRegionPosition[edit]
Changes the position of the client region and synchronizes the scrollbars to the new position.
Parameters:
- Orientation - specify UIORIENT_Horizontal to set the position of the left side; specify UIORIENT_Vertical to set the position of the top side.
- NewPosition - the position to move the client region to, in pixels.
Returns:
- TRUE if the client region was moved successfully.
SetClientRegionPositionVector[edit]
Changes the position of the client region and synchronizes the scrollbars to the new position.
Parameters:
- NewPosition - the position to move the client region to, in pixels.
Returns:
- TRUE if the client region was moved successfully.
Events[edit]
AddedChild[edit]
Overrides: UIScreenObject.AddedChild
Called immediately after a child has been added to this screen object. Sets up NotifyPositionChanged delegate in the added child
Parameters:
- WidgetOwner - the screen object that the NewChild was added as a child for
- NewChild - the widget that was added
RemovedChild[edit]
Overrides: UIScreenObject.RemovedChild
Called immediately after a child has been removed from this screen object. Clears the NotifyPositionChanged delegate in the removed child
Parameters:
- WidgetOwner - the screen object that the widget was removed from.
- OldChild - the widget that was removed
- 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.
ScrollZoneClicked[edit]
Handler for the scrollbars' OnClickedScrollZone delegate. Scrolls the client region by a full page.
Parameters:
- Sender - the scrollbar that was clicked.
- 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.
- PlayerIndex - index of the player that generated the scrollzone click.
Other instance functions[edit]
OnChildRepositioned[edit]
Handler for NotifyPositionChanged delegate for children of this panel. Sets the flag indicating that the panel should recalculate the client region.
Parameters:
- Sender - Child widget which has been repositioned