Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.BorderSize Class Reference
Inheritance diagram for Dragengine.Gui.BorderSize:

Public Member Functions

BorderSize enlarge (BorderSize borderSize)
 
BorderSize enlarge (int left, int top, int right, int bottom)
 
bool equals (Object other)
 
int getBottom ()
 
int getHeight ()
 
int getLeft ()
 
int getRight ()
 
Point getSize ()
 
int getTop ()
 
int getWidth ()
 
BorderSize new ()
 
BorderSize new (BorderSize borderSize)
 
BorderSize new (int left, int top, int right, int bottom)
 
BorderSize new (int size)
 Create border size object with identical size all around. More...
 
BorderSize operator+ (BorderSize borderSize)
 Border size enlarged by another border size object. More...
 
BorderSize operator- (BorderSize borderSize)
 Border size shrunk by another border size object. More...
 
BorderSize shrink (BorderSize borderSize)
 Border size shrunk by another border size object. More...
 
BorderSize shrink (int left, int top, int right, int bottom)
 Border size shrunk by another border size object. More...
 
String toString ()
 

Detailed Description

Immutable object storing the size of borders around a rectangular area.

Member Function Documentation

◆ enlarge() [1/2]

BorderSize Dragengine.Gui.BorderSize.enlarge ( BorderSize  borderSize)

Returns the border size enlarged by another border size object.

◆ enlarge() [2/2]

BorderSize Dragengine.Gui.BorderSize.enlarge ( int  left,
int  top,
int  right,
int  bottom 
)

Returns the border size enlarged by another border size object.

◆ equals()

bool Dragengine.Gui.BorderSize.equals ( Object  other)

Test if two border size objects are equal.

◆ getBottom()

int Dragengine.Gui.BorderSize.getBottom ( )

Retrieves the size in pixels of the bottom border.

◆ getHeight()

int Dragengine.Gui.BorderSize.getHeight ( )

Retrieves the total height of the top and bottom border added together.

◆ getLeft()

int Dragengine.Gui.BorderSize.getLeft ( )

Retrieves the size in pixels of the left border.

◆ getRight()

int Dragengine.Gui.BorderSize.getRight ( )

Retrieves the size in pixels of the right border.

◆ getSize()

Point Dragengine.Gui.BorderSize.getSize ( )

Retrieves the total size of the borders as a point object. The x coordinate is the sum of the left and right border. The y coordinate is the sum of the top and bottom borders.

◆ getTop()

int Dragengine.Gui.BorderSize.getTop ( )

Retrieves the size in pixels of the top border.

◆ getWidth()

int Dragengine.Gui.BorderSize.getWidth ( )

Retrieves the total width of the left and right border added together.

◆ new() [1/4]

BorderSize Dragengine.Gui.BorderSize.new ( )

Creates a border size object with 0 pixel borders.

◆ new() [2/4]

BorderSize Dragengine.Gui.BorderSize.new ( BorderSize  borderSize)

Creates a copy of a border size object.

◆ new() [3/4]

BorderSize Dragengine.Gui.BorderSize.new ( int  left,
int  top,
int  right,
int  bottom 
)

Creates a border size object with the given border sizes in pixels.

◆ new() [4/4]

BorderSize Dragengine.Gui.BorderSize.new ( int  size)

Create border size object with identical size all around.

◆ operator+()

BorderSize Dragengine.Gui.BorderSize.operator+ ( BorderSize  borderSize)

Border size enlarged by another border size object.

◆ operator-()

BorderSize Dragengine.Gui.BorderSize.operator- ( BorderSize  borderSize)

Border size shrunk by another border size object.

◆ shrink() [1/2]

BorderSize Dragengine.Gui.BorderSize.shrink ( BorderSize  borderSize)

Border size shrunk by another border size object.

◆ shrink() [2/2]

BorderSize Dragengine.Gui.BorderSize.shrink ( int  left,
int  top,
int  right,
int  bottom 
)

Border size shrunk by another border size object.

◆ toString()

String Dragengine.Gui.BorderSize.toString ( )

String representation.


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