![](../../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:
Controls stretching and shrinking parameters for the distribution of white space during text justification.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Do not derive unless you are implementing your own version of Line Layout.
Concurrency:
Multithread safe.
Resource Use:
No special requirements.
void SetPriority (DistributionPriority)
Interface Category:
API.
Purpose:
Sets the priority for distributing white space during justification.
Calling Context:
Called to set the priority for distributing white space during justification
Parameters:
- DistributionPriority -Enum value specifying the priority to use.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
void SetUnlimited (bool)
Interface Category:
API.
Purpose:
Sets the unlimited priority flag for justification.
Calling Context:
Indicates unlimited priority for justification, that is, to force all extra white space to be added in one place if true.
Parameters:
- bool - The value to which unlimited priority flag should be set.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TDistributionFlags::SetOverrideUnlimited
void SetOverrideUnlimited (bool)
Interface Category:
API.
Purpose:
Sets the override unlimited flag for justification.
Calling Context:
Indicates the overriding of unlimited justification.
Parameters:
- bool - The value to which the override unlimited flag is to be set.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
void SetOverrideLimits (bool)
Interface Category:
API.
Purpose:
Sets the override limits flag for justification.
Calling Context:
Indicates whether justification limits are to be overridden.
Parameters:
- bool - The value to which the override limits flag is to be set.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TDistributionFlags::SetOverridePriority
void SetOverridePriority (bool)
Interface Category:
API.
Purpose:
Determines if distribution priority is to be overridden.
Calling Context:
Called to force the overriding of the distribution priority.
Parameters:
- bool - The value to which the override priority flag is to be set.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
DistributionPriority GetPriority ()
Interface Category:
API.
Purpose:
Returns the justification priority.
Calling Context:
Used to set the priority for justification.
Parameters:
Return Value:
DistributionPriority enum value indicating the currently set justification priority.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
bool GetUnlimited ()
Interface Category:
API.
Purpose:
Queries whether the Unlimited field is set to true.
Calling Context:
Used to determine if the Unlimited field is set to true.
Parameters:
Return Value:
Returns true if the Unlimited field is set to true.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TDistributionFlags::GetOverrideUnlimited
bool GetOverrideUnlimited ()
Interface Category:
API.
Purpose:
Queries whether the OverrideUnlimited field is set to true.
Calling Context:
Used to determine if the OverrideUnlimited field is set to true.
Parameters:
Return Value:
Returns true if the OverrideUnlimited field is set to true.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
bool GetOverrideLimits ()
Interface Category:
API.
Purpose:
Queries whether the OverrideLimits field is set to true.
Calling Context:
Used to determine whether the OverrideLimits field is set to true;
Parameters:
Return Value:
Returns true if the OverrideLimits field is set to true.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TDistributionFlags::GetOverridePriority
bool GetOverridePriority ()
Interface Category:
API.
Purpose:
Queries whether the OverridePriority field is set to true.
Calling Context:
Used to determine whether the OverridePriority field is set to true.
Parameters:
Return Value:
Returns true if the OverridePriority field is set to true.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
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.
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.
TDistributionFlags & operator =(const TDistributionFlags & x)
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.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
bool operator != (const TDistributionFlags & 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.
bool operator ==(const TDistributionFlags & x) const
Interface Category:
API.
Purpose:
Equality operator.
Calling Context:
Call to compare two objects of this class.
Parameters:
Return Value:
Returns true if the objects are equal.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual ~ TDistributionFlags ()
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:
Multithread safe.
Other Considerations:
None.
- TDistributionFlags ()
- TDistributionFlags (const TDistributionFlags & x)
- TDistributionFlags (bool OverridePriority, bool OverrideLimits, bool OverrideUnlimited, bool Unlimited, DistributionPriority Priority)
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 TDistributionFlags & x -The object to copy.
- bool OverridePriority -Setting for the OverridePriority field.
- bool OverrideLimits -Setting for the OverrideLimits field.
- bool OverrideUnlimited -Setting for the OverrideUnlimited field.
- bool Unlimited -Setting for the Unlimited field.
- DistributionPriority Priority -Enum value specifying the justification priority.
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.