Programming Reference: ODFrameFacetIterator

# Programming Reference

## ODFrameFacetIterator

Class Definition File | FrFaItr.idl
Class C++ Binding | FrFaItr.xh

Class Hierarchy

    SOMObject
       ODObject
          ODFrameFacetIterator

Description

An object of the ODFrameFacetIterator class provides access to all facets of a frame.

A frame-facet iterator is used to apply an operation to all facets of one of your part's display frames, such as drawing and changing their shapes. For example, a part might use a frame-facet iterator to delete all facets of an embedded frame that it deletes or to update all views of one of its display frames if it were displaying asynchronously.

Your part creates a frame-facet iterator object by calling its frame's CreateFacetIterator method, which returns a reference to a frame-facet iterator object.

While you are using a frame-facet iterator, you should not modify the list of facets for the frame. You must postpone adding facets to or removing facets from the list of facets for the frame until after you have deleted the iterator.

For more information related to facet objects, see the class description for ODFacet. For more information on accessing objects through iterators, see the chapter on OpenDoc runtime features in the OpenDoc Programming Guide.

Methods

The methods defined by the ODFrameFacetIterator class include:

- First
- IsNotComplete
- Next

Overridden Methods | There are no methods overridden by the ODFrameFacetIterator class.

### First

This method begins the iteration and returns a reference to the first facet in the iteration sequence.

Signature

    ODFacet *First ()

Parameters

None.

Returns

rv (ODFacet *) - returns

  A reference to the first facet in the iteration sequence or kODNULL if the frame has no facets.

Remarks

Your part must call this method before calling this frame-facet iterator's IsNotComplete method for the first time. This method can be called multiple times; each time, it resets the iteration.

Exception Handling

kODErrIteratorOutOfSync | The list of facets for the frame was modified while the iteration was in progress.

### IsNotComplete

This method indicates whether the iteration is incomplete.

Signature

    ODBoolean IsNotComplete ()

Parameters

None.

Returns

rv (ODBoolean) - returns

  A flag indicating whether the iteration is incomplete.

  kODTrue | The iteration is incomplete.
  kODFalse | The iteration is complete.

Remarks

Your part calls this method to test whether more facets remain in the iteration sequence. This method returns kODTrue if the preceding call to the First or Next method found a facet. This method returns kODFalse when you have examined all the facets (that is, when the previous call to First or Next returned kODNULL).

Exception Handling

kODErrIteratorNotInitialized | This method was called before calling the First or Next method to begin the iteration sequence.
kODErrIteratorOutOfSync | The list of facets for the frame was modified while the iteration was in progress.

### Next

This method returns a reference to the next facet in the iteration sequence.

Signature

    ODFacet *Next ()

Parameters

None.

Returns

rv (ODFacet *) - returns

  A reference to the next facet in the iteration sequence or kODNULL if you have reached the last facet.

Remarks

If your part calls this method before calling this frame-facet iterator's First method to begin the iteration sequence, this method works the same as calling the First method.

Exception Handling

kODErrIterationOutOfSync | The list of facets for the frame was modified while the iteration was in progress.

[ Top | Previous | Next | Contents | Index | Documentation Homepage ]