framework/inc/classes/actiontriggerpropertyset.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <cppuhelper/basemutex.hxx>
  23 #include <cppuhelper/propshlp.hxx>
  24 #include <cppuhelper/weak.hxx>
  25 #include <rtl/ustring.hxx>
  26
  27 #include <com/sun/star/awt/XBitmap.hpp>
  28 #include <com/sun/star/lang/XServiceInfo.hpp>
  29 #include <com/sun/star/lang/XTypeProvider.hpp>
  30
  31 inline constexpr OUString SERVICENAME_ACTIONTRIGGER = u"com.sun.star.ui.ActionTrigger"_ustr;
  32 inline constexpr OUString IMPLEMENTATIONNAME_ACTIONTRIGGER = u"com.sun.star.comp.ui.ActionTrigger"_ustr;
  33
  34 namespace framework
  35 {
  36
  37 class ActionTriggerPropertySet final : private cppu::BaseMutex,
  38                                     public css::lang::XServiceInfo ,
  39                                     public css::lang::XTypeProvider,
  40                                     public ::cppu::OBroadcastHelper             ,
  41                                     public ::cppu::OPropertySetHelper           ,   // -> XPropertySet, XFastPropertySet, XMultiPropertySet
  42                                     public ::cppu::OWeakObject
  43 {
  44     public:
  45         ActionTriggerPropertySet();
  46         virtual ~ActionTriggerPropertySet() override;
  47
  48         // XInterface
  49         virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;
  50         virtual void SAL_CALL acquire() noexcept override;
  51         virtual void SAL_CALL release() noexcept override;
  52
  53         // XServiceInfo
  54         virtual OUString SAL_CALL getImplementationName(  ) override;
  55         virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
  56         virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;
  57
  58         // XTypeProvider
  59         virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes(  ) override;
  60         virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId(  ) override;
  61
  62     private:
  63
  64         //  OPropertySetHelper
  65
  66         virtual sal_Bool SAL_CALL convertFastPropertyValue( css::uno::Any&       aConvertedValue,
  67                                                             css::uno::Any&       aOldValue,
  68                                                             sal_Int32                       nHandle,
  69                                                             const css::uno::Any& aValue          ) override;
  70
  71         virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const css::uno::Any& aValue ) override;
  72
  73         using cppu::OPropertySetHelper::getFastPropertyValue;
  74         virtual void SAL_CALL getFastPropertyValue( css::uno::Any& aValue, sal_Int32 nHandle ) const override;
  75
  76         virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper() override;
  77
  78         virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo() override;
  79
  80         static css::uno::Sequence< css::beans::Property > impl_getStaticPropertyDescriptor();
  81
  82         //  helper
  83
  84         /// @throws css::lang::IllegalArgumentException
  85         static bool impl_tryToChangeProperty(  const   OUString&            aCurrentValue   ,
  86                                         const   css::uno::Any&       aNewValue       ,
  87                                             css::uno::Any&           aOldValue       ,
  88                                             css::uno::Any&           aConvertedValue );
  89
  90         /// @throws css::lang::IllegalArgumentException
  91         static bool impl_tryToChangeProperty(  const   css::uno::Reference< css::awt::XBitmap >&  xBitmap,
  92                                         const   css::uno::Any&   aNewValue       ,
  93                                             css::uno::Any&           aOldValue       ,
  94                                             css::uno::Any&           aConvertedValue );
  95
  96         /// @throws css::lang::IllegalArgumentException
  97         static bool impl_tryToChangeProperty(  const   css::uno::Reference< css::uno::XInterface >& xInterface,
  98                                         const   css::uno::Any&   aNewValue       ,
  99                                             css::uno::Any&           aOldValue       ,
 100                                             css::uno::Any&           aConvertedValue );
 101
 102         //  members
 103
 104         OUString                                    m_aCommandURL;
 105         OUString                                    m_aHelpURL;
 106         OUString                                    m_aText;
 107         css::uno::Reference< css::awt::XBitmap >    m_xBitmap;
 108         css::uno::Reference< css::uno::XInterface > m_xActionTriggerContainer;
 109 };
 110
 111 }
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */