![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
MCollectible
Inherited By:
None.
Purpose:
TWidthDeltaRec controls stretching and shrinking parameters for adding and removing white space during text justification.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Do not derive from this class unless you are implementing your own version of Line Layout.
Concurrency:
Multithread safe.
Resource Use:
No special requirements.
Member Function: TWidthDeltaRec::GetShrinkFlags
void GetShrinkFlags (TDistributionFlags &)
Interface Category:
API.
Purpose:
Gets the instance of TDistributionFlags used by this object for removing white space.
Calling Context:
Called to obtain the instance of TDistributionFlags used by this object for removing white space.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::GetGrowFlags
void GetGrowFlags (TDistributionFlags &)
Interface Category:
API.
Purpose:
Gets the instance of TDistributionFlags used by this object for adding white space.
Calling Context:
Called to obtain the instance of TDistributionFlags used by this object for adding white space.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::GetRightShrinkLimit
void GetRightShrinkLimit (GCoordinateFactor &)
Interface Category:
API.
Purpose:
Gets the currently set limit for removing white space from the right.
Calling Context:
Called to obtain the currently set limit for removing white space from the right.
Parameters:
- GCoordinateFactor & -The limit for removing white space from the right.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::GetRightGrowLimit
void GetRightGrowLimit (GCoordinateFactor &)
Interface Category:
API.
Purpose:
Gets the currently set limit for adding white space from the right.
Calling Context:
Called to obtain the currently set limit for adding white space from the right.
Parameters:
- GCoordinateFactor & -The limit for adding white space from the right.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::GetLeftShrinkLimit
void GetLeftShrinkLimit (GCoordinateFactor &)
Interface Category:
API.
Purpose:
Gets the currently set limit for removing white space from the left.
Calling Context:
Called to obtain the currently set limit for removing white space from the left.
Parameters:
- GCoordinateFactor & -The limit for removing white space from the left.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::GetLeftGrowLimit
void GetLeftGrowLimit (GCoordinateFactor &)
Interface Category:
API.
Purpose:
Gets the currently set limit for adding white space from the left.
Calling Context:
Called to obtain the currently set limit for adding white space from the left.
Parameters:
- GCoordinateFactor & -The limit for adding white space from the left.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::SetShrinkFlags
void SetShrinkFlags (const TDistributionFlags &)
Interface Category:
API.
Purpose:
Sets the TDistributionFlags instance used by this object to remove white space.
Calling Context:
Called to set the TDistributionFlags instance used by this object to remove white space.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::SetGrowFlags
void SetGrowFlags (const TDistributionFlags &)
Interface Category:
API.
Purpose:
Sets the TDistributionFlags instance used by this object to add white space.
Calling Context:
Called to set the TDistributionFlags instance used by this object to add white space.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::SetRightShrinkLimit
void SetRightShrinkLimit (GCoordinateFactor)
Interface Category:
API.
Purpose:
Sets the limit for removing white space from the right.
Calling Context:
Called to set the limit for removing white space from the right.
Parameters:
- GCoordinateFactor -The limit for removing white space from the right.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::SetRightGrowLimit
void SetRightGrowLimit (GCoordinateFactor)
Interface Category:
API.
Purpose:
Sets the limit for adding white space to the right.
Calling Context:
Called to set the limit for adding white space to the right.
Parameters:
- GCoordinateFactor -The limit for adding white space to the right.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::SetLeftShrinkLimit
void SetLeftShrinkLimit (GCoordinateFactor)
Interface Category:
API.
Purpose:
Sets the limit for removing white space from the left.
Calling Context:
Called to set the limit for removing white space from the left.
Parameters:
- GCoordinateFactor -The limit for removing white space from the left.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::SetLeftGrowLimit
void SetLeftGrowLimit (GCoordinateFactor)
Interface Category:
API.
Purpose:
Sets the limit for adding white space to the left.
Calling Context:
Called to set the limit for adding white space to the left.
Parameters:
- GCoordinateFactor -The limit for adding white space to the left.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::operator<<=
virtual TStream & operator <<= (TStream & fromWhere)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called to stream in data.
Parameters:
- TStream & fromWhere -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:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::operator>>=
virtual TStream & operator >>=(TStream & toWhere) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Called to stream out data.
Parameters:
- TStream & toWhere -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:
Multithread safe.
Other Considerations:
None.
TWidthDeltaRec & operator =(const TWidthDeltaRec & x)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object.
Parameters:
- const TFormatable & toCopy -The source object for the assignment.
Return Value:
A non-const reference to the left-hand side object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::operator!=
bool operator != (const TWidthDeltaRec & x) const
Interface Category:
API.
Purpose:
Inequality operator.
Calling Context:
Call to compare two instances of this class.
Parameters:
Return Value:
Returns true if the objects are not equal.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TWidthDeltaRec::operator==
bool operator ==(const TWidthDeltaRec & x) const
Interface Category:
API.
Purpose:
Equality operator.
Calling Context:
Call to compare two instances of this class.
Parameters:
Return Value:
Returns false if the instances are equal, true if they are not.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
- TWidthDeltaRec ()
- TWidthDeltaRec (const TWidthDeltaRec & y)
- TWidthDeltaRec (GCoordinate, GCoordinate, GCoordinate, GCoordinate, TDistributionFlags, TDistributionFlags)
Interface Category:
API.
Purpose:
- Default constructor.
- Copy constructor.
- Constructor to use when instantiating with specific settings.
Calling Context:
- Called by the stream-in operators.
- Called to copy an object.
- Call to instantiate with specific settings.
Parameters:
- Takes no parameters.
- const TWidthDeltaRec & y -The object to copy.
- GCoordinate -The left grow limit for this object.
- GCoordinate -The left shrink limit for this object.
- GCoordinate -The right grow limit for this object.
- GCoordinate -The right shrink limit for this object.
- TDistributionFlags -The grow flags for this object.
- TDistributionFlags -The shrink flags for this object.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
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.