Iterator for iteration over all objects in all views. More...
#include <OutlinerIteratorImpl.hxx>
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 IteratorImplBase * | Clone (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 IteratorImplBase * | Clone (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 IteratorPosition & | GetPosition () |
| Return an object that describes the current object. More... | |
| virtual IteratorImplBase * | Clone (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 | |
| DocumentIteratorImpl & | operator= (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... | |
| SdDrawDocument * | mpDocument |
| The document on whose data the iterator operates. More... | |
| std::weak_ptr< ViewShell > | mpViewShellWeak |
| 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 | ||
| ) |
Definition at line 689 of file OutlinerIterator.cxx.
References SdDrawDocument::GetMasterSdPageCount(), SdDrawDocument::GetSdPageCount(), mnPageCount, and Page.
Referenced by Clone().
◆ ~DocumentIteratorImpl()
|
overridevirtual |
Definition at line 704 of file OutlinerIterator.cxx.
Member Function Documentation
◆ Clone()
|
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()
|
overridevirtual |
Advance to the next text of the current object or to the next object.
This takes the iteration direction into account. The new object pointed to can be retrieved (among other information) by calling the <member>GetPosition</member> method.
Reimplemented from sd::outliner::ViewIteratorImpl.
Definition at line 718 of file OutlinerIterator.cxx.
References SdDrawDocument::GetMasterSdPageCount(), SdDrawDocument::GetSdPageCount(), sd::outliner::ViewIteratorImpl::GotoNextText(), Handout, sd::outliner::IteratorImplBase::maPosition, MasterPage, sd::outliner::IteratorImplBase::mbDirectionIsForward, sd::outliner::IteratorPosition::meEditMode, sd::outliner::IteratorPosition::mePageKind, mnPageCount, sd::outliner::IteratorPosition::mnPageIndex, sd::outliner::IteratorImplBase::mpDocument, Notes, Page, sd::outliner::ViewIteratorImpl::SetPage(), and Standard.
◆ operator=()
|
privatedelete |
Member Data Documentation
◆ 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:
