ITiledRenderable.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/.
 *
 */
 
#pragma once
 
#include <tools/gen.hxx>
#include <rtl/ustring.hxx>
#include <vcl/dllapi.h>
#include <vcl/ptrstyle.hxx>
#include <vcl/vclptr.hxx>
#include <map>
#include <com/sun/star/datatransfer/XTransferable.hpp>
#include <basegfx/range/b2drange.hxx>
 
namespace com::sun::star::beans { struct PropertyValue; }
namespace com::sun::star::datatransfer::clipboard { class XClipboard; }
namespace com::sun::star::uno { template <class interface_type> class Reference; }
namespace com::sun::star::uno { template <typename > class Sequence; }
namespace vcl { class Window; }
namespace tools { class JsonWriter; }
 
class VirtualDevice;
 
namespace vcl
{
    /*
     * Map directly to css cursor styles to avoid further mapping in the client.
     * Gtk (via gdk_cursor_new_from_name) also supports the same css cursor styles.
     *
     * This was created partially with help of the mappings in gtkdata.cxx.
     * The list is incomplete as some cursor style simply aren't supported
     * by css, it might turn out to be worth mapping some of these missing cursors
     * to available cursors?
     */
    extern const std::map <PointerStyle, OString> gaLOKPointerMap;
 
 
class VCL_DLLPUBLIC SAL_LOPLUGIN_ANNOTATE("crosscast") ITiledRenderable
{
public:
 
    typedef std::map<OUString, OUString>  StringMap;
 
    virtual ~ITiledRenderable();
 
    virtual void paintTile( VirtualDevice &rDevice,
                            int nOutputWidth,
                            int nOutputHeight,
                            int nTilePosX,
                            int nTilePosY,
                            tools::Long nTileWidth,
                            tools::Long nTileHeight ) = 0;
 
    virtual Size getDocumentSize() = 0;
 
    virtual Size getDataArea(long /*nPart*/)
    {
        return Size(1, 1);
    }
 
    virtual void setPart( int /*nPart*/, bool /*bAllowChangeFocus*/ = true ) {}
 
    virtual int getParts()
    {
        return 1;
    }
 
    virtual int getPart()
    {
        return 0;
    }
 
    virtual OUString getPartName(int)
    {
        return OUString();
    }
 
    virtual VclPtr<vcl::Window> getDocWindow() = 0;
 
    virtual OUString getPartHash(int nPart) = 0;
 
    virtual void setPartMode(int) {}
 
    virtual int getEditMode()
    {
        return 0;
    }
 
    virtual void setEditMode(int) {}
 
    virtual void initializeForTiledRendering(const css::uno::Sequence<css::beans::PropertyValue>& rArguments) = 0;
 
    virtual void postKeyEvent(int nType, int nCharCode, int nKeyCode) = 0;
 
    virtual void postMouseEvent(int nType, int nX, int nY, int nCount, int nButtons, int nModifier) = 0;
 
    virtual void setTextSelection(int nType, int nX, int nY) = 0;
 
    virtual css::uno::Reference<css::datatransfer::XTransferable> getSelection() = 0;
 
    virtual void setGraphicSelection(int nType, int nX, int nY) = 0;
 
    virtual void resetSelection() = 0;
 
    virtual OUString getPartPageRectangles()
    {
        return OUString();
    }
 
    virtual void getRowColumnHeaders(const tools::Rectangle& /*rRectangle*/, tools::JsonWriter& /*rJsonWriter*/)
    {
    }
 
    virtual OString getSheetGeometryData(bool /*bColumns*/, bool /*bRows*/, bool /*bSizes*/,
                                         bool /*bHidden*/, bool /*bFiltered*/, bool /*bGroups*/)
    {
        return "";
    }
 
    virtual void getCellCursor(tools::JsonWriter& /*rJsonWriter*/)
    {
    }
 
    virtual PointerStyle getPointer() = 0;
 
    virtual void setClipboard(const css::uno::Reference<css::datatransfer::clipboard::XClipboard>& xClipboard) = 0;
 
    virtual bool isMimeTypeSupported() = 0;
 
    virtual void setClientZoom(int /*nTilePixelWidth*/,
                               int /*nTilePixelHeight*/,
                               int /*nTileTwipWidth*/,
                               int /*nTileTwipHeight*/)
    {}
 
    virtual void setClientVisibleArea(const tools::Rectangle& /*rRectangle*/)
    {
    }
 
    virtual void setOutlineState(bool /*bColumn*/, int /*nLevel*/, int /*nIndex*/, bool /*bHidden*/)
    {
        return;
    }
 
    virtual void getTrackedChanges(tools::JsonWriter&)
    {
    }
 
    virtual void getTrackedChangeAuthors(tools::JsonWriter& /*rJsonWriter*/)
    {
    }
 
    virtual void getPostIts(tools::JsonWriter& /*rJsonWriter*/)
    {
    }
 
    virtual void getPostItsPos(tools::JsonWriter& /*rJsonWriter*/)
    {
    }
 
    virtual void getRulerState(tools::JsonWriter& /*rJsonWriter*/)
    {
    }
 
    /*
     * Used for sheets in spreadsheet documents,
     * and slides in presentation documents.
     */
    virtual OUString getPartInfo(int /*nPart*/)
    {
        return OUString();
    }
 
    virtual void selectPart(int /*nPart*/, int /*nSelect*/) {}
 
    virtual void moveSelectedParts(int /*nPosition*/, bool /*bDuplicate*/) {}
 
    virtual void completeFunction(const OUString& /*rFunctionName*/)
    {
    }
 
    virtual bool isDisposed() const
    {
        return false;
    }
 
    virtual void executeFromFieldEvent(const StringMap&)
    {
    }
 
    virtual std::vector<basegfx::B2DRange> getSearchResultRectangles(const char* /*pPayload*/)
    {
        return std::vector<basegfx::B2DRange>();
    }
 
    virtual void executeContentControlEvent(const StringMap&) {}
 
    virtual void setPaintTextEdit(bool) {}
 
    virtual bool supportsCommand(std::u16string_view /*rCommand*/) { return false; }
 
    virtual void getCommandValues(tools::JsonWriter& /*rJsonWriter*/, std::string_view /*rCommand*/)
    {
    }
 
    virtual OString getViewRenderState() { return rtl::OString(); }
};
} // namespace vcl
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */