unoevent.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 <svtools/svtdllapi.h>
#include <com/sun/star/container/XNameReplace.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <cppuhelper/implbase.hxx>
#include <vector>
#include <memory>
 
namespace com :: sun :: star :: uno { class XInterface; }
 
class SvxMacroTableDtor;
class SvxMacroItem;
class SvxMacro;
enum class SvMacroItemId : sal_uInt16;
 
struct SvEventDescription
{
    SvMacroItemId mnEvent;
    const char* mpEventName;
};
 
class SVT_DLLPUBLIC SvBaseEventDescriptor : public cppu::WeakImplHelper
<
    css::container::XNameReplace,
    css::lang::XServiceInfo
>
{
protected:
    const SvEventDescription* mpSupportedMacroItems;
    sal_Int16 mnMacroItems;
 
public:
 
     SvBaseEventDescriptor(const SvEventDescription* pSupportedMacroItems);
 
    virtual ~SvBaseEventDescriptor() override;
 
 
    // XNameReplace
    virtual void SAL_CALL replaceByName(
        const OUString& rName,                
        const css::uno::Any& rElement ) 
             override;
 
    // XNameAccess (via XNameReplace)
    virtual css::uno::Any SAL_CALL getByName(
        const OUString& rName )  
             override;
 
    // XNameAxcess (via XNameReplace)
    virtual css::uno::Sequence< OUString > SAL_CALL
                                                        getElementNames() override;
 
    // XNameAccess (via XNameReplace)
    virtual sal_Bool SAL_CALL hasByName(
        const OUString& rName ) override;
 
    // XElementAccess (via XNameReplace)
    virtual css::uno::Type SAL_CALL getElementType() override;
 
    // XElementAccess (via XNameReplace)
    virtual sal_Bool SAL_CALL hasElements() override;
 
    // XServiceInfo
    virtual OUString SAL_CALL getImplementationName() override = 0;
 
    // XServiceInfo
    virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
 
    // XServiceInfo
    virtual css::uno::Sequence< OUString > SAL_CALL
        getSupportedServiceNames() override;
 
protected:
 
    virtual void replaceByName(
        const SvMacroItemId nEvent,  
        const SvxMacro& rMacro)      
             = 0;
 
    virtual void getByName(
        SvxMacro& rMacro,
        const SvMacroItemId nEvent ) = 0;
 
    SvMacroItemId mapNameToEventID(std::u16string_view rName) const;
 
    SvMacroItemId getMacroID(std::u16string_view rName) const;
};
 
 
class SVT_DLLPUBLIC SvEventDescriptor : public SvBaseEventDescriptor
{
    css::uno::Reference< css::uno::XInterface > xParentRef;
 
public:
 
     SvEventDescriptor(css::uno::XInterface& rParent,
                      const SvEventDescription* pSupportedMacroItems);
 
    virtual ~SvEventDescriptor() override;
 
 
protected:
 
 
    using SvBaseEventDescriptor::replaceByName;
    virtual void replaceByName(
        const SvMacroItemId nEvent,   
        const SvxMacro& rMacro)       
             override;
 
    using SvBaseEventDescriptor::getByName;
    virtual void getByName(
        SvxMacro& rMacros,            
        const SvMacroItemId nEvent )  
             override;
 
 
    virtual const SvxMacroItem& getMacroItem() = 0;
 
    virtual void setMacroItem(const SvxMacroItem& rItem) = 0;
 
    virtual sal_uInt16 getMacroItemWhich() const = 0;
};
 
 
class SVT_DLLPUBLIC SvDetachedEventDescriptor : public SvBaseEventDescriptor
{
    // the macros; aMacros[i] is the value for aSupportedMacroItemIDs[i]
    std::vector<std::unique_ptr<SvxMacro>> aMacros;
 
public:
 
    SvDetachedEventDescriptor(const SvEventDescription* pSupportedMacroItems);
    SvDetachedEventDescriptor& operator=( SvDetachedEventDescriptor const & ) = delete; // MSVC2015 workaround
    SvDetachedEventDescriptor( SvDetachedEventDescriptor const & ) = delete; // MSVC2015 workaround
 
    virtual ~SvDetachedEventDescriptor() override;
 
    //XServiceInfo
    virtual OUString SAL_CALL getImplementationName() override;
 
protected:
 
    sal_Int16 getIndex(const SvMacroItemId nID) const;
 
    using SvBaseEventDescriptor::replaceByName;
    virtual void replaceByName(
        const SvMacroItemId nEvent,  
        const SvxMacro& rMacro)      
             override;
 
    using SvBaseEventDescriptor::getByName;
    virtual void getByName(
        SvxMacro& rMacro,             
        const SvMacroItemId nEvent )  
             override;
 
    bool hasById(
        const SvMacroItemId nEvent ) const;     
 
};
 
class SVT_DLLPUBLIC SvMacroTableEventDescriptor final : public SvDetachedEventDescriptor
{
public:
 
     SvMacroTableEventDescriptor(const SvEventDescription* pSupportedMacroItems);
     SvMacroTableEventDescriptor(const SvxMacroTableDtor& aFmt,
                                const SvEventDescription* pSupportedMacroItems);
 
    virtual ~SvMacroTableEventDescriptor() override;
 
    void copyMacrosIntoTable(SvxMacroTableDtor& aFmt);
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */