MasterPageDescriptor.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 <memory>
 
namespace sd { class PreviewRenderer; }
class SdDrawDocument;
 
namespace sd::sidebar {
 
class PageObjectProvider;
class PreviewProvider;
 
class MasterPageDescriptor;
typedef std::shared_ptr<MasterPageDescriptor> SharedMasterPageDescriptor;
 
class MasterPageDescriptor
{
public:
    MasterPageDescriptor (
        MasterPageContainer::Origin eOrigin,
        const sal_Int32 nTemplateIndex,
        std::u16string_view rURL,
        OUString sPageName,
        OUString sStyleName,
        const bool bIsPrecious,
        std::shared_ptr<PageObjectProvider> pPageObjectProvider,
        std::shared_ptr<PreviewProvider> pPreviewProvider);
 
    void SetToken (MasterPageContainer::Token aToken);
 
    ::std::unique_ptr<std::vector<MasterPageContainerChangeEvent::EventType> >
        Update (
            const MasterPageDescriptor& rDescriptor);
 
    const Image& GetPreview (MasterPageContainer::PreviewSize ePreviewSize) const;
 
    bool UpdatePreview (
        sal_Int32 nCostThreshold,
        const Size& rSmallSize,
        const Size& rLargeSize,
        ::sd::PreviewRenderer& rRenderer);
 
    int UpdatePageObject (
        sal_Int32 nCostThreshold,
        SdDrawDocument* pDocument);
 
    enum URLClassification {
        URLCLASS_USER,
        URLCLASS_LAYOUT,
        URLCLASS_PRESENTATION,
        URLCLASS_OTHER,
        URLCLASS_UNKNOWN,
        URLCLASS_UNDETERMINED
    };
 
    URLClassification GetURLClassification();
 
    MasterPageContainer::Token maToken;
 
    MasterPageContainer::Origin meOrigin;
 
    OUString msURL;
 
    OUString msPageName;
 
    OUString msStyleName;
 
    const bool mbIsPrecious;
 
    SdPage* mpMasterPage;
 
    SdPage* mpSlide;
 
    Image maSmallPreview;
 
    Image maLargePreview;
 
    std::shared_ptr<PreviewProvider> mpPreviewProvider;
 
    std::shared_ptr<PageObjectProvider> mpPageObjectProvider;
 
    sal_Int32 mnTemplateIndex;
 
    URLClassification meURLClassification;
 
    sal_Int32 mnUseCount;
 
    class URLComparator { public:
        OUString msURL;
        explicit URLComparator (OUString sURL);
        bool operator() (const SharedMasterPageDescriptor& rDescriptor);
    };
    class StyleNameComparator { public:
        OUString msStyleName;
        explicit StyleNameComparator (OUString sStyleName);
        bool operator() (const SharedMasterPageDescriptor& rDescriptor);
    };
    class PageObjectComparator { public:
        const SdPage* mpMasterPage;
        explicit PageObjectComparator (const SdPage* pPageObject);
        bool operator() (const SharedMasterPageDescriptor& rDescriptor);
    };
    class AllComparator { public:
        explicit AllComparator(SharedMasterPageDescriptor aDescriptor);
        bool operator() (const SharedMasterPageDescriptor& rDescriptor);
    private:
        SharedMasterPageDescriptor mpDescriptor;
    };
 
};
 
} // end of namespace sd::sidebar
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */