shape.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 .
 */
 
#ifndef INCLUDED_SLIDESHOW_SOURCE_INC_SHAPE_HXX
#define INCLUDED_SLIDESHOW_SOURCE_INC_SHAPE_HXX
 
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/drawing/XShape.hpp>
 
#include <basegfx/range/b2drectangle.hxx>
 
#include "viewlayer.hxx"
 
#include <memory>
#include <set>
 
namespace basegfx {
    class B2DRange;
}
 
namespace slideshow::internal
    {
        // forward declaration necessary, because methods use ShapeSharedPtr
        class Shape;
 
        typedef ::std::shared_ptr< Shape > ShapeSharedPtr;
 
        class Shape
        {
        public:
            Shape() : mbIsForeground(true) {}
            virtual ~Shape() {}
            Shape(const Shape&) = delete;
            Shape& operator=(const Shape&) = delete;
 
            virtual css::uno::Reference< css::drawing::XShape > getXShape() const = 0;
 
 
            // View layer methods
 
 
            virtual void addViewLayer( const ViewLayerSharedPtr&    rNewLayer,
                                       bool                         bRedrawLayer ) = 0;
 
            virtual bool removeViewLayer( const ViewLayerSharedPtr& rNewLayer ) = 0;
 
            virtual void clearAllViewLayers() = 0;
 
            // render methods
 
 
            virtual bool update() const = 0;
 
            virtual bool render() const = 0;
 
            virtual bool isContentChanged() const = 0;
 
 
            // Shape attributes
 
 
            virtual ::basegfx::B2DRectangle getBounds() const = 0;
 
            virtual ::basegfx::B2DRectangle getDomBounds() const = 0;
 
            virtual ::basegfx::B2DRectangle getUpdateArea() const = 0;
 
            virtual bool isVisible() const = 0;
 
            virtual double getPriority() const = 0;
 
            virtual bool isBackgroundDetached() const = 0;
 
            virtual bool isForeground() const { return mbIsForeground; };
 
            virtual void setIsForeground( const bool bIsForeground ) { mbIsForeground = bIsForeground; };
 
            // Misc
 
 
            struct lessThanShape
            {
                // make functor adaptable (to boost::bind)
                typedef bool result_type;
 
                // since the ZOrder property on the XShape has somewhat
                // peculiar attributes (it's basically the index of the shapes
                // in the drawing layer's SdrObjList - which means, it starts
                // from 0 for children of group objects), we cannot use it to determine
                // drawing order. Thus, we rely on importer-provided order values here,
                // which is basically a running counter during shape import (i.e. denotes
                // the order of shape import). This is the correct order, at least for the
                // current drawing core.
 
                // If, someday, the above proposition is no longer true, one directly use
                // the shape's ZOrder property
 
                static bool compare(const Shape* pLHS, const Shape* pRHS)
                {
                    const double nPrioL( pLHS->getPriority() );
                    const double nPrioR( pRHS->getPriority() );
 
                    // if prios are equal, tie-break on ptr value
                    return nPrioL == nPrioR ? pLHS < pRHS : nPrioL < nPrioR;
                }
 
                bool operator()(const ShapeSharedPtr& rLHS, const ShapeSharedPtr& rRHS) const
                {
                    return compare(rLHS.get(),rRHS.get());
                }
 
            };
 
        private:
            bool mbIsForeground;
        };
 
        typedef ::std::set< ShapeSharedPtr, Shape::lessThanShape >  ShapeSet;
 
}
 
#endif // INCLUDED_SLIDESHOW_SOURCE_INC_SHAPE_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */