Drag[en]gine Script Module DragonScript Script API  1.0
Decoration Interface Reference

Window decoration interface. More...

Inheritance diagram for Decoration:
DefaultDecoration CanvasCreatorDecoration CornerDecoration SimpleDecoration

Classes

enum  eButtons
 Button. More...
 
enum  eHitAreas
 Hit areas. More...
 

Public Member Functions

int 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 onGuiThemeChanged ()
 Gui theme of the window changed. 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 (int 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.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ areaHitBy()

int areaHitBy ( Point  position)

Test which part of the decoration is hit if any.

Implemented in CanvasCreatorDecoration, DefaultDecoration, SimpleDecoration, and CornerDecoration.

§ getBorderSize()

BorderSize getBorderSize ( )

§ getCanvas()

Canvas getCanvas ( )

Canvas to render this border.

Implemented in DefaultDecoration.

§ getWindow()

Window getWindow ( )

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

Implemented in DefaultDecoration.

§ onGuiThemeChanged()

void onGuiThemeChanged ( )

Gui theme of the window changed.

Implemented in DefaultDecoration.

§ onWindowParametersChanged()

void onWindowParametersChanged ( )

Window parameters changed that potentially affect the decoration.

Implemented in DefaultDecoration.

§ resizeCanvas()

void resizeCanvas ( )

Resize canvas to fit window if window is set.

Implemented in DefaultDecoration.

§ setButtonState()

void setButtonState ( int  button,
bool  hover,
bool  pressed 
)

Set button state.

Parameters
buttonOne from BUTTON_*
hoverMouse hovers over button.
pressedButton is pressed down.

Implemented in DefaultDecoration.

§ setWindow()

void setWindow ( Window  window)

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

Implemented in DefaultDecoration.


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