Package SiliconStudio.Paradox.UI

Namespaces
package	Controls
package	Data
package	Events
package	Panels
package	Renderers

Classes
interface	IScrollAnchorInfo
	Interface providing anchor information to its ScrollViewer. More...
interface	IScrollInfo
	Represents the main scrollable region inside a ScrollViewer control. More...
interface	IUIElementUpdate
	Interface for the update of the UIElements. More...
class	KeyEventArgs
	The arguments associated to an key event.
class	NamespaceDoc
	The SiliconStudio.Paradox.UI namespace contains types to manage the UI. More...
class	PropertyChangedArgs< T >
	An argument class containing information about a property that changed. More...
class	StripDefinition
	Represent the definition of a grid strip. More...
class	StripDefinitionCollection
	A collection of strip definitions More...
class	TextureExtensions
	Extension methods for Texture
struct	Thickness
	Describes the thickness of a frame around a cuboid. Six float values describe the Left, Top, Right, Bottom, Front, and Back sides of the cuboid, respectively. More...
class	TouchEventArgs
	Provides data for touch input events. More...
class	UIElement
	Provides a base class for all the User Interface elements in Paradox applications. More...
class	UIElementCollection
	A collection of UIElements. More...
class	UIElementExtensions
	Extensions methods for UIElement More...
class	UIImage
	Class holding all the data required to define an UI image. More...
class	UIImageGroup
	Represent of group of UIImage More...
class	UIInternalException
	The exception that is thrown when an internal error happened in the UI System. That is an error that is not due to the user behavior. More...
class	UIProfilerKeys
	Various ProfilingKey used to measure performance across some part of the UI system. More...
class	UISystem
	Interface of the UI system. More...

Enumerations
enum	ClickMode { ClickMode.Press, ClickMode.Release }
	Specifies when the Click event should be raised. More...
enum	DepthAlignment { DepthAlignment.Front, DepthAlignment.Center, DepthAlignment.Back, DepthAlignment.Stretch }
	Describes how a child element is positioned in depth or stretched within a parent's layout slot. More...
enum	HorizontalAlignment { HorizontalAlignment.Left, HorizontalAlignment.Center, HorizontalAlignment.Right, HorizontalAlignment.Stretch }
	Indicates where an element should be displayed on the horizontal axis relative to the allocated layout slot of the parent element. More...
enum	MouseOverState { MouseOverState.MouseOverNone, MouseOverState.MouseOverChild, MouseOverState.MouseOverElement }
	Describe the possible states of the mouse over an UI element. More...
enum	Orientation { Orientation.Horizontal, Orientation.Vertical, Orientation.InDepth }
	Defines the different orientations that a control or layout can have. More...
enum	ScrollingMode {   ScrollingMode.None, ScrollingMode.Horizontal, ScrollingMode.Vertical, ScrollingMode.InDepth,   ScrollingMode.HorizontalVertical, ScrollingMode.VerticalInDepth, ScrollingMode.InDepthHorizontal }
	The different ways of scrolling in a ScrollViewer. More...
enum	StretchDirection { StretchDirection.Both, StretchDirection.DownOnly, StretchDirection.UpOnly }
	Describes how scaling applies to content and restricts scaling to named axis types. More...
enum	StretchType {   StretchType.None, StretchType.Uniform, StretchType.UniformToFill, StretchType.FillOnStretch,   StretchType.Fill }
	Describes how content is resized to fill its allocated space. More...
enum	StripType { StripType.Fixed, StripType.Auto, StripType.Star }
	The different types of strip possible of a grid. More...
enum	ToggleState { ToggleState.Checked, ToggleState.Indeterminate, ToggleState.UnChecked }
	Describe the different possible states of an ToggleButton. More...
enum	TouchAction { TouchAction.Down, TouchAction.Move, TouchAction.Up }
	Describes the action of a specific touch point. More...
enum	VerticalAlignment { VerticalAlignment.Bottom, VerticalAlignment.Center, VerticalAlignment.Top, VerticalAlignment.Stretch }
	Describes how a child element is vertically positioned or stretched within a parent's layout slot. More...
enum	Visibility { Visibility.Visible, Visibility.Hidden, Visibility.Collapsed }
	Specifies the display state of an element. More...

Functions
delegate void	PropertyChangedHandler< T > (Object sender, PropertyChangedArgs< T > e)

Enumeration Type Documentation

enum SiliconStudio.Paradox.UI.ClickMode

Specifies when the Click event should be raised.

Enumerator
Press	Specifies that the Click event should be raised as soon as a button is pressed.
Release	Specifies that the Click event should be raised when a button is pressed and released.

Definition at line 8 of file ClickMode.cs.

enum SiliconStudio.Paradox.UI.DepthAlignment

Describes how a child element is positioned in depth or stretched within a parent's layout slot.

Enumerator
Front	The child element is aligned to the front of the parent's layout slot.
Center	The child element is aligned to the center of the parent's layout slot.
Back	The child element is aligned to the back of the parent's layout slot.
Stretch	The child element stretches to fill the parent's layout slot.

Definition at line 8 of file DepthAlignment.cs.

enum SiliconStudio.Paradox.UI.HorizontalAlignment

Indicates where an element should be displayed on the horizontal axis relative to the allocated layout slot of the parent element.

Enumerator
Left	An element aligned to the left of the layout slot for the parent element.
Center	An element aligned to the center of the layout slot for the parent element.
Right	An element aligned to the right of the layout slot for the parent element.
Stretch	An element stretched to fill the entire layout slot of the parent element.

Definition at line 8 of file HorizontalAlignment.cs.

enum SiliconStudio.Paradox.UI.MouseOverState

Describe the possible states of the mouse over an UI element.

Enumerator
MouseOverNone	The mouse is neither over the element nor one of its children.
MouseOverChild	The mouse is over one of children of the element.
MouseOverElement	The mouse is directly over the element.

Definition at line 8 of file MouseOverState.cs.

enum SiliconStudio.Paradox.UI.Orientation

Defines the different orientations that a control or layout can have.

Enumerator
Horizontal	Control or layout should be horizontally oriented.
Vertical	Control or layout should be vertically oriented.
InDepth	Control or layout should be oriented along the depth axis.

Definition at line 8 of file Orientation.cs.

enum SiliconStudio.Paradox.UI.ScrollingMode

The different ways of scrolling in a ScrollViewer.

Enumerator
None	No scrolling is allowed.
Horizontal	Only horizontal scrolling is allowed.
Vertical	Only vertical scrolling is allowed.
InDepth	Only in depth (back/front) scrolling is allowed.
HorizontalVertical	Both horizontal and vertical scrolling are allowed.
VerticalInDepth	Both vertical and in-depth scrolling are allowed.
InDepthHorizontal	Both in-depth and horizontal scrolling are allowed.

Definition at line 10 of file ScrollingMode.cs.

enum SiliconStudio.Paradox.UI.StretchDirection

Describes how scaling applies to content and restricts scaling to named axis types.

Enumerator
Both	The content stretches to fit the parent according to the Stretch mode.
DownOnly	The content scales downward only when it is larger than the parent. If the content is smaller, no scaling upward is performed.
UpOnly	The content scales upward only when it is smaller than the parent. If the content is larger, no scaling downward is performed.

Definition at line 8 of file StretchDirection.cs.

enum SiliconStudio.Paradox.UI.StretchType

Describes how content is resized to fill its allocated space.

Enumerator
None	The content preserves its original size.
Uniform	The content is resized to fit in the destination dimensions while it preserves its native aspect ratio.
UniformToFill	The content is resized to fill the destination dimensions while it preserves its native aspect ratio. If the aspect ratio of the destination rectangle differs from the source, the source content is clipped to fit in the destination dimensions.
FillOnStretch	The content is resized to fill the destination when stretched by its parent. It keeps its ratio otherwise.
Fill	The content is always resized to fill the destination dimensions. The aspect ratio is not preserved.

Definition at line 8 of file StretchType.cs.

enum SiliconStudio.Paradox.UI.StripType

The different types of strip possible of a grid.

Enumerator
Fixed	A strip having fixed size expressed in number of virtual pixels.
Auto	A strip that occupies exactly the size required by its content.
Star	A strip that occupies the maximum available size, dispatched among the other stared-size columns.

Definition at line 8 of file StripType.cs.

enum SiliconStudio.Paradox.UI.ToggleState

Describe the different possible states of an ToggleButton.

Enumerator
Checked	The toggle button is checked.
Indeterminate	The state of the toggle button is undetermined
UnChecked	The toggle button is unchecked.

Definition at line 10 of file ToggleState.cs.

enum SiliconStudio.Paradox.UI.TouchAction

Describes the action of a specific touch point.

Enumerator
Down	The act of putting a finger onto the screen.
Move	The act of dragging a finger across the screen.
Up	The act of lifting a finger off of the screen.

Definition at line 8 of file TouchAction.cs.

enum SiliconStudio.Paradox.UI.VerticalAlignment

Describes how a child element is vertically positioned or stretched within a parent's layout slot.

Enumerator
Bottom	The child element is aligned to the bottom of the parent's layout slot.
Center	The child element is aligned to the center of the parent's layout slot.
Top	The child element is aligned to the top of the parent's layout slot.
Stretch	The child element stretches to fill the parent's layout slot.

Definition at line 8 of file VerticalAlignment.cs.

enum SiliconStudio.Paradox.UI.Visibility

Specifies the display state of an element.

Enumerator
Visible	Display the element.
Hidden	Do not display the element, but reserve space for the element in layout.
Collapsed	Do not display the element, and do not reserve space for it in layout.

Definition at line 8 of file Visibility.cs.

Function Documentation

delegate void SiliconStudio.Paradox.UI.PropertyChangedHandler< T >	(	Object	sender,
		PropertyChangedArgs< T >	e
	)