= CFormRect **825gen2** =

Class for specifying a display rectangle. CFormRect may specify an alternate position and size for the zoom state.

== Constructors ==

{{{#!c++
CFormRect(void);
}}}


==== Example ====

{{{#!c++
CFormRect rect;
}}}

== Member Functions ==

=== SetX ===
Sets X coordinate

{{{#!c++
void SetX(int x);
}}}

==== Parameters ====
 * x - X coordinate

==== Return Value ====

Function does not return a value.

=== SetY ===
Sets Y coordinate

{{{#!c++
void SetY(int y);
}}}

==== Parameters ====
 * y - Y coordinate

==== Return Value ====

Function does not return a value.

=== SetWidth ===
Sets width of the rectangle

{{{#!c++
void SetWidth(int width);
}}}

==== Parameters ====
 * width - width value

==== Return Value ====

Function does not return a value.

=== SetHeight ===
Sets width of the rectangle

{{{#!c++
void SetHeight(int height);
}}}

==== Parameters ====
 * height - height value

==== Return Value ====

Function does not return a value.

=== AddToWidth ===
Adds specified number of pixels to width of the rectangle

{{{#!c++
void AddToWidth(int addToWidth);
}}}

==== Parameters ====
 * addToWidth - number of pixels to add

==== Return Value ====

Function does not return a value.

=== operator += ===
Updates a rect position based on a CFormAdvanceX or CFormAdvanceY

{{{#!c++
CFormRect& opeator+=(const CFormAdvanceY& advY);

CFormRect& opeator+=(const CFormAdvanceX& advX);

CFormRect& opeator+=(const CFormRect& advRect);

}}}

==== Parameters ====
 * advY - CFormAdvanceY value
 * advX - CFormAdvanceX value
 * adv - CFormRect 

==== Return Value ====

Function returns a reference to the CFormRect (this).



=== SetTopBasedOnFont ===
Sets top coordinate of the rectangle based on a font

{{{#!c++
void SetTopBasedOnFont(CFont& font, double multiplier, int addPixels = 0)
}}}

==== Parameters ====
 * font - CFont 
 * multiplier - Value to multiplier times the height of the specified font to set the rectangle top
 * addPixels - value of additional pixels to add after the multiplication

==== Return Value ====

Function does not return a value.

=== SetHeightBasedOnFont ===
Sets the height of the rectangle based on a font

{{{#!c++
void SetHeightBasedOnFont(CFont& font, double heightMultiplier, int addPixels = 0
}}}

==== Parameters ====
 * font - CFont
 * heightMultiplier - Value to multiple the specified font height to set the rectangle height
 * addPixels - value of additional pixels to add after multiplication

==== Return Value ====

Function does not return a value.

=== SetTopAndHeightBasedOnFont ===
Sets top coordinate and height of the rectangle based on a font

{{{#!c++
void SetTopAndHeightBasedOnFont(CFont& font, double topMultiplier, double heightMultiplier)
}}}

==== Parameters ====
 * font - CFont 
 * topMultiplier - Value to multiplier times the height of the specified font to set the rectangle top
 * heightMultiplier - value of multiplier time the height of the specified font to set the rectangle height

==== Return Value ====

Function does not return a value.