SlsGenericPageCache.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/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#pragma once
 
#include "SlsRequestQueue.hxx"
#include <memory>
 
#include <vcl/bitmapex.hxx>
 
namespace sd::slidesorter::cache {
 
class BitmapCache;
class QueueProcessor;
 
class GenericPageCache
{
public:
    GenericPageCache (
        const Size& rPreviewSize,
        const bool bDoSuperSampling,
        const SharedCacheContext& rpCacheContext);
 
    ~GenericPageCache();
 
    void ChangePreviewSize (
        const Size& rPreviewSize,
        const bool bDoSuperSampling);
 
    BitmapEx GetPreviewBitmap (
        const CacheKey aKey,
        const bool bResize);
    BitmapEx GetMarkedPreviewBitmap (
        const CacheKey aKey);
    void SetMarkedPreviewBitmap (
        const CacheKey aKey,
        const BitmapEx& rMarkedBitmap);
 
    void RequestPreviewBitmap (
        const CacheKey aKey,
        const bool bMayBeUpToDate);
 
    bool InvalidatePreviewBitmap (const CacheKey aKey);
 
    void InvalidateCache ();
 
    void SetPreciousFlag (const CacheKey aKey, const bool bIsPrecious);
 
    void Pause();
    void Resume();
 
private:
    std::shared_ptr<BitmapCache> mpBitmapCache;
 
    RequestQueue maRequestQueue;
 
    std::unique_ptr<QueueProcessor> mpQueueProcessor;
 
    SharedCacheContext mpCacheContext;
 
    Size maPreviewSize;
 
    bool mbDoSuperSampling;
 
    void ProvideCacheAndProcessor();
};
 
} // end of namespace ::sd::slidesorter::cache
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */