/* -*- 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 <base/sprite.hxx>

class OutputDevice;

namespace vclcanvas

{

    /** Specialization of ::canvas::Sprite interface, to also provide

        redraw methods.

     */

    class Sprite : public ::canvas::Sprite

    {

    public:

        /** Redraw sprite at the stored position.

            @param bBufferedUpdate

            When true, the redraw does <em>not</em> happen directly on

            the front buffer, but within a VDev. Used to speed up

            drawing.

         */

        virtual void redraw( OutputDevice& rOutDev,

                             bool          bBufferedUpdate ) const = 0;

        /** Redraw sprite at the given position.

            @param rPos

            Output position of the sprite. Overrides the sprite's own

            output position.

            @param bBufferedUpdate

            When true, the redraw does <em>not</em> happen directly on

            the front buffer, but within a VDev. Used to speed up

            drawing.

         */

        virtual void redraw( OutputDevice&              rOutDev,

                             const ::basegfx::B2DPoint& rPos,

                             bool                       bBufferedUpdate ) const = 0;

    protected:

        ~Sprite() {}

    };

}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */