include/svx/unomaster.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 #ifndef INCLUDED_SVX_UNOMASTER_HXX
  21 #define INCLUDED_SVX_UNOMASTER_HXX
  22
  23 #include <com/sun/star/uno/Type.h>
  24 #include <com/sun/star/uno/Any.h>
  25 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  26 #include <com/sun/star/beans/PropertyState.hpp>
  27
  28 /** this abstract class is the interface for an instance that likes to enhance
  29     the functionality of components implemented with derivations from SvxShape
  30
  31     @see SvxShape::setMaster
  32 */
  33 class SvxShapeMaster
  34 {
  35 public:
  36     virtual bool queryAggregation( const css::uno::Type & rType, css::uno::Any& aAny ) = 0;
  37
  38     /// @throws css::uno::RuntimeException
  39     virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) = 0;
  40     /// @throws css::beans::UnknownPropertyException
  41     /// @throws css::beans::PropertyVetoException
  42     /// @throws css::lang::IllegalArgumentException
  43     /// @throws css::lang::WrappedTargetException
  44     /// @throws css::uno::RuntimeException
  45     virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) = 0;
  46     /// @throws css::beans::UnknownPropertyException
  47     /// @throws css::lang::WrappedTargetException
  48     /// @throws css::uno::RuntimeException
  49     virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) = 0;
  50
  51     /// @throws css::beans::UnknownPropertyException
  52     /// @throws css::uno::RuntimeException
  53     virtual css::beans::PropertyState SAL_CALL getPropertyState( const OUString& PropertyName ) = 0;
  54     /// @throws css::beans::UnknownPropertyException
  55     /// @throws css::uno::RuntimeException
  56     virtual void SAL_CALL setPropertyToDefault( const OUString& PropertyName ) = 0;
  57     /// @throws css::beans::UnknownPropertyException
  58     /// @throws css::lang::WrappedTargetException
  59     /// @throws css::uno::RuntimeException
  60     virtual css::uno::Any SAL_CALL getPropertyDefault( const OUString& aPropertyName ) = 0;
  61
  62     /// @throws css::uno::RuntimeException
  63     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes(  ) = 0;
  64
  65     /// @throws css::uno::RuntimeException
  66     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() = 0;
  67
  68     virtual void dispose() = 0;
  69
  70 protected:
  71     ~SvxShapeMaster() {}
  72 };
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */