/* -*- 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 "framework/AbstractResource.hxx"

#include "framework/ConfigurationChangeListener.hxx"

#include <ResourceId.hxx>

#include <comphelper/compbase.hxx>

#include <vcl/InterimItemWindow.hxx>

#include <vcl/weld/Notebook.hxx>

#include <vector>

namespace vcl { class Window; }

namespace sd {

    class DrawController;

    class ViewShellBase;

    class ViewTabBar;

}

namespace sd::framework { class ConfigurationController; }

namespace sd::framework { class ResourceId; }

namespace sd {

class TabBarControl final : public InterimItemWindow

{

public:

    TabBarControl(vcl::Window* pParentWindow, ::rtl::Reference<ViewTabBar> pViewTabBar);

    virtual void dispose() override;

    virtual ~TabBarControl() override;

    weld::Notebook& GetNotebook() { return *mxTabControl; }

    int GetAllocatedWidth() const { return mnAllocatedWidth; }

private:

    std::unique_ptr<weld::Notebook> mxTabControl;

    ::rtl::Reference<ViewTabBar> mpViewTabBar;

    int mnAllocatedWidth;

    DECL_LINK(ActivatePageHdl, const OUString&, void);

    DECL_LINK(NotebookSizeAllocHdl, const Size&, void);

};

/** Descriptor of a tab bar button.  Tab bar buttons are typically used to

    offer the user the choice between different views to be displayed in

    one pane.

    <p>For identification only the #ResourceId is used, so for

    some methods of the XTabBar interface only the

    #ResourceId member is evaluated.</p>

*/

struct TabBarButton

{

    /** This label is displayed on the UI as button text.

        <p>The label is expected to be localized.</p>

    */

    OUString ButtonLabel;

    /** ResourceId object of the resource that is requested to be

        displayed when the tab bar button is activated.

        <p>For some methods of the XTabBar interface only this

        member is evaluated.  That is because only this member is used to

        identify a tab bar button.</p>

    */

    rtl::Reference<sd::framework::ResourceId> ResourceId;

};

/** Tab control for switching between views in the center pane.

    UI control for the selection of views in a pane.

    <p>Every tab of a tab bar has, besides its localized title and help

    text, the URL of a view.  A possible alternative would be to use a

    command URL instead of the view URL.</p>

    <p>In the current Impress implementation a tab bar is only used for the

    center pane to switch between views in the center pane.  Tab bars can

    make sense for other panes as well, i.e. for showing either the slide

    sorter or the outline view in the left pane.</p>

    <p>Tab bar buttons are identified by their resource id.  Note that

    because the resource anchors are all the same (the tab bar), it is the

    resource URL that really identifies a button. There can not be two

    buttons with the same resource id.</p>

    </p>

    <p>A better place for this interface (in an extended version) would be

    <code>com::sun::star::awt</code></p>

    @see TabBarButton

*/

class ViewTabBar final

    : public sd::framework::AbstractResource

{

public:

    ViewTabBar (

        const rtl::Reference<framework::ResourceId>& rxViewTabBarId,

        const rtl::Reference< ::sd::DrawController>& rxController);

    virtual ~ViewTabBar() override;

    virtual void disposing(std::unique_lock<std::mutex>&) override;

    const VclPtr<TabBarControl>& GetTabControl() const { return mpTabControl; }

    bool ActivatePage(size_t nIndex);

    /** Add a tab bar button to the right of another one.

        @param aButton

            The new tab bar button that is to be inserted.  If a button with

            the same resource id is already present than that is removed before the

            new button is inserted.

        @param aAnchor

            The new button is inserted to the right of this button.  When

            its ResourceId is empty then the new button is inserted at the left

            most position.

    */

    void

        addTabBarButtonAfter (

            const TabBarButton& rButton,

            const TabBarButton& rAnchor);

    /** Test whether the specified button exists in the tab bar.

        @param aButton

            The tab bar button whose existence is tested.

        @return

            Returns `TRUE` when the button exists.

    */

    bool

        hasTabBarButton (

            const TabBarButton& rButton);

    //----- AbstractResource ---------------------------------------------------------

    virtual rtl::Reference<framework::ResourceId> getResourceId() override;

    virtual bool isAnchorOnly() override;

    /** The returned value is calculated as the difference between the

        total height of the control and the height of its first tab page.

        This can be considered a hack.

        This procedure works only when the control is visible.  Calling this

        method when the control is not visible results in returning a

        default value.

        To be on the safe side wait for this control to become visible and

        the call this method again.

    */

    int GetHeight() const;

    void UpdateActiveButton();

    void AddTabBarButton (

        const TabBarButton& rButton,

        const TabBarButton& rAnchor);

    bool HasTabBarButton (

        const TabBarButton& rButton);

private:

    class Listener : public sd::framework::ConfigurationChangeListener

    {

    public:

        Listener(ViewTabBar& rParent) : mrParent(rParent) {}

        //----- sd::framework::ConfigurationChangeListener ------------------

        virtual void

            notifyConfigurationChange (

                const sd::framework::ConfigurationChangeEvent& rEvent) override;

        //----- XEventListener ----------------------------------------------------

        using WeakComponentImplHelperBase::disposing;

        virtual void SAL_CALL disposing(

            const css::lang::EventObject& rEvent) override;

    private:

        ViewTabBar& mrParent;

    };

    rtl::Reference<Listener> mxListener;

    VclPtr<TabBarControl> mpTabControl;

    rtl::Reference<::sd::DrawController> mxController;

    rtl::Reference<::sd::framework::ConfigurationController> mxConfigurationController;

    typedef ::std::vector<TabBarButton> TabBarButtonList;

    TabBarButtonList maTabBarButtons;

    rtl::Reference<sd::framework::ResourceId> mxViewTabBarId;

    ViewShellBase* mpViewShellBase;

    int mnNoteBookWidthPadding;

    void AddTabBarButton (

        const TabBarButton& rButton,

        sal_Int32 nPosition);

    void UpdateTabBarButtons();

    /** This method is called from the constructor to get the window for an

        anchor ResourceId and pass it to our base class.  It has to be

        static because it must not access any of the, not yet initialized

        members.

    */

    static vcl::Window* GetAnchorWindow(

        const rtl::Reference<sd::framework::ResourceId>& rxViewTabBarId,

        const rtl::Reference<::sd::DrawController>& rxController);

};

} // end of namespace sd

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */