UnoControls/source/inc/framecontrol.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_UNOCONTROLS_SOURCE_INC_FRAMECONTROL_HXX
  21 #define INCLUDED_UNOCONTROLS_SOURCE_INC_FRAMECONTROL_HXX
  22
  23 #include <com/sun/star/frame/XFrame2.hpp>
  24 #include <com/sun/star/lang/XServiceName.hpp>
  25 #include <com/sun/star/lang/XServiceInfo.hpp>
  26 #include <com/sun/star/lang/XConnectionPointContainer.hpp>
  27 #include <cppuhelper/propshlp.hxx>
  28 #include <rtl/ref.hxx>
  29
  30 #include <basecontrol.hxx>
  31 #include "OConnectionPointContainerHelper.hxx"
  32
  33 //  namespaces
  34
  35 namespace unocontrols{
  36
  37 //  class
  38
  39 class FrameControl  : public css::awt::XControlModel
  40                     , public css::lang::XConnectionPointContainer
  41                     , public BaseControl                                // This order is necessary for right initialization of m_aMutex!
  42                     , public ::cppu::OBroadcastHelper
  43                     , public ::cppu::OPropertySetHelper
  44 {
  45
  46 //  public methods
  47
  48 public:
  49
  50     //  construct/destruct
  51
  52     FrameControl( const css::uno::Reference< css::uno::XComponentContext >& rxContext );
  53
  54     virtual ~FrameControl() override;
  55
  56     //  XInterface
  57
  58     virtual css::uno::Any SAL_CALL queryInterface(
  59         const css::uno::Type& aType
  60     ) override;
  61
  62     /**_______________________________________________________________________________________________________
  63         @short      increment refcount
  64         @seealso    XInterface
  65         @seealso    release()
  66         @onerror    A RuntimeException is thrown.
  67     */
  68
  69     virtual void SAL_CALL acquire() throw() override;
  70
  71     /**_______________________________________________________________________________________________________
  72         @short      decrement refcount
  73         @seealso    XInterface
  74         @seealso    acquire()
  75         @onerror    A RuntimeException is thrown.
  76     */
  77
  78     virtual void SAL_CALL release() throw() override;
  79
  80     //  XTypeProvider
  81
  82     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
  83
  84     //  XAggregation
  85
  86     css::uno::Any SAL_CALL queryAggregation(
  87         const css::uno::Type& aType
  88     ) override;
  89
  90     OUString SAL_CALL getImplementationName() override;
  91
  92     css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override;
  93
  94     //  XControl
  95
  96     virtual void SAL_CALL createPeer(
  97         const css::uno::Reference< css::awt::XToolkit >&      xToolkit ,
  98         const css::uno::Reference< css::awt::XWindowPeer >&   xParent
  99     ) override;
 100
 101     virtual sal_Bool SAL_CALL setModel(
 102         const css::uno::Reference< css::awt::XControlModel >& xModel
 103     ) override;
 104
 105     virtual css::uno::Reference< css::awt::XControlModel > SAL_CALL getModel() override;
 106
 107     //  XComponent
 108
 109     virtual void SAL_CALL dispose() override;
 110
 111     //  XView
 112
 113     virtual sal_Bool SAL_CALL setGraphics(
 114         const css::uno::Reference< css::awt::XGraphics >& xDevice
 115     ) override;
 116
 117     virtual css::uno::Reference< css::awt::XGraphics > SAL_CALL getGraphics() override;
 118
 119     //  XConnectionPointContainer
 120
 121     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getConnectionPointTypes() override;
 122
 123     virtual css::uno::Reference< css::lang::XConnectionPoint > SAL_CALL queryConnectionPoint(
 124         const css::uno::Type& aType
 125     ) override;
 126
 127     virtual void SAL_CALL advise(
 128         const css::uno::Type&                                aType       ,
 129         const css::uno::Reference< css::uno::XInterface >&    xListener
 130     ) override;
 131
 132     virtual void SAL_CALL unadvise(
 133         const css::uno::Type&                                aType ,
 134         const css::uno::Reference< css::uno::XInterface >&    xListener
 135     ) override;
 136
 137     //  impl but public methods to register service!
 138
 139     static const css::uno::Sequence< OUString > impl_getStaticSupportedServiceNames();
 140
 141     static const OUString impl_getStaticImplementationName();
 142
 143 //  protected methods
 144
 145 protected:
 146     using OPropertySetHelper::getFastPropertyValue;
 147
 148     //  OPropertySetHelper
 149
 150     virtual sal_Bool SAL_CALL convertFastPropertyValue(
 151         css::uno::Any&       rConvertedValue   ,
 152         css::uno::Any&       rOldValue         ,
 153         sal_Int32           nHandle           ,
 154         const css::uno::Any& rValue
 155     ) override;
 156
 157     virtual void SAL_CALL setFastPropertyValue_NoBroadcast(
 158         sal_Int32 nHandle ,
 159         const css::uno::Any& rValue
 160     ) override;
 161
 162     virtual void SAL_CALL getFastPropertyValue( css::uno::Any&   rValue  ,
 163                                                 sal_Int32       nHandle ) const override;
 164
 165     virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper() override;
 166
 167     //  XPropertySet
 168
 169     css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo() override;
 170
 171     //  BaseControl
 172
 173     virtual css::awt::WindowDescriptor* impl_getWindowDescriptor(
 174         const css::uno::Reference< css::awt::XWindowPeer >& xParentPeer
 175     ) override;
 176
 177 //  private methods
 178
 179 private:
 180
 181     void impl_createFrame(  const css::uno::Reference< css::awt::XWindowPeer >&       xPeer           ,
 182                             const OUString&                                         sURL            ,
 183                             const css::uno::Sequence< css::beans::PropertyValue >&    seqArguments    );
 184
 185     void impl_deleteFrame();
 186
 187 //  private variables
 188
 189 private:
 190
 191     css::uno::Reference< css::frame::XFrame2 >              m_xFrame;
 192     OUString                                                m_sComponentURL;
 193     css::uno::Sequence< css::beans::PropertyValue >         m_seqLoaderArguments;
 194     rtl::Reference<OConnectionPointContainerHelper>         m_aConnectionPointContainer;
 195
 196 };  // class FrameControl
 197
 198 }   // namespace unocontrols
 199
 200 #endif // INCLUDED_UNOCONTROLS_SOURCE_INC_FRAMECONTROL_HXX
 201
 202 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */