LibreOffice Module sd (master) 1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
sd::outliner::DocumentIteratorImpl Class Referencefinal

Iterator for iteration over all objects in all views. More...

#include <OutlinerIteratorImpl.hxx>

Inheritance diagram for sd::outliner::DocumentIteratorImpl:
[legend]
Collaboration diagram for sd::outliner::DocumentIteratorImpl:
[legend]

Public Member Functions

 DocumentIteratorImpl (sal_Int32 nPageIndex, PageKind ePageKind, EditMode eEditMode, SdDrawDocument *pDocument, const std::weak_ptr< ViewShell > &rpViewShellWeak, bool bDirectionIsForward)
 
virtual ~DocumentIteratorImpl () override
 
virtual void GotoNextText () override
 Advance to the next text of the current object or to the next object. More...
 
virtual IteratorImplBaseClone (IteratorImplBase *pObject=nullptr) const override
 Create an exact copy of this object. More...
 
- Public Member Functions inherited from sd::outliner::ViewIteratorImpl
 ViewIteratorImpl (sal_Int32 nPageIndex, SdDrawDocument *pDocument, const std::weak_ptr< ViewShell > &rpViewShellWeak, bool bDirectionIsForward)
 
 ViewIteratorImpl (sal_Int32 nPageIndex, SdDrawDocument *pDocument, const std::weak_ptr< ViewShell > &rpViewShellWeak, bool bDirectionIsForward, PageKind ePageKind, EditMode eEditMode)
 
virtual ~ViewIteratorImpl () override
 
virtual void GotoNextText () override
 Advance to the next text of the current object or to the next object. More...
 
virtual IteratorImplBaseClone (IteratorImplBase *pObject=nullptr) const override
 Create an exact copy of this object. More...
 
virtual void Reverse () override
 Reverse the direction of iteration. More...
 
- Public Member Functions inherited from sd::outliner::IteratorImplBase
 IteratorImplBase (SdDrawDocument *pDocument, const std::weak_ptr< ViewShell > &rpViewShellWeak, bool bDirectionIsForward)
 The constructor stores the given arguments to be used by the derived classes. More...
 
 IteratorImplBase (SdDrawDocument *pDocument, std::weak_ptr< ViewShell > pViewShellWeak, bool bDirectionIsForward, PageKind ePageKind, EditMode eEditMode)
 
virtual ~IteratorImplBase ()
 
virtual void GotoNextText ()=0
 Advance to the next text of the current object or to the next object. More...
 
virtual const IteratorPositionGetPosition ()
 Return an object that describes the current object. More...
 
virtual IteratorImplBaseClone (IteratorImplBase *pObject=nullptr) const
 Create an exact copy of this object. More...
 
virtual bool operator== (const IteratorImplBase &rIterator) const
 Test the equality of the this object and the given iterator. More...
 
virtual bool IsEqualSelection (const IteratorImplBase &rIterator) const
 This method is used by the equality operator. More...
 
virtual void Reverse ()
 Reverse the direction of iteration. More...
 

Private Member Functions

DocumentIteratorImploperator= (const DocumentIteratorImpl &)=delete
 

Private Attributes

sal_Int32 mnPageCount
 Number of pages in the view that is specified by <member>maPosition</member>. More...
 

Additional Inherited Members

- Protected Member Functions inherited from sd::outliner::ViewIteratorImpl
void SetPage (sal_Int32 nPageIndex)
 Set up page pointer and object list iterator for the specified page. More...
 
- Protected Attributes inherited from sd::outliner::IteratorImplBase
IteratorPosition maPosition
 The current position as returned by <member>GetPosition()</member>. More...
 
SdDrawDocumentmpDocument
 The document on whose data the iterator operates. More...
 
std::weak_ptr< ViewShellmpViewShellWeak
 Necessary secondary source of information. More...
 
bool mbDirectionIsForward
 Specifies the search direction. More...
 

Detailed Description

Iterator for iteration over all objects in all views.

It automatically switches views when reaching the end/beginning of a view.

For documentation of the methods please refer to the base class <type>IteratorImplBase</type>.

Definition at line 214 of file OutlinerIteratorImpl.hxx.

Constructor & Destructor Documentation

◆ DocumentIteratorImpl()

sd::outliner::DocumentIteratorImpl::DocumentIteratorImpl ( sal_Int32  nPageIndex,
PageKind  ePageKind,
EditMode  eEditMode,
SdDrawDocument pDocument,
const std::weak_ptr< ViewShell > &  rpViewShellWeak,
bool  bDirectionIsForward 
)

◆ ~DocumentIteratorImpl()

sd::outliner::DocumentIteratorImpl::~DocumentIteratorImpl ( )
overridevirtual

Definition at line 704 of file OutlinerIterator.cxx.

Member Function Documentation

◆ Clone()

IteratorImplBase * sd::outliner::DocumentIteratorImpl::Clone ( IteratorImplBase pObject = nullptr) const
overridevirtual

Create an exact copy of this object.

No argument should be specified when called from the outside. It then creates an object first and passes that to the inherited <member>Clone()</member> methods to fill in class specific information.

Returns
Returns a copy of this object. When this method is called with an argument then this value will be returned.

Reimplemented from sd::outliner::ViewIteratorImpl.

Definition at line 707 of file OutlinerIterator.cxx.

References sd::outliner::ViewIteratorImpl::Clone(), DocumentIteratorImpl(), sd::outliner::IteratorImplBase::maPosition, sd::outliner::IteratorImplBase::mbDirectionIsForward, sd::outliner::IteratorPosition::meEditMode, sd::outliner::IteratorPosition::mePageKind, sd::outliner::IteratorPosition::mnPageIndex, sd::outliner::IteratorImplBase::mpDocument, sd::outliner::IteratorImplBase::mpViewShellWeak, and pObject.

◆ GotoNextText()

void sd::outliner::DocumentIteratorImpl::GotoNextText ( )
overridevirtual

◆ operator=()

DocumentIteratorImpl & sd::outliner::DocumentIteratorImpl::operator= ( const DocumentIteratorImpl )
privatedelete

Member Data Documentation

◆ mnPageCount

sal_Int32 sd::outliner::DocumentIteratorImpl::mnPageCount
private

Number of pages in the view that is specified by <member>maPosition</member>.

Definition at line 231 of file OutlinerIteratorImpl.hxx.

Referenced by DocumentIteratorImpl(), and GotoNextText().


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