1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/* -*- 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/.
*
*/
#ifndef INCLUDED_VCL_ITILEDRENDERABLE_HXX
#define INCLUDED_VCL_ITILEDRENDERABLE_HXX
#define LOK_USE_UNSTABLE_API
#include <LibreOfficeKit/LibreOfficeKitTypes.h>
#include <tools/gen.hxx>
#include <vcl/virdev.hxx>
namespace vcl
{
class VCL_DLLPUBLIC ITiledRenderable
{
public:
virtual ~ITiledRenderable();
/**
* Paint a tile to a given VirtualDevice.
*
* Output parameters are measured in pixels, tile parameters are in
* twips.
*/
virtual void paintTile( VirtualDevice &rDevice,
int nOutputWidth,
int nOutputHeight,
int nTilePosX,
int nTilePosY,
long nTileWidth,
long nTileHeight ) = 0;
/**
* Get the document size in twips.
*/
virtual Size getDocumentSize() = 0;
/**
* Set the document "part", i.e. slide for a slideshow, and
* tab for a spreadsheet.
*/
virtual void setPart( int nPart )
{
(void) nPart;
}
/**
* Get the number of parts -- see setPart for further details.
*/
virtual int getParts()
{
return 1;
}
/**
* Get the currently displayed/selected part -- see setPart for further
* details.
*/
virtual int getPart()
{
return 0;
}
/**
* Get the name of the currently displayed part, i.e. sheet in a spreadsheet
* or slide in a presentation.
*/
virtual OUString getPartName(int nPart)
{
(void) nPart;
return OUString("");
}
/// @see lok::Document::setPartMode().
virtual void setPartMode(int nPartMode)
{
(void) nPartMode;
}
/**
* Setup various document properties that are needed for the document to
* be renderable via tiled rendering.
*/
virtual void initializeForTiledRendering() = 0;
/**
* Registers a callback that will be invoked whenever the tiled renderer
* wants to notify the client about an event.
*
* @param pCallBack is the callback function
* @param pData is private data of the client that will be sent back when the callback is invoked
*/
virtual void registerCallback(LibreOfficeKitCallback pCallback, void* pData) = 0;
/**
* Posts a keyboard event on the document.
*
* @see lok::Document::postKeyEvent().
*/
virtual void postKeyEvent(int nType, int nCharCode, int nKeyCode) = 0;
/**
* Posts a mouse event on the document.
*
* @see lok::Document::postMouseEvent().
*/
virtual void postMouseEvent(int nType, int nX, int nY, int nCount, int nButtons, int nModifier) = 0;
/**
* Sets the start or end of a text selection.
*
* @see lok::Document::setTextSelection().
*/
virtual void setTextSelection(int nType, int nX, int nY) = 0;
/**
* Gets the text selection.
*
* @see lok::Document::getTextSelection().
*/
virtual OString getTextSelection(const char* pMimeType, OString& rUsedMimeType) = 0;
/**
* Adjusts the graphic selection.
*
* @see lok::Document::setGraphicSelection().
*/
virtual void setGraphicSelection(int nType, int nX, int nY) = 0;
/**
* @see lok::Document::resetSelection().
*/
virtual void resetSelection() = 0;
/**
* @see lok::Document::getPartPageRectangles().
*/
virtual OUString getPartPageRectangles()
{
return OUString();
}
/**
* Get position and content of row/column headers of Calc documents.
*
* @param rRectangle - if not empty, then limit the output only to the area of this rectangle
* @return a JSON describing position/content of rows/columns
*/
virtual OUString getRowColumnHeaders(const Rectangle& /*rRectangle*/)
{
return OUString();
}
/**
* Get position and size of cell cursor in Calc.
* (This could maybe also be used for tables in Writer/Impress in future?)
*/
virtual OString getCellCursor(int /*nOutputWidth*/,
int /*nOutputHeight*/,
long /*nTileWidth*/,
long /*nTileHeight*/)
{
return OString();
}
/// Sets the clipboard of the component.
virtual void setClipboard(const css::uno::Reference<css::datatransfer::clipboard::XClipboard>& xClipboard) = 0;
/// If the current contents of the clipboard is something we can paste.
virtual bool isMimeTypeSupported() = 0;
};
} // namespace vcl
#endif // INCLUDED_VCL_ITILEDRENDERABLE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
