CParaFormat Class Reference

The default C++ constructor constructs a new CParaFormat initialising all attributes to the default settings.

Note: This function allows a CParaFormat object to be created on the stack. This should only be done if it is known in advance that the object will not be used to store tab stops, bullets or borders.

The destructor frees all resources owned by the paragraph format container (tabs, borders and bullets), prior to its destruction.

Note that Strip() also sets the resource pointers to NULL. This is important in case CParaFormat is on the stack and gets deleted twice: once by the cleanup stack and once by exceptions being unwound.

Tests whether all paragraph borders in the specified paragraph format container are identical to the paragraph borders of this paragraph format container.

Tests whether any paragraph borders have been set.

Copies selected attribute values from another paragraph format container. Only the attributes which are set in the mask are copied.

Copies all attribute values from another paragraph format container.

Tests whether the paragraph border located on the specified side is the same as the border on the corresponding side in this object. For two borders to be equal, they must both either be set or unset, and if set, they must have the same characteristics.

Compares selected attribute values for equality. Only the attributes specified in the mask are involved in the comparison.

Compares all attribute values for equality.

Locates the tab stop specified by its twips position, and returns its offset in the tab list.

Allocates and constructs a CParaFormat object. All attributes are initialised with default values.

Allocates and constructs a new CParaFormat. All attributes are initialised to the values contained in the aFormat argument.

Allocates and constructs a CParaFormat object. All attributes are initialised with default values. Leaves the object on the cleanup stack.

Gets the paragraph border on the side specified. If no paragraph border array has been allocated, returns a default paragraph border.

Gets a pointer to the paragraph border on the side specified. If no paragraph border array has been allocated, returns NULL.

Deletes all paragraph borders.

Removes all tab stops from the object.

Deletes a tab stop identified by its twips position. If the specified tab stop does not exist, the function has no effect.

Resets all paragraph format attributes to their default values. All tab stops, paragraph borders and bullet points which have been allocated are deleted and set to NULL.

Resets all paragraph format attributes to their default values, but any allocated tab stops, bullet points and paragraph borders are preserved.

Sets one side of the object's paragraph border. If a border on the specified side already exists, it is replaced.

Note: Setting a single side of the object's paragraph border incurs the overhead of allocating storage for the three other sides, which are assigned default values.

Adds a tab stop to the list of tab stops, maintaining the ordering of the list, (ascending order of twips position). Multiple tabs with the same twips position are not allowed, so that if aTabStop shares the same twips position as an existing tab stop, regardless of its alignment, the existing tab stop is replaced by aTabStop.

Deletes all paragraph borders, bullets and tab stops. No other attributes are affected.

Gets a count of the total number of tab stops in the object's tab list. If the object has no tab list, returns zero.

Gets the tab stop located at the specified index within the tab list (counting from zero). Tab stops are ordered in ascending order of twips position. If the object has no tab list, then a default tab stop is returned.