embeddedobj/source/inc/dummyobject.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_EMBEDDEDOBJ_SOURCE_INC_DUMMYOBJECT_HXX
  21 #define INCLUDED_EMBEDDEDOBJ_SOURCE_INC_DUMMYOBJECT_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <memory>
  26
  27 #include <com/sun/star/uno/Sequence.hxx>
  28 #include <com/sun/star/uno/Reference.hxx>
  29 #include <com/sun/star/embed/XEmbeddedObject.hpp>
  30 #include <com/sun/star/embed/XEmbedPersist.hpp>
  31 #include <cppuhelper/implbase.hxx>
  32 #include <cppuhelper/interfacecontainer.hxx>
  33
  34 namespace com { namespace sun { namespace star {
  35     namespace embed {
  36         class XStorage;
  37     }
  38     namespace util {
  39         class XCloseListener;
  40     }
  41     namespace beans {
  42         struct PropertyValue;
  43         struct NamedValue;
  44     }
  45 }}}
  46
  47 namespace cppu {
  48     class OMultiTypeInterfaceContainerHelper;
  49 }
  50
  51 /**
  52  * Represents an OLE object that has native data (next to the replacement
  53  * image), but we don't understand that data.
  54  */
  55 class ODummyEmbeddedObject : public ::cppu::WeakImplHelper
  56                         < css::embed::XEmbeddedObject
  57                         , css::embed::XEmbedPersist >
  58 {
  59     ::osl::Mutex    m_aMutex;
  60     std::unique_ptr<cppu::OMultiTypeInterfaceContainerHelper>
  61         m_pInterfaceContainer;
  62     bool m_bDisposed;
  63
  64     OUString m_aEntryName;
  65     css::uno::Reference< css::embed::XStorage > m_xParentStorage;
  66     sal_Int32 m_nObjectState;
  67
  68     css::uno::Reference< css::embed::XEmbeddedClient > m_xClientSite;
  69
  70     sal_Int64 m_nCachedAspect;
  71     css::awt::Size m_aCachedSize;
  72     bool m_bHasCachedSize;
  73
  74     // following information will be used between SaveAs and SaveCompleted
  75     bool m_bWaitSaveCompleted;
  76     OUString m_aNewEntryName;
  77     css::uno::Reference< css::embed::XStorage > m_xNewParentStorage;
  78
  79 protected:
  80     void CheckInit_WrongState();    //throw WrongStateException on m_nObjectState == -1
  81     void CheckInit_Runtime();       //throw RuntimeException on m_nObjectState == -1
  82     void PostEvent_Impl( const OUString& aEventName );
  83
  84 public:
  85
  86     ODummyEmbeddedObject()
  87     : m_bDisposed( false )
  88     , m_nObjectState( -1 )
  89     , m_nCachedAspect( 0 )
  90     , m_bHasCachedSize( false )
  91     , m_bWaitSaveCompleted( false )
  92     {}
  93
  94     virtual ~ODummyEmbeddedObject() override;
  95
  96 // XEmbeddedObject
  97
  98     virtual void SAL_CALL changeState( sal_Int32 nNewState ) override;
  99
 100     virtual css::uno::Sequence< sal_Int32 > SAL_CALL getReachableStates() override;
 101
 102     virtual sal_Int32 SAL_CALL getCurrentState() override;
 103
 104     virtual void SAL_CALL doVerb( sal_Int32 nVerbID ) override;
 105
 106     virtual css::uno::Sequence< css::embed::VerbDescriptor > SAL_CALL getSupportedVerbs() override;
 107
 108     virtual void SAL_CALL setClientSite(
 109                 const css::uno::Reference< css::embed::XEmbeddedClient >& xClient ) override;
 110
 111     virtual css::uno::Reference< css::embed::XEmbeddedClient > SAL_CALL getClientSite() override;
 112
 113     virtual void SAL_CALL update() override;
 114
 115     virtual void SAL_CALL setUpdateMode( sal_Int32 nMode ) override;
 116
 117     virtual sal_Int64 SAL_CALL getStatus( sal_Int64 nAspect ) override;
 118
 119     virtual void SAL_CALL setContainerName( const OUString& sName ) override;
 120
 121
 122 // XVisualObject
 123
 124     virtual void SAL_CALL setVisualAreaSize( sal_Int64 nAspect, const css::awt::Size& aSize ) override;
 125
 126     virtual css::awt::Size SAL_CALL getVisualAreaSize( sal_Int64 nAspect ) override;
 127
 128     virtual css::embed::VisualRepresentation SAL_CALL getPreferredVisualRepresentation( ::sal_Int64 nAspect ) override;
 129
 130     virtual sal_Int32 SAL_CALL getMapUnit( sal_Int64 nAspect ) override;
 131
 132 // XEmbedPersist
 133
 134     virtual void SAL_CALL setPersistentEntry(
 135                     const css::uno::Reference< css::embed::XStorage >& xStorage,
 136                     const OUString& sEntName,
 137                     sal_Int32 nEntryConnectionMode,
 138                     const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
 139                     const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
 140
 141     virtual void SAL_CALL storeToEntry( const css::uno::Reference< css::embed::XStorage >& xStorage, const OUString& sEntName, const css::uno::Sequence< css::beans::PropertyValue >& lArguments, const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
 142
 143     virtual void SAL_CALL storeAsEntry(
 144                 const css::uno::Reference< css::embed::XStorage >& xStorage,
 145                 const OUString& sEntName,
 146                 const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
 147                 const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
 148
 149     virtual void SAL_CALL saveCompleted( sal_Bool bUseNew ) override;
 150
 151     virtual sal_Bool SAL_CALL hasEntry() override;
 152
 153     virtual OUString SAL_CALL getEntryName() override;
 154
 155
 156 // XCommonEmbedPersist
 157
 158     virtual void SAL_CALL storeOwn() override;
 159
 160     virtual sal_Bool SAL_CALL isReadonly() override;
 161
 162     virtual void SAL_CALL reload(
 163                 const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
 164                 const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
 165
 166
 167 // XClassifiedObject
 168
 169     virtual css::uno::Sequence< sal_Int8 > SAL_CALL getClassID() override;
 170
 171     virtual OUString SAL_CALL getClassName() override;
 172
 173     virtual void SAL_CALL setClassInfo(
 174                 const css::uno::Sequence< sal_Int8 >& aClassID, const OUString& aClassName ) override;
 175
 176
 177 // XComponentSupplier
 178
 179     virtual css::uno::Reference< css::util::XCloseable > SAL_CALL getComponent() override;
 180
 181 // XStateChangeBroadcaster
 182     virtual void SAL_CALL addStateChangeListener( const css::uno::Reference< css::embed::XStateChangeListener >& xListener ) override;
 183     virtual void SAL_CALL removeStateChangeListener( const css::uno::Reference< css::embed::XStateChangeListener >& xListener ) override;
 184
 185 // XCloseable
 186
 187     virtual void SAL_CALL close( sal_Bool DeliverOwnership ) override;
 188
 189     virtual void SAL_CALL addCloseListener(
 190                 const css::uno::Reference< css::util::XCloseListener >& Listener ) override;
 191
 192     virtual void SAL_CALL removeCloseListener(
 193                 const css::uno::Reference< css::util::XCloseListener >& Listener ) override;
 194
 195 // XEventBroadcaster
 196     virtual void SAL_CALL addEventListener(
 197                 const css::uno::Reference< css::document::XEventListener >& Listener ) override;
 198
 199     virtual void SAL_CALL removeEventListener(
 200                 const css::uno::Reference< css::document::XEventListener >& Listener ) override;
 201
 202 };
 203
 204 #endif
 205
 206 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */