MasterPageContainer.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 <vcl/image.hxx>
 
#include <memory>
 
class SdPage;
 
namespace sd::sidebar
{
class MasterPageDescriptor;
class MasterPageContainerChangeEvent;
 
class MasterPageContainer final
{
public:
    typedef int Token;
    static const Token NIL_TOKEN = -1;
 
    MasterPageContainer();
    ~MasterPageContainer();
 
    void AddChangeListener(const Link<MasterPageContainerChangeEvent&, void>& rLink);
    void RemoveChangeListener(const Link<MasterPageContainerChangeEvent&, void>& rLink);
 
    enum PreviewSize
    {
        SMALL,
        LARGE
    };
    void SetPreviewSize(PreviewSize eSize);
 
    PreviewSize GetPreviewSize() const { return mePreviewSize; }
 
    Size const& GetPreviewSizePixel() const;
 
    enum PreviewState
    {
        PS_AVAILABLE,
        PS_CREATABLE,
        PS_PREPARING,
        PS_NOT_AVAILABLE
    };
    PreviewState GetPreviewState(Token aToken);
 
    bool RequestPreview(Token aToken);
 
    enum Origin
    {
        MASTERPAGE, // Master page of a document.
        TEMPLATE, // First page of a template file.
        DEFAULT, // Empty master page with default style.
        UNKNOWN
    };
 
    Token PutMasterPage(const std::shared_ptr<MasterPageDescriptor>& rDescriptor);
    void AcquireToken(Token aToken);
    void ReleaseToken(Token aToken);
 
    int GetTokenCount() const;
 
    bool HasToken(Token aToken) const;
 
    Token GetTokenForIndex(int nIndex);
 
    Token GetTokenForURL(const OUString& sURL);
    Token GetTokenForStyleName(const OUString& sStyleName);
    Token GetTokenForPageObject(const SdPage* pPage);
 
    OUString GetURLForToken(Token aToken);
    OUString GetPageNameForToken(Token aToken);
    OUString GetStyleNameForToken(Token aToken);
    SdPage* GetPageObjectForToken(Token aToken, bool bLoad);
    Origin GetOriginForToken(Token aToken);
    sal_Int32 GetTemplateIndexForToken(Token aToken);
    std::shared_ptr<MasterPageDescriptor> GetDescriptorForToken(Token aToken);
 
    void InvalidatePreview(Token aToken);
 
    Image GetPreviewForToken(Token aToken);
 
private:
    class Implementation;
    std::shared_ptr<Implementation> mpImpl;
    PreviewSize mePreviewSize;
};
 
class MasterPageContainerChangeEvent
{
public:
    enum class EventType
    {
        // A master page was added to the container.
        CHILD_ADDED,
        // A master page was removed from the container.
        CHILD_REMOVED,
        // The preview of a master page has changed.
        PREVIEW_CHANGED,
        // The size of a preview has changed.
        SIZE_CHANGED,
        // Some of the data stored for a master page has changed.
        DATA_CHANGED,
        // The TemplateIndex of a master page has changed.
        INDEX_CHANGED,
    } meEventType;
 
    // Token of the container entry whose data changed or which was added or
    // removed.
    MasterPageContainer::Token maChildToken;
};
 
} // end of namespace sd::sidebar
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */