PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView Class Reference

A GUI control that implements GUI.ScrollView. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView:
Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView:

Public Member Functions

void ResetScrollPosition ()
 Resets the scroll position. More...
 
override void DrawChildren (Vector2 relativeMousePosition)
 Draws the children, taking into account key/controller navigation if enabled. More...
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
virtual void Awake ()
 
virtual void OnEnable ()
 Checks if the control needs to enable the first child for key/controller navigation. More...
 
void Draw (Vector2 relativeMousePosition)
 Draw the control and its children. More...
 
virtual void DrawSelf (Vector2 relativeMousePosition)
 Draws the control, but not its children. More...
 
virtual void Update ()
 If navigation is enabled, check if the selection button was pressed. More...
 
virtual void Refresh (Vector2 windowSize)
 Marks a control as needing to update its layout. More...
 
virtual void Refresh ()
 
virtual void UpdateLayout ()
 Updates the layout (size, position, formatting, etc.) of the control and its children. More...
 
virtual void UpdateLayoutSelf ()
 Updates the control's layout but not its children. More...
 
virtual void AutoSizeSelf ()
 Auto-sizes the control according to the autoSize settings. More...
 

Public Attributes

bool showVerticalScrollbar = true
 Show or hide the vertical scrollbar. More...
 
bool showHorizontalScrollbar = false
 Show or hide the horizontal scrollbar. More...
 
int padding = 2
 The pixel padding inside the scroll view. More...
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
int depth = 0
 The drawing order depth. More...
 
bool depthSortChildren = false
 If true, children are drawn in depth order; otherwise no specific order. More...
 
ScaledRect scaledRect = new ScaledRect(ScaledRect.wholeScreen)
 The scaled rect defining the position of the control. More...
 
AutoSize autoSize
 Auto-size settings. More...
 
Fit fit
 Fit settings. More...
 
Navigation navigation
 Keyboard/controller navigation settings. More...
 
bool visible = true
 If true, this control and its children are visible. More...
 
bool clipChildren = true
 Clip children to the control's bounds? More...
 

Properties

float contentWidth [get, set]
 The width of the content as reported by the MeasureContentHandler. More...
 
float contentHeight [get, set]
 The height of the content as reported by the MeasureContentHandler. More...
 
- Properties inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
Rect rect [get, set]
 The pixel rect represented by scaledRect. More...
 
Vector2 Offset [get, set]
 Gets or sets the offset to apply to the screen rect for this control; useful for manual repositioning outside the normal GUI control system. More...
 
List< GUIControlChildren [get]
 The child controls. More...
 
bool NeedToUpdateLayout [get, set]
 When true, the control needs to update its style, size, position, etc. More...
 
Vector2 WindowSize [get, set]
 The size of the window most recently passed to Refresh(). More...
 
bool IsNavigationEnabled [get]
 Gets a value indicating whether keyboard/controller navigation is enabled. More...
 
string FullName [get]
 Gets the full name of the GameObject, used to focus the control when using keyboard/controller navigation. More...
 
Vector2 dRect [get, set]
 Gets or sets dRect, which offsets the rect when the parent window isn't clipping. More...
 

Events

Action MeasureContentHandler = null
 The handler(s) to call when the scroll view needs to measure its children. More...
 
Action DrawContentHandler = null
 The handler(s) to call when the scroll view needs to draw its children. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
virtual void FitSelf ()
 Fits the control according to the fit settings. More...
 

Detailed Description

A GUI control that implements GUI.ScrollView.

This control measures the size of the children contained in the scroll view and resizes the content area accordingly.

Member Function Documentation

◆ DrawChildren()

override void PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView.DrawChildren ( Vector2  relativeMousePosition)
virtual

Draws the children, taking into account key/controller navigation if enabled.

Parameters
relativeMousePositionRelative mouse position.

Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIControl.

◆ ResetScrollPosition()

void PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView.ResetScrollPosition ( )

Resets the scroll position.

Member Data Documentation

◆ padding

int PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView.padding = 2

The pixel padding inside the scroll view.

◆ showHorizontalScrollbar

bool PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView.showHorizontalScrollbar = false

Show or hide the horizontal scrollbar.

◆ showVerticalScrollbar

bool PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView.showVerticalScrollbar = true

Show or hide the vertical scrollbar.

Property Documentation

◆ contentHeight

float PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView.contentHeight
getset

The height of the content as reported by the MeasureContentHandler.

The height of the content.

◆ contentWidth

float PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView.contentWidth
getset

The width of the content as reported by the MeasureContentHandler.

The width of the content.

Event Documentation

◆ DrawContentHandler

Action PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView.DrawContentHandler = null

The handler(s) to call when the scroll view needs to draw its children.

◆ MeasureContentHandler

Action PixelCrushers.DialogueSystem.UnityGUI.GUIScrollView.MeasureContentHandler = null

The handler(s) to call when the scroll view needs to measure its children.


The documentation for this class was generated from the following file: