/* -*- 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 .

 */

#ifndef INCLUDED_SFX2_SFXDLG_HXX

#define INCLUDED_SFX2_SFXDLG_HXX

#include <sal/config.h>

#include <sfx2/dllapi.h>

#include <vcl/abstdlg.hxx>

#include <sfx2/tabdlg.hxx>

class SfxItemSet;

class SfxItemPool;

class SvObjectServerList;

class TransferableDataHelper;

class SvGlobalName;

enum class SotClipboardFormatId : sal_uInt32;

namespace sfx2

{

    class LinkManager;

    class SvBaseLink;

}

namespace com::sun::star::embed { class XEmbeddedObject; }

namespace com::sun::star::embed { class XStorage; }

namespace com::sun::star::io { class XInputStream; }

namespace com::sun::star::uno { class Any; }

namespace com::sun::star::uno { template <class interface_type> class Reference; }

class SfxAbstractDialog : virtual public VclAbstractDialog

{

protected:

    virtual ~SfxAbstractDialog() override = default;

public:

    /** Get a set of items changed in the dialog.

      */

    virtual const SfxItemSet*   GetOutputItemSet() const = 0;

    virtual void                SetText( const OUString& rStr ) = 0;

};

class SfxAbstractTabDialog : virtual public SfxAbstractDialog

{

protected:

    virtual ~SfxAbstractTabDialog() override = default;

public:

    virtual void                SetCurPageId( const OUString &rName ) = 0;

    virtual WhichRangesContainer GetInputRanges( const SfxItemPool& ) = 0;

    virtual void                SetInputSet( const SfxItemSet* pInSet ) = 0;

    virtual const std::set<sal_uInt16>& GetInvalidatedWhichIds() const

    {

        static const std::set<sal_uInt16> empty;

        return empty;

    }

};

class SfxAbstractApplyTabDialog : virtual public SfxAbstractTabDialog

{

protected:

    virtual ~SfxAbstractApplyTabDialog() override = default;

public:

    virtual void                SetApplyHdl( const Link<LinkParamNone*,void>& rLink ) = 0;

};

class SfxAbstractInsertObjectDialog : virtual public VclAbstractDialog

{

protected:

    virtual ~SfxAbstractInsertObjectDialog() override = default;

public:

    virtual css::uno::Reference < css::embed::XEmbeddedObject > GetObject()=0;

    virtual css::uno::Reference< css::io::XInputStream > GetIconIfIconified( OUString* pGraphicMediaType )=0;

    virtual bool IsCreateNew()=0;

};

class SfxAbstractPasteDialog : virtual public VclAbstractDialog

{

protected:

    virtual ~SfxAbstractPasteDialog() override = default;

public:

    virtual void Insert( SotClipboardFormatId nFormat, const OUString & rFormatName ) = 0;

    virtual void InsertUno( const OUString& sCmd, const OUString& sLabel ) = 0;

    virtual void SetObjName( const SvGlobalName & rClass, const OUString & rObjName ) = 0;

    virtual void PreGetFormat( const TransferableDataHelper& aHelper ) = 0;

    virtual SotClipboardFormatId GetFormatOnly() = 0;

    virtual SotClipboardFormatId GetFormat( const TransferableDataHelper& aHelper ) = 0;

};

class SfxAbstractLinksDialog : virtual public VclAbstractDialog

{

protected:

    virtual ~SfxAbstractLinksDialog() override = default;

};

class AbstractScriptSelectorDialog : virtual public VclAbstractDialog

{

protected:

    virtual ~AbstractScriptSelectorDialog() override = default;

public:

    virtual OUString       GetScriptURL() const = 0;

    virtual void                SetRunLabel() = 0;

    // Return the model containing the selected script, or a null reference if the script isn’t

    // embedded in a document.

    virtual css::uno::Reference<css::frame::XModel> GetScriptModel() const = 0;

};

class AbstractMacroManagerDialog : virtual public VclAbstractDialog

{

protected:

    virtual ~AbstractMacroManagerDialog() override = default;

public:

    virtual OUString GetScriptURL() const = 0;

    virtual void LoadLastUsedMacro() const = 0;

    // Return the model containing the selected script, or a null reference if the script isn’t

    // embedded in a document.

    virtual css::uno::Reference<css::frame::XModel> GetScriptModel() const = 0;

};

namespace com::sun::star::frame { class XFrame; }

class SFX2_DLLPUBLIC SfxAbstractDialogFactory : virtual public VclAbstractDialogFactory

{

public:

                                        virtual ~SfxAbstractDialogFactory() override;    // needed for export of vtable

    static SfxAbstractDialogFactory*    Create();

    virtual VclPtr<VclAbstractDialog>          CreateFrameDialog(weld::Window* pParent, const css::uno::Reference< css::frame::XFrame >& rFrame, sal_uInt32 nResId, sal_uInt16 nPageId, const OUString& rParameter) = 0;

    virtual VclPtr<SfxAbstractTabDialog>       CreateAutoCorrTabDialog(weld::Window* pParent, const SfxItemSet* pAttrSet) = 0;

    virtual VclPtr<SfxAbstractTabDialog>       CreateCustomizeTabDialog(weld::Window* pParent,

                                            const SfxItemSet* pAttrSet,

                                            const css::uno::Reference< css::frame::XFrame >& xViewFrame ) = 0;

    virtual CreateTabPage               GetTabPageCreatorFunc( sal_uInt16 nId ) = 0;

    virtual GetTabPageRanges            GetTabPageRangesFunc( sal_uInt16 nId ) = 0;

    virtual VclPtr<SfxAbstractInsertObjectDialog> CreateInsertObjectDialog(weld::Window* pParent, const OUString& rCommand,

            const css::uno::Reference < css::embed::XStorage >& xStor,

            const SvObjectServerList* pList )=0;

    virtual VclPtr<VclAbstractDialog>          CreateEditObjectDialog(weld::Window* pParent, const OUString& rCommand,

            const css::uno::Reference < css::embed::XEmbeddedObject >& xObj )=0;

    virtual VclPtr<SfxAbstractPasteDialog>    CreatePasteDialog(weld::Window* pParent) = 0;

    virtual VclPtr<SfxAbstractLinksDialog>    CreateLinksDialog(weld::Window* pParent, sfx2::LinkManager* pMgr, bool bHTML=false, sfx2::SvBaseLink* p=nullptr) = 0;

    virtual VclPtr<VclAbstractDialog>         CreateSvxScriptOrgDialog(weld::Window* pParent,  const OUString& rLanguage) = 0;

    virtual VclPtr<AbstractSecurityOptionsDialog> CreateSvxSecurityOptionsDialog(weld::Window* pParent) = 0;

    virtual VclPtr<AbstractScriptSelectorDialog> CreateScriptSelectorDialog(weld::Window* pParent,

            const css::uno::Reference< css::frame::XFrame >& rxFrame) = 0;

    virtual VclPtr<AbstractMacroManagerDialog>

    CreateMacroManagerDialog(weld::Window* pParent,

                             const css::uno::Reference<css::frame::XFrame>& rxFrame)

        = 0;

    virtual void ShowAsyncScriptErrorDialog( weld::Window* pParent, const css::uno::Any& rException ) = 0;

    virtual VclPtr<VclAbstractDialog>  CreateOptionsDialog(

        weld::Window* pParent, const OUString& rExtensionId ) = 0;

    virtual VclPtr<VclAbstractDialog> CreateAboutDialog(weld::Window* _pParent) = 0;

    virtual VclPtr<VclAbstractDialog> CreateTipOfTheDayDialog(weld::Window* _pParent) = 0;

    virtual VclPtr<VclAbstractDialog> CreateUIPickerDialog(weld::Window* _pParent) = 0;

    virtual VclPtr<VclAbstractDialog> CreateHyperlinkDialog(weld::Window* pParent,

                                                            SfxChildWindow* pChildWindow) = 0;

    virtual VclPtr<VclAbstractDialog> CreateWidgetTestDialog(weld::Window* _pParent) = 0;

    virtual VclPtr<SfxAbstractTabDialog> CreateWelcomeDialog(weld::Window* pParent, const bool bIsFirstStart) =0;

};

#endif

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