/* -*- 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 <o3tl/enumarray.hxx>

#include <com/sun/star/uno/Any.hxx>

namespace framework{

// Please add new entries alphabetical sorted and correct all other handles!

// Start counting with 0, so it can be used as direct index into an array too.

enum class FramePropHandle : sal_Int32

{

    DispatchRecorderSupplier = 0,

    IsHidden = 1,

    LayoutManager = 2,

    Title = 3,

    IndicatorInterception = 4,

    Url = 5,

    LAST = Url

};

/** properties for "Frame" class */

inline constexpr o3tl::enumarray<FramePropHandle, OUString> FramePropNames =

{

    u"DispatchRecorderSupplier"_ustr,

    u"IsHidden"_ustr,

    u"LayoutManager"_ustr,

    u"Title"_ustr,

    u"IndicatorInterception"_ustr,

    u"URL"_ustr

};

/** properties for "LayoutManager" class */

enum class LayoutManagerPropHandle

{

    MenuBarCloser,

    AutomaticToolbars,

    RefreshVisibility,

    HideCurrentUI,

    LockCount,

    PreserveContentSize,

    RefreshToolTip,

    LAST = RefreshToolTip

};

inline constexpr o3tl::enumarray<LayoutManagerPropHandle, OUString> LayoutManagerPropNames =

{

    u"MenuBarCloser"_ustr,

    u"AutomaticToolbars"_ustr,

    u"RefreshContextToolbarVisibility"_ustr,

    u"HideCurrentUI"_ustr,

    u"LockCount"_ustr,

    u"PreserveContentSize"_ustr,

    u"RefreshContextToolbarToolTip"_ustr

};

/** properties for "UICommandDescription" class */

inline constexpr OUString UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDIMAGELIST = u"private:resource/image/commandimagelist"_ustr;

inline constexpr OUString UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDROTATEIMAGELIST = u"private:resource/image/commandrotateimagelist"_ustr;

inline constexpr OUString UICOMMANDDESCRIPTION_NAMEACCESS_COMMANDMIRRORIMAGELIST = u"private:resource/image/commandmirrorimagelist"_ustr;

#define UICOMMANDDESCRIPTION_PROPERTIES_TOGGLEBUTTON            8

/** properties for "AutoRecovery" class */

enum class AutoRecoveryPropHandle

{

    ExistsRecoveryData,

    ExistsSessionData,

    Crashed,

    LAST = Crashed

};

inline constexpr o3tl::enumarray<AutoRecoveryPropHandle, OUString> AutoRecoveryPropNames =

{

    u"ExistsRecoveryData"_ustr,

    u"ExistsSessionData"_ustr,

    u"Crashed"_ustr

};

/** properties for Filter config */

inline constexpr OUString FILTER_PROPNAME_ASCII_DOCUMENTSERVICE = u"DocumentService"_ustr;

/** properties for office module config (Setup.xcu) */

inline constexpr OUString OFFICEFACTORY_PROPNAME_ASCII_UINAME = u"ooSetupFactoryUIName"_ustr;

inline constexpr OUString OFFICEFACTORY_PROPNAME_ASCII_ICON = u"ooSetupFactoryIcon"_ustr;

/** provides some helper methods to implement property sets. */

class PropHelper

{

    public:

    /** checks if given property will be changed by this settings.

     *  We compare the content of the given any values. If they are different we return sal_True - sal_False otherwise.

     *

     *  @param  aCurrentValue   contains the current value for this property

     *  @param  aNewValue       contains the new value for this property

     *  @param  aOldValue       returns the current value, in case something will be changed

     *  @param  aChangedValue   returns the new value, in case something will be changed

     *

     *  @return <True/> if value of this property will be changed; <False/> otherwise.

     */

    static bool willPropertyBeChanged( const css::uno::Any& aCurrentValue ,

                                           const css::uno::Any& aNewValue     ,

                                                 css::uno::Any& aOldValue     ,

                                                 css::uno::Any& aChangedValue )

    {

        bool bChanged = false;

        // clear return parameter to be sure, to put out only valid values ...

        aOldValue.clear();

        aChangedValue.clear();

        // if value change ...

        bChanged = aCurrentValue != aNewValue;

        if (bChanged)

        {

            // ... set information of change.

            aOldValue     = aCurrentValue;

            aChangedValue = aNewValue;

        }

        return bChanged;

    }

};

} // namespace framework

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