Dragengine.Gui.Decorations.Decoration Interface Reference

Window decoration interface. More...

Inheritance diagram for Dragengine.Gui.Decorations.Decoration:

Classes
enum	Area
	Area. More...
enum	Button
	Button. More...

Public Member Functions
Area	areaHitBy (Point position)
	Test which part of the decoration is hit if any. More...
BorderSize	getBorderSize ()
	Border size. More...
Canvas	getCanvas ()
	Canvas to render this border. More...
Window	getWindow ()
	Window the decoration is assigned to or null if there is none. More...
void	onWindowParametersChanged ()
	Window parameters changed that potentially affect the decoration. More...
void	resizeCanvas ()
	Resize canvas to fit window if window is set. More...
void	setButtonState (Button button, bool hover, bool pressed)
	Set button state. More...
void	setWindow (Window window)
	Set window the decoration is assigned to or null if there is none. More...

Detailed Description

Window decoration interface.

Renders a custom border around a Window supporting testing for hit window border areas.

Member Function Documentation

areaHitBy()

Area Dragengine.Gui.Decorations.Decoration.areaHitBy

(

Point

position

)

Test which part of the decoration is hit if any.

Implemented in Dragengine.Gui.Decorations.SimpleDecoration, Dragengine.Gui.Decorations.DefaultDecoration, Dragengine.Gui.Decorations.CornerDecoration, and Dragengine.Gui.Decorations.CanvasCreatorDecoration.

getBorderSize()

BorderSize Dragengine.Gui.Decorations.Decoration.getBorderSize

(

)

Border size.

Implemented in Dragengine.Gui.Decorations.SimpleDecoration, Dragengine.Gui.Decorations.DefaultDecoration, Dragengine.Gui.Decorations.CornerDecoration, and Dragengine.Gui.Decorations.CanvasCreatorDecoration.

getCanvas()

Canvas Dragengine.Gui.Decorations.Decoration.getCanvas

(

)

Canvas to render this border.

Implemented in Dragengine.Gui.Decorations.DefaultDecoration.

getWindow()

Window Dragengine.Gui.Decorations.Decoration.getWindow

(

)

Window the decoration is assigned to or null if there is none.

Implemented in Dragengine.Gui.Decorations.DefaultDecoration.

onWindowParametersChanged()

void Dragengine.Gui.Decorations.Decoration.onWindowParametersChanged

(

)

Window parameters changed that potentially affect the decoration.

Implemented in Dragengine.Gui.Decorations.DefaultDecoration.

resizeCanvas()

void Dragengine.Gui.Decorations.Decoration.resizeCanvas

(

)

Resize canvas to fit window if window is set.

Implemented in Dragengine.Gui.Decorations.DefaultDecoration.

setButtonState()

void Dragengine.Gui.Decorations.Decoration.setButtonState	(	Button	button,
		bool	hover,
		bool	pressed
	)

Set button state.

Parameters

button	One from BUTTON_*
hover	Mouse hovers over button.
pressed	Button is pressed down.

setWindow()

void Dragengine.Gui.Decorations.Decoration.setWindow

(

Window

window

)

Set window the decoration is assigned to or null if there is none.

Implemented in Dragengine.Gui.Decorations.DefaultDecoration.

---

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

• Decoration.ds