wxJavaScript

back to gui 

wxSize

^{generated from ../src/mod_gui/misc/size.cpp}

A wxSize is a useful data structure for graphics operations. It simply contains integer width and height members.

Constants

Constructor

wxSize

wxSize(Width = -1, 
       Height = -1)
 

Name	Type	Default	Description
Width	Integer	-1	The width
Height	Integer	-1	The height. When not specified and Width is specified the value will be 0.

wxSize(Object)
 

Name	Type	Default	Description
Object	Object		An object which has a width and height property

Creates a new wxSize. When no arguments are given then wxSize gets the same value as wxDefaultSize.
The second form can be used to create a wxSize object from a JSON object.

Properties

Name	Type	Description
fullySpecified	Boolean	Returns true if neither of the size object components is equal to -1, which is used as default for the size values in wxWidgets.
height	Integer	The height property.
width	Integer	The width property.

Methods

decBy

decBy(Size)
 

Name	Type	Default	Description
Size	wxSize

decBy(X, 
      Y)
 

Name	Type	Default	Description
X	Integer
Y	Integer

decBy(D)
 

Name	Type	Default	Description
D	Integer

Decreases the size in x- and y- directions

decTo

decTo(Size)
 

Name	Type	Default	Description
Size	wxSize

Decrements this object so that both of its dimensions are not greater than the corresponding dimensions of the size

incBy

incBy(Size)
 

Name	Type	Default	Description
Size	wxSize

incBy(X, 
      Y)
 

Name	Type	Default	Description
X	Integer
Y	Integer

incBy(D)
 

Name	Type	Default	Description
D	Integer

Decreases the size in x- and y- directions

incTo

incTo(Size)
 

Name	Type	Default	Description
Size	wxSize

Decrements this object so that both of its dimensions are not greater than the corresponding dimensions of the size

scale

scale(xScale, 
      yScale) : wxSize
 

Name	Type	Default	Description
xScale	Double
yScale	Double

Scales the dimensions of this object by the given factors. Returns this object so that you can concatenate other operations in the same line.

set

set(X, 
    Y)
 

Name	Type	Default	Description
X	Integer
Y	Integer

Decreases the size in x- and y- directions

setDefaults

setDefaults(DefaultSize)
 

Name	Type	Default	Description
DefaultSize	wxSize

Combine this size object with another one replacing the default (i.e. equal to -1) components of this object with those of the other. It is typically used like this:

if ( !size.fullySpecified )
   {
     size.setDefaults(GetDefaultSize());
   }