LibreOffice Module sd (master) 1
SlsCacheContext.hxx
Go to the documentation of this file.
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 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#pragma once
21
22#include <sal/types.h>
23#include <com/sun/star/uno/Reference.hxx>
24#include <memory>
25#include <vector>
26
27namespace com::sun::star::uno
28{
29class XInterface;
30}
31
32class SdrPage;
33
35{
36typedef const SdrPage* CacheKey;
37
42{
43public:
44 virtual ~CacheContext() {}
45
51 virtual void NotifyPreviewCreation(CacheKey aKey) = 0;
52
56 virtual bool IsIdle() = 0;
57
62 virtual bool IsVisible(CacheKey aKey) = 0;
63
68 virtual const SdrPage* GetPage(CacheKey aKey) = 0;
69
78 virtual std::shared_ptr<std::vector<CacheKey>> GetEntryList(bool bVisible) = 0;
79
84 virtual sal_Int32 GetPriority(CacheKey aKey) = 0;
85
91 virtual css::uno::Reference<css::uno::XInterface> GetModel() = 0;
92};
93
94typedef std::shared_ptr<CacheContext> SharedCacheContext;
95
96} // end of namespace ::sd::slidesorter::cache
97
98/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
This interface allows the individualisation of different instances of the PreviewCache.
virtual const SdrPage * GetPage(CacheKey aKey)=0
Return the page associated with the given key.
virtual bool IsVisible(CacheKey aKey)=0
This method is used to determine whether a page is currently visible or not.
virtual std::shared_ptr< std::vector< CacheKey > > GetEntryList(bool bVisible)=0
This method is used when the request queue is filled.
virtual void NotifyPreviewCreation(CacheKey aKey)=0
This method is called when the asynchronous creation of a preview has been finished.
virtual css::uno::Reference< css::uno::XInterface > GetModel()=0
Return the model to which the pages belong for which the called cache manages the previews.
virtual sal_Int32 GetPriority(CacheKey aKey)=0
Return the priority that defines the order in which previews are created for different keys/pages.
virtual bool IsIdle()=0
Called to determine whether the system is idle and a preview can be created without annoying the user...
const SdrPage * CacheKey
std::shared_ptr< CacheContext > SharedCacheContext