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
|
/* -*- 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 <sal/types.h>
namespace rtl
{
class OString;
class OStringBuffer;
}
namespace tools
{
class Rectangle;
}
// An extended callback type that allows passing in also some binary data,
// so that post-processing the messages does not require conversions
// from and to strings.
// TODO: It might possibly make sense to drop the generic type/payload function
// and have only a dedicated function for each message type?
class SAL_NO_VTABLE SAL_DLLPUBLIC_RTTI SfxLokCallbackInterface
{
public:
virtual ~SfxLokCallbackInterface() {}
// LibreOfficeKitCallback equivalent.
virtual void libreOfficeKitViewCallback(int nType, const rtl::OString& pPayload) = 0;
// Callback that explicitly provides view id (which is also included in the payload).
virtual void libreOfficeKitViewCallbackWithViewId(int nType, const rtl::OString& pPayload,
int nViewId)
= 0;
// LOK_CALLBACK_INVALIDATE_TILES
// nPart is either part, -1 for all-parts, or INT_MIN if
// comphelper::LibreOfficeKit::isPartInInvalidation() is not set
virtual void libreOfficeKitViewInvalidateTilesCallback(const tools::Rectangle* pRect, int nPart,
int nMode)
= 0;
// A message of the given type should be sent, for performance purpose only a notification
// is given here, details about the message should be queried from SfxViewShell when necessary.
// This is used for messages that are generated often but only the last one is needed.
virtual void libreOfficeKitViewUpdatedCallback(int nType) = 0;
// Like libreOfficeKitViewUpdatedCallback(), but a last message is needed for each nViewId value.
// SfxViewShell:getLOKPayload() will be called on nSourceViewId view.
virtual void libreOfficeKitViewUpdatedCallbackPerViewId(int nType, int nViewId,
int nSourceViewId)
= 0;
// There are pending invalidate tiles calls that need to be processed.
// A call to SfxViewShell::flushPendingLOKInvalidateTiles() should be scheduled.
virtual void libreOfficeKitViewAddPendingInvalidateTiles() = 0;
virtual void dumpState(rtl::OStringBuffer& rState) = 0;
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
