Public Member Functions | Protected Attributes | Friends

nsFrameList::FrameLinkEnumerator Class Reference

A class that can be used to enumerate links between frames. More...

#include <nsFrameList.h>

Inheritance diagram for nsFrameList::FrameLinkEnumerator:
Collaboration diagram for nsFrameList::FrameLinkEnumerator:

List of all members.

Public Member Functions

 FrameLinkEnumerator (const nsFrameList &aList)
 FrameLinkEnumerator (const FrameLinkEnumerator &aOther)
 FrameLinkEnumerator (const nsFrameList &aList, nsIFrame *aPrevFrame)
void operator= (const FrameLinkEnumerator &aOther)
void Next ()
PRBool AtEnd () const
nsIFrame * PrevFrame () const
nsIFrame * NextFrame () const

Protected Attributes

nsIFrame * mPrev


class nsFrameList

Detailed Description

A class that can be used to enumerate links between frames.

When created from an nsFrameList, it points to the "link" immediately before the first frame. It can then be advanced until it points to the "link" immediately after the last frame. At any position, PrevFrame() and NextFrame() are the frames before and after the given link. This means PrevFrame() is null when the enumerator is at the beginning of the list and NextFrame() is null when it's AtEnd().

Constructor & Destructor Documentation

nsFrameList::FrameLinkEnumerator::FrameLinkEnumerator ( const nsFrameList aList  )  [inline]
nsFrameList::FrameLinkEnumerator::FrameLinkEnumerator ( const FrameLinkEnumerator aOther  )  [inline]
nsFrameList::FrameLinkEnumerator::FrameLinkEnumerator ( const nsFrameList aList,
nsIFrame *  aPrevFrame 
) [inline]

Member Function Documentation

PRBool nsFrameList::FrameLinkEnumerator::AtEnd (  )  const [inline]

Reimplemented from nsFrameList::Enumerator.

void nsFrameList::FrameLinkEnumerator::Next (  )  [inline]

Reimplemented from nsFrameList::Enumerator.

nsIFrame* nsFrameList::FrameLinkEnumerator::NextFrame (  )  const [inline]
void nsFrameList::FrameLinkEnumerator::operator= ( const FrameLinkEnumerator aOther  )  [inline]
nsIFrame* nsFrameList::FrameLinkEnumerator::PrevFrame (  )  const [inline]

Friends And Related Function Documentation

friend class nsFrameList [friend]

Member Data Documentation

The documentation for this class was generated from the following file: