Drag[en]gine Script Module DragonScript Script API  1.0
DefaultDecoration Class Reference

Default implementation of Decoration rendering nothing and reporting no hits. More...

Inheritance diagram for DefaultDecoration:
Decoration CanvasCreatorDecoration CornerDecoration SimpleDecoration

Public Member Functions

int areaHitBy (Point position)
 Test which part of the decoration is hit if any. More...
 
BorderSize getBorderSize ()
 Border size. More...
 
bool getButtonCloseHover ()
 Close button hover state. More...
 
bool getButtonClosePressed ()
 Close button pressed state. More...
 
bool getButtonMaximizeHover ()
 Maximize button hover state. More...
 
bool getButtonMaximizePressed ()
 Maximize button pressed state. More...
 
bool getButtonMinimizeHover ()
 Minimize button hover state. More...
 
bool getButtonMinimizePressed ()
 Minimize button pressed state. More...
 
Canvas getCanvas ()
 Canvas to render this border. More...
 
CanvasView getCanvasView ()
 Canvas to render this border. More...
 
Window getWindow ()
 Window the decoration is assigned to or null if there is none. More...
 
DefaultDecoration new ()
 Create decoration. More...
 
void onButtonStateChanged ()
 One or more button states changed. More...
 
void onGuiThemeChanged ()
 Gui theme of the window changed. More...
 
void onWindowChanged ()
 Window changed. More...
 
void onWindowParametersChanged ()
 Window parameters changed. More...
 
void resizeCanvas ()
 Resize canvas to fit widget. 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...
 
void updateCanvas ()
 Update canvas. More...
 

Detailed Description

Default implementation of Decoration rendering nothing and reporting no hits.

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.

The default implementation reports no hits at all.

Implements Decoration.

§ getBorderSize()

BorderSize getBorderSize ( )

Border size.

Default implementation returns 0-size.

Implements Decoration.

§ getButtonCloseHover()

bool getButtonCloseHover ( )

Close button hover state.

§ getButtonClosePressed()

bool getButtonClosePressed ( )

Close button pressed state.

§ getButtonMaximizeHover()

bool getButtonMaximizeHover ( )

Maximize button hover state.

§ getButtonMaximizePressed()

bool getButtonMaximizePressed ( )

Maximize button pressed state.

§ getButtonMinimizeHover()

bool getButtonMinimizeHover ( )

Minimize button hover state.

§ getButtonMinimizePressed()

bool getButtonMinimizePressed ( )

Minimize button pressed state.

§ getCanvas()

Canvas getCanvas ( )

Canvas to render this border.

Implements Decoration.

§ getCanvasView()

CanvasView getCanvasView ( )

Canvas to render this border.

§ getWindow()

Window getWindow ( )

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

Implements Decoration.

§ new()

Create decoration.

§ onButtonStateChanged()

void onButtonStateChanged ( )

One or more button states changed.

§ onGuiThemeChanged()

void onGuiThemeChanged ( )

Gui theme of the window changed.

Implements Decoration.

§ onWindowChanged()

void onWindowChanged ( )

Window changed.

§ onWindowParametersChanged()

void onWindowParametersChanged ( )

Window parameters changed.

Implements Decoration.

§ resizeCanvas()

void resizeCanvas ( )

Resize canvas to fit widget.

Does nothing if no window is set.

Implements Decoration.

§ setButtonState()

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

Set button state.

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

Implements Decoration.

§ setWindow()

void setWindow ( Window  window)

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

Implements Decoration.

§ updateCanvas()

void updateCanvas ( )

Update canvas.

Overwrite to create canvas content.


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