MasterPageContainerQueue.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 "MasterPageContainer.hxx"
#include "MasterPageDescriptor.hxx"
 
#include <vcl/timer.hxx>
 
#include <memory>
 
namespace sd::sidebar {
 
class MasterPageContainerQueue final
{
public:
    class ContainerAdapter {
    public:
        virtual bool UpdateDescriptor (
            const SharedMasterPageDescriptor& rpDescriptor,
            bool bForcePageObject,
            bool bForcePreview,
            bool bSendEvents) = 0;
 
    protected:
        ~ContainerAdapter() {}
    };
 
    static MasterPageContainerQueue* Create (
        const std::weak_ptr<ContainerAdapter>& rpContainer);
    ~MasterPageContainerQueue();
 
    bool RequestPreview (const SharedMasterPageDescriptor& rDescriptor);
 
    bool HasRequest (MasterPageContainer::Token aToken) const;
 
    bool IsEmpty() const;
 
    void ProcessAllRequests();
 
private:
    std::weak_ptr<ContainerAdapter> mpWeakContainer;
    class PreviewCreationRequest;
    class RequestQueue;
    std::unique_ptr<RequestQueue> mpRequestQueue;
    Timer maDelayedPreviewCreationTimer;
    sal_uInt32 mnRequestsServedCount;
 
    // There are a couple of values that define various aspects of the
    // heuristic that defines the order and timing in which requests for
    // preview creation are processed.
 
    static const sal_Int32 snDelayedCreationTimeout;
 
    static const sal_Int32 snDelayedCreationTimeoutWhenNotIdle;
 
    static const sal_Int32 snMasterPagePriorityBoost;
 
    static const sal_Int32 snWaitForMoreRequestsPriorityThreshold;
 
    static sal_uInt32 snWaitForMoreRequestsCount;
 
    explicit MasterPageContainerQueue (std::weak_ptr<ContainerAdapter> pContainer);
    void LateInit();
 
    static sal_Int32 CalculatePriority (const SharedMasterPageDescriptor& rDescriptor);
 
    DECL_LINK(DelayedPreviewCreation, Timer *, void);
};
 
} // end of namespace sd::sidebar
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */