![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
None.
Purpose:
TULongRect is a simple structure that represents a rectangle in an unsigned long coordinate space. Its fields are reminiscent of TGRects and can be accessed similarly.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Clients should not derive from this class.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
- TULongRect ()
- TULongRect (const TULongRect &)
- TULongRect (const TULongPair & leftTop, const TULongPair & rightBottom)
Interface Category:
API.
Purpose:
- Default constructor. Fields are valid but undefined.
- Copy constructor.
- Constructor from TULongPair points specifying top left and bottom right.
Calling Context:
- Called by the stream-in operators and clients with no specific default requirements.
- Called to copy an object.
- Set from TULongPair points (top left and bottom right).
Parameters:
- Takes no parameters.
- const TULongRect & -The rectangle to copy.
- const TULongPair & leftTop -The top-left corner of the rectangle.
- const TULongPair & rightBottom -The bottom-right corner of the rectangle.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
~ TULongRect ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TULongRect::Set
- void Set (const TULongPair & leftTop, const TULongPair & rightBottom)
- void Set (unsigned long l, unsigned long t, unsigned long r, unsigned long b)
Interface Category:
API.
Purpose:
- Sets the left-top and right-bottom coordinates of the rectangle.
- Sets the rectangle boundaries by left, top, right, and bottom sides.
Calling Context:
- Called to set top-left and bottom-right corners.
- Called to set each boundary of the rectangle.
Parameters:
- const TULongPair & leftTop -The left-top point of the rectangle.
- const TULongPair & rightBottom -The right-bottom point of the rectangle.
- unsigned long l -The left edge of the rectangle.
- unsigned long t -The top edge of the rectangle.
- unsigned long r -The right edge of the rectangle.
- unsigned long b -The bottom edge of the rectangle.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TULongRect::GetSize
TULongPair GetSize () const
Interface Category:
API.
Purpose:
Returns the size of the rectangle as a TULongPair.
Calling Context:
Called to obtain the size of the rectangle.
Parameters:
Return Value:
Returns a TULongPair whose fields represent the size of the rectangle.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TULongRect::operator==
bool operator ==(const TULongRect & Src) const
Interface Category:
API.
Purpose:
Compares itself with the parameter input.
Calling Context:
Called to compare rectangles.
Parameters:
- const TULongRect & Src -The rectangle being compared.
Return Value:
Returns true if the source rectangle is equal to itself.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TULongRect::operator!=
bool operator != (const TULongRect & Src) const
Interface Category:
API.
Purpose:
Determines if the rectangles are unequal.
Calling Context:
Called to compare rectangles.
Parameters:
- const TULongRect & Src -The rectangle being compared.
Return Value:
Returns true if the source rectangle is not equal to itself.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TULongRect::operator=
TULongRect & operator =(const TULongRect &)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object.
Parameters:
Return Value:
A non-const reference to the left-hand side object. Returns the result of the assignment.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TULongRect::operator<<=
TStream & operator <<= (TStream & towhere)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called to stream in data.
Parameters:
- TStream & towhere -The stream the object streams itself in from.
Return Value:
Returns a reference to the stream the object streams itself in from.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TULongRect::operator>>=
TStream & operator >>=(TStream & fromwhere) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Called to stream out data.
Parameters:
- TStream & fromwhere -The stream the object streams itself out to.
Return Value:
Returns a reference to the stream the object streams itself out to.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.