include/vcl/ITiledRenderable.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  */
  10
  11 #ifndef INCLUDED_VCL_ITILEDRENDERABLE_HXX
  12 #define INCLUDED_VCL_ITILEDRENDERABLE_HXX
  13
  14 #include <tools/gen.hxx>
  15 #include <rtl/ustring.hxx>
  16 #include <vcl/dllapi.h>
  17 #include <vcl/ptrstyle.hxx>
  18 #include <vcl/vclptr.hxx>
  19 #include <map>
  20 #include <com/sun/star/datatransfer/XTransferable.hpp>
  21
  22 namespace com::sun::star::beans { struct PropertyValue; }
  23 namespace com::sun::star::datatransfer { namespace clipboard { class XClipboard; } }
  24 namespace com::sun::star::uno { template <class interface_type> class Reference; }
  25 namespace com::sun::star::uno { template <typename > class Sequence; }
  26 namespace vcl { class Window; }
  27 namespace tools { class JsonWriter; }
  28
  29 class VirtualDevice;
  30
  31 namespace vcl
  32 {
  33     /*
  34      * Map directly to css cursor styles to avoid further mapping in the client.
  35      * Gtk (via gdk_cursor_new_from_name) also supports the same css cursor styles.
  36      *
  37      * This was created partially with help of the mappings in gtkdata.cxx.
  38      * The list is incomplete as some cursor style simply aren't supported
  39      * by css, it might turn out to be worth mapping some of these missing cursors
  40      * to available cursors?
  41      */
  42     extern const std::map <PointerStyle, OString> gaLOKPointerMap;
  43
  44
  45 class VCL_DLLPUBLIC ITiledRenderable
  46 {
  47 public:
  48
  49     typedef std::map<const OUString, OUString>  StringMap;
  50
  51     virtual ~ITiledRenderable();
  52
  53     /**
  54      * Paint a tile to a given VirtualDevice.
  55      *
  56      * Output parameters are measured in pixels, tile parameters are in
  57      * twips.
  58      */
  59     virtual void paintTile( VirtualDevice &rDevice,
  60                             int nOutputWidth,
  61                             int nOutputHeight,
  62                             int nTilePosX,
  63                             int nTilePosY,
  64                             long nTileWidth,
  65                             long nTileHeight ) = 0;
  66
  67     /**
  68      * Get the document size in twips.
  69      */
  70     virtual Size getDocumentSize() = 0;
  71
  72     /**
  73      * Set the document "part", i.e. slide for a slideshow, and
  74      * tab for a spreadsheet.
  75      */
  76     virtual void setPart( int ) {}
  77
  78     /**
  79      * Get the number of parts -- see setPart for further details.
  80      */
  81     virtual int getParts()
  82     {
  83         return 1;
  84     }
  85
  86     /**
  87      * Get the currently displayed/selected part -- see setPart for further
  88      * details.
  89      */
  90     virtual int getPart()
  91     {
  92         return 0;
  93     }
  94
  95     /**
  96      * Get the name of the currently displayed part, i.e. sheet in a spreadsheet
  97      * or slide in a presentation.
  98      */
  99     virtual OUString getPartName(int)
 100     {
 101         return OUString();
 102     }
 103
 104     /**
 105      * Get the vcl::Window for the document being edited
 106      */
 107     virtual VclPtr<vcl::Window> getDocWindow() = 0;
 108
 109     /**
 110      * Get the hash of the currently displayed part, i.e. sheet in a spreadsheet
 111      * or slide in a presentation.
 112      */
 113     virtual OUString getPartHash(int nPart) = 0;
 114
 115     /// @see lok::Document::setPartMode().
 116     virtual void setPartMode(int) {}
 117
 118     /**
 119      * Setup various document properties that are needed for the document to
 120      * be renderable via tiled rendering.
 121      */
 122     virtual void initializeForTiledRendering(const css::uno::Sequence<css::beans::PropertyValue>& rArguments) = 0;
 123
 124     /**
 125      * Posts a keyboard event on the document.
 126      *
 127      * @see lok::Document::postKeyEvent().
 128      */
 129     virtual void postKeyEvent(int nType, int nCharCode, int nKeyCode) = 0;
 130
 131     /**
 132      * Posts a mouse event on the document.
 133      *
 134      * @see lok::Document::postMouseEvent().
 135      */
 136     virtual void postMouseEvent(int nType, int nX, int nY, int nCount, int nButtons, int nModifier) = 0;
 137
 138     /**
 139      * Sets the start or end of a text selection.
 140      *
 141      * @see lok::Document::setTextSelection().
 142      */
 143     virtual void setTextSelection(int nType, int nX, int nY) = 0;
 144
 145     /**
 146      * Gets the selection as a transferable for later processing
 147      */
 148     virtual css::uno::Reference<css::datatransfer::XTransferable> getSelection() = 0;
 149
 150     /**
 151      * Adjusts the graphic selection.
 152      *
 153      * @see lok::Document::setGraphicSelection().
 154      */
 155     virtual void setGraphicSelection(int nType, int nX, int nY) = 0;
 156
 157     /**
 158      * @see lok::Document::resetSelection().
 159      */
 160     virtual void resetSelection() = 0;
 161
 162     /**
 163      * @see lok::Document::getPartPageRectangles().
 164      */
 165     virtual OUString getPartPageRectangles()
 166     {
 167         return OUString();
 168     }
 169
 170     /**
 171      * Get position and content of row/column headers of Calc documents.
 172      *
 173      * @param rRectangle - if not empty, then limit the output only to the area of this rectangle
 174      * @return a JSON describing position/content of rows/columns
 175      */
 176     virtual OUString getRowColumnHeaders(const tools::Rectangle& /*rRectangle*/)
 177     {
 178         return OUString();
 179     }
 180
 181     /**
 182      * Generates a serialization of the active (Calc document) sheet's geometry data.
 183      *
 184      * @param bColumns - if true, the column widths/hidden/filtered/groups data
 185      *     are included depending on the settings of the flags bSizes, bHidden,
 186      *     bFiltered and bGroups.
 187      * @param bRows - if true, the row heights/hidden/filtered/groups data
 188      *     are included depending on the settings of the flags bSizes, bHidden,
 189      *     bFiltered and bGroups.
 190      * @bSizes - if true, the column-widths and/or row-heights data (represented as a list of spans)
 191      *     are included depending on the settings of the flags bColumns and bRows.
 192      * @bHidden - if true, the hidden columns and/or rows data (represented as a list of spans)
 193      *     are included depending on the settings of the flags bColumns and bRows.
 194      * @bFiltered - if true, the filtered columns and/or rows data (represented as a list of spans)
 195      *     are included depending on the settings of the flags bColumns and bRows.
 196      * @bGroups - if true, the column grouping and/or row grouping data
 197      *     are included depending on the settings of the flags bColumns and bRows.
 198      * @return serialization of the active sheet's geometry data as OString.
 199      */
 200     virtual OString getSheetGeometryData(bool /*bColumns*/, bool /*bRows*/, bool /*bSizes*/,
 201                                          bool /*bHidden*/, bool /*bFiltered*/, bool /*bGroups*/)
 202     {
 203         return "";
 204     }
 205
 206     /**
 207      * Get position and size of cell cursor in Calc - as JSON in the
 208      * current' views' co-ordinate system.
 209      * (This could maybe also be used for tables in Writer/Impress in future?)
 210      */
 211     virtual OString getCellCursor()
 212     {
 213         return OString();
 214     }
 215
 216     virtual PointerStyle getPointer() = 0;
 217
 218     /// Sets the clipboard of the component.
 219     virtual void setClipboard(const css::uno::Reference<css::datatransfer::clipboard::XClipboard>& xClipboard) = 0;
 220
 221     /// If the current contents of the clipboard is something we can paste.
 222     virtual bool isMimeTypeSupported() = 0;
 223
 224     /**
 225      * Save the client's view so that we can compute the right zoom level
 226      * for the mouse events.
 227      * @param nTilePixelWidth - tile width in pixels
 228      * @param nTilePixelHeight - tile height in pixels
 229      * @param nTileTwipWidth - tile width in twips
 230      * @param nTileTwipHeight - tile height in twips
 231      */
 232     virtual void setClientZoom(int /*nTilePixelWidth*/,
 233                                int /*nTilePixelHeight*/,
 234                                int /*nTileTwipWidth*/,
 235                                int /*nTileTwipHeight*/)
 236     {}
 237
 238     /// @see lok::Document::setClientVisibleArea().
 239     virtual void setClientVisibleArea(const tools::Rectangle& /*rRectangle*/)
 240     {
 241     }
 242
 243     /**
 244      * Show/Hide a single row/column header outline for Calc documents.
 245      *
 246      * @param bColumn - if we are dealing with a column or row group
 247      * @param nLevel - the level to which the group belongs
 248      * @param nIndex - the group entry index
 249      * @param bHidden - the new group state (collapsed/expanded)
 250      */
 251     virtual void setOutlineState(bool /*bColumn*/, int /*nLevel*/, int /*nIndex*/, bool /*bHidden*/)
 252     {
 253         return;
 254     }
 255
 256     /// Implementation for
 257     /// lok::Document::getCommandValues(".uno:AcceptTrackedChanges") when there
 258     /// is no matching UNO API.
 259     virtual void getTrackedChanges(tools::JsonWriter&)
 260     {
 261     }
 262
 263     /// Implementation for
 264     /// lok::Document::getCommandValues(".uno:TrackedChangeAuthors").
 265     virtual OUString getTrackedChangeAuthors()
 266     {
 267         return OUString();
 268     }
 269
 270     /// Implementation for
 271     /// lok::Document::getCommandValues(".uno:ViewAnnotations");
 272     virtual OUString getPostIts()
 273     {
 274         return OUString();
 275     }
 276
 277     /// Implementation for
 278     /// lok::Document::getCommandValues(".uno:ViewAnnotationsPosition");
 279     virtual OUString getPostItsPos()
 280     {
 281         return OUString();
 282     }
 283
 284     /// Implementation for
 285     /// lok::Document::getCommandValues(".uno:RulerState");
 286     virtual OUString getRulerState()
 287     {
 288         return OUString();
 289     }
 290
 291     /*
 292      * Used for sheets in spreadsheet documents,
 293      * and slides in presentation documents.
 294      */
 295     virtual OUString getPartInfo(int /*nPart*/)
 296     {
 297         return OUString();
 298     }
 299
 300     /**
 301      * Select/Unselect a document "part", i.e. slide for a slideshow, and
 302      * tab for a spreadsheet(?).
 303      * nSelect: 0 to deselect, 1 to select, and 2 to toggle.
 304      */
 305     virtual void selectPart(int /*nPart*/, int /*nSelect*/) {}
 306
 307     /**
 308      * Move selected pages/slides to a new position.
 309      * nPosition: the new position to move to.
 310      * bDuplicate: to copy (true), or to move (false).
 311      */
 312     virtual void moveSelectedParts(int /*nPosition*/, bool /*bDuplicate*/) {}
 313
 314     /// @see lok::Document::completeFunction().
 315     virtual void completeFunction(const OUString& /*rFunctionName*/)
 316     {
 317     }
 318
 319     /**
 320      * Execute a form field event in the document.
 321      * E.g. select an item from a drop down field's list.
 322      */
 323     virtual void executeFromFieldEvent(const StringMap&)
 324     {
 325     }
 326
 327     /**
 328      * It can happen that the underlying implementation is being disposed, but
 329      * somebedy is trying to access the data...
 330      */
 331     virtual bool isDisposed() const
 332     {
 333         return false;
 334     }
 335 };
 336 } // namespace vcl
 337
 338 #endif // INCLUDED_VCL_ITILEDRENDERABLE_HXX
 339
 340 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */