D2BS
Public Member Functions | Public Attributes

Frame Class Reference

This class represents a screen hook for a Frame. More...

List of all members.

Public Member Functions

 Frame (int x=0, int y=0, int x2=0, int y2=0, int align=0, bool automap=false, ClickHandler click=null, HoverHandler hover=null)
 Create a Frame hook with the given parameters.
void remove ()
 Remove the Frame from the screen and destroy the corresponding object.

Public Attributes

int x
 The x coordinate (left) of the Frame.
int y
 The y coordinate (top) of the Frame.
int xsize
 The xsize (width) of the Frame.
int ysize
 The ysize (height) of the Frame.
bool visible
 Whether or not the Frame is visible.
int align
 The horizontal alignment.
int zorder
 The z-order of the Frame (what it covers up and is covered by).
ClickHandler click
 The click handler that gets called when the Frame is clicked.
HoverHandler hover
 The hover handler that gets called when the Frame gets hovered over.

Detailed Description

This class represents a screen hook for a Frame.

Todo:

Explain (and understand) this better.

Verify all the documentation in this class.


Constructor & Destructor Documentation

Frame::Frame ( int  x = 0,
int  y = 0,
int  x2 = 0,
int  y2 = 0,
int  align = 0,
bool  automap = false,
ClickHandler  click = null,
HoverHandler  hover = null 
)

Create a Frame hook with the given parameters.

Parameters:
xThe x coordinate (left) of the Frame.
yThe y coordinate (top) of the Frame.
x2The xsize (width) of the Frame.
y2The ysize (height) of the Frame.
alignThe horizontal alignment.

0 - Left

1 - Right

2 - Center

Parameters:
automapWhether the Frame is in automap coordinate space (true) or screen coordinate space (false).
clickThe click handler that gets called when the Frame is clicked.
hoverThe hover handler that gets called when the Frame gets hovered over.

Member Data Documentation

The horizontal alignment.

0 - Left

1 - Right

2 - Center