OutlinerIterator.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#pragma once
 
#include <svx/svdobj.hxx>
 
#include "pres.hxx"
#include <sal/types.h>
#include <memory>
#include <vector>
 
class SdDrawDocument;
class SdOutliner;
 
namespace sd {
 
class ViewShell;
 
namespace outliner {
 
class IteratorImplBase;
class IteratorPosition;
 
enum IteratorLocation {BEGIN,END,CURRENT};
 
class Iterator
{
public:
    Iterator();
 
    Iterator (const Iterator& rIterator);
    Iterator(Iterator&& rIterator) noexcept;
 
    explicit Iterator (std::unique_ptr<IteratorImplBase> pObject);
 
    ~Iterator();
 
    Iterator& operator= (const Iterator& rIterator);
    Iterator& operator=(Iterator&& rIterator) noexcept;
 
    const IteratorPosition& operator* () const;
    Iterator& operator++ ();
    bool operator== (const Iterator& rIterator) const;
    bool operator!= (const Iterator& rIterator) const;
    void Reverse();
 
private:
    std::unique_ptr<IteratorImplBase> mxIterator;
};
 
class OutlinerContainer
{
public:
    OutlinerContainer (SdOutliner* pOutliner);
 
    Iterator begin();
 
    Iterator end();
 
    Iterator current();
 
private:
    SdOutliner* mpOutliner;
 
    Iterator CreateIterator (IteratorLocation aLocation);
 
    static Iterator CreateSelectionIterator (
        const ::std::vector<::unotools::WeakReference<SdrObject>>& rObjectList,
        SdDrawDocument* pDocument,
        const std::shared_ptr<ViewShell>& rpViewShell,
        bool bDirectionIsForward,
        IteratorLocation aLocation);
 
    static Iterator CreateDocumentIterator (
        SdDrawDocument* pDocument,
        const std::shared_ptr<ViewShell>& rpViewShell,
        bool bDirectionIsForward,
        IteratorLocation aLocation);
 
    static sal_Int32 GetPageIndex (
        SdDrawDocument const * pDocument,
        const std::shared_ptr<ViewShell>& rpViewShell,
        PageKind ePageKind,
        EditMode eEditMode,
        bool bDirectionIsForward,
        IteratorLocation aLocation);
 
    // Do not allow default constructor and copying of outliner containers.
    OutlinerContainer (const OutlinerContainer&) = delete;
    OutlinerContainer& operator= (const OutlinerContainer&) = delete;
};
 
class IteratorPosition
{
public:
    IteratorPosition();
 
    bool operator== (const IteratorPosition& aPosition) const;
 
    ::unotools::WeakReference<SdrObject> mxObject;
 
    sal_Int32 mnText;
 
    sal_Int32 mnPageIndex;
    PageKind mePageKind;
    EditMode meEditMode;
};
 
} } // end of namespace ::sd::outliner
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */