SmashHammer.UI.IWindow Interface Reference

Provides access to a UI window's properties and methods. More...

Inheritance diagram for SmashHammer.UI.IWindow:

Public Member Functions
void	BringToFront ()
	Bring the window in front of other windows.

Properties
bool	IsMovable [get, set]
	Is the window movable?
bool	IsResizable [get, set]
	Is the window resizable?
float	MinResizeWidth [get, set]
	Minimum resize width of the window.
float	MinResizeHeight [get, set]
	Minimum resize height of the window.
bool	IsCollapsible [get, set]
	Is the window collapsible?
bool	IsCloseable [get, set]
	Is the window closeable?
string	Title [get, set]
	The window title.
bool	IsCollapsed [get, set]
	Is the window collapsed?
RectProxy	ContentRect [get]
	The calculated rect of the window content area.

Events
ValueChangedHandler	OnClose
	Event that is raised when the window is closed.
ValueChangedHandler	OnResize
	Event that is raised when the window is resized.

Detailed Description

Provides access to a UI window's properties and methods.

Property Documentation

IsMovable

bool SmashHammer.UI.IWindow.IsMovable

getset

Is the window movable?

true if this window can be moved; otherwise, false.

IsResizable

bool SmashHammer.UI.IWindow.IsResizable

getset

Is the window resizable?

true if this window can be resized; otherwise, false.

MinResizeWidth

float SmashHammer.UI.IWindow.MinResizeWidth

getset

Minimum resize width of the window.

The minimum width the window can be resized to.

MinResizeHeight

float SmashHammer.UI.IWindow.MinResizeHeight

getset

Minimum resize height of the window.

The minimum height the window can be resized to.

IsCollapsible

bool SmashHammer.UI.IWindow.IsCollapsible

getset

Is the window collapsible?

true if this window can be collapsed; otherwise, false.

IsCloseable

bool SmashHammer.UI.IWindow.IsCloseable

getset

Is the window closeable?

true if this window can be closed; otherwise, false.

Title

string SmashHammer.UI.IWindow.Title

getset

The window title.

The title of this window.

IsCollapsed

bool SmashHammer.UI.IWindow.IsCollapsed

getset

Is the window collapsed?

true if this window is currently collapsed; otherwise, false.

ContentRect

RectProxy SmashHammer.UI.IWindow.ContentRect

get

The calculated rect of the window content area.

The content area rect.