office-gobmx/embeddedobj/source/inc/dummyobject.hxx
Miklos Vajna 15a524a1ed embeddedobj: implement XServiceInfo in the various embedded obj implementations
This gives UNO clients a reliable way to detect e.g.
OSpecialEmbeddedObject, where it's expected that double-clicking on the
object doesn't do anything.

Change-Id: I595453490b157b64214cd7359da1e3a3c959191d
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/120274
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
Tested-by: Jenkins
2021-08-10 22:02:00 +02:00

205 lines
7.3 KiB
C++

/* -*- 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 <sal/config.h>
#include <memory>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/embed/XEmbeddedObject.hpp>
#include <com/sun/star/embed/XEmbedPersist.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <cppuhelper/implbase.hxx>
#include <comphelper/multicontainer2.hxx>
namespace com::sun::star {
namespace embed {
class XStorage;
}
namespace util {
class XCloseListener;
}
namespace beans {
struct PropertyValue;
struct NamedValue;
}
}
/**
* Represents an OLE object that has native data (next to the replacement
* image), but we don't understand that data.
*/
class ODummyEmbeddedObject : public ::cppu::WeakImplHelper
< css::embed::XEmbeddedObject
, css::embed::XEmbedPersist
, css::lang::XServiceInfo >
{
::osl::Mutex m_aMutex;
std::unique_ptr<comphelper::OMultiTypeInterfaceContainerHelper2>
m_pInterfaceContainer;
bool m_bDisposed;
OUString m_aEntryName;
css::uno::Reference< css::embed::XStorage > m_xParentStorage;
sal_Int32 m_nObjectState;
css::uno::Reference< css::embed::XEmbeddedClient > m_xClientSite;
sal_Int64 m_nCachedAspect;
css::awt::Size m_aCachedSize;
bool m_bHasCachedSize;
// following information will be used between SaveAs and SaveCompleted
bool m_bWaitSaveCompleted;
OUString m_aNewEntryName;
css::uno::Reference< css::embed::XStorage > m_xNewParentStorage;
protected:
void CheckInit_WrongState(); //throw WrongStateException on m_nObjectState == -1
void CheckInit_Runtime(); //throw RuntimeException on m_nObjectState == -1
void PostEvent_Impl( const OUString& aEventName );
public:
ODummyEmbeddedObject()
: m_bDisposed( false )
, m_nObjectState( -1 )
, m_nCachedAspect( 0 )
, m_bHasCachedSize( false )
, m_bWaitSaveCompleted( false )
{}
virtual ~ODummyEmbeddedObject() override;
// XEmbeddedObject
virtual void SAL_CALL changeState( sal_Int32 nNewState ) override;
virtual css::uno::Sequence< sal_Int32 > SAL_CALL getReachableStates() override;
virtual sal_Int32 SAL_CALL getCurrentState() override;
virtual void SAL_CALL doVerb( sal_Int32 nVerbID ) override;
virtual css::uno::Sequence< css::embed::VerbDescriptor > SAL_CALL getSupportedVerbs() override;
virtual void SAL_CALL setClientSite(
const css::uno::Reference< css::embed::XEmbeddedClient >& xClient ) override;
virtual css::uno::Reference< css::embed::XEmbeddedClient > SAL_CALL getClientSite() override;
virtual void SAL_CALL update() override;
virtual void SAL_CALL setUpdateMode( sal_Int32 nMode ) override;
virtual sal_Int64 SAL_CALL getStatus( sal_Int64 nAspect ) override;
virtual void SAL_CALL setContainerName( const OUString& sName ) override;
// XVisualObject
virtual void SAL_CALL setVisualAreaSize( sal_Int64 nAspect, const css::awt::Size& aSize ) override;
virtual css::awt::Size SAL_CALL getVisualAreaSize( sal_Int64 nAspect ) override;
virtual css::embed::VisualRepresentation SAL_CALL getPreferredVisualRepresentation( ::sal_Int64 nAspect ) override;
virtual sal_Int32 SAL_CALL getMapUnit( sal_Int64 nAspect ) override;
// XEmbedPersist
virtual void SAL_CALL setPersistentEntry(
const css::uno::Reference< css::embed::XStorage >& xStorage,
const OUString& sEntName,
sal_Int32 nEntryConnectionMode,
const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
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;
virtual void SAL_CALL storeAsEntry(
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;
virtual void SAL_CALL saveCompleted( sal_Bool bUseNew ) override;
virtual sal_Bool SAL_CALL hasEntry() override;
virtual OUString SAL_CALL getEntryName() override;
// XCommonEmbedPersist
virtual void SAL_CALL storeOwn() override;
virtual sal_Bool SAL_CALL isReadonly() override;
virtual void SAL_CALL reload(
const css::uno::Sequence< css::beans::PropertyValue >& lArguments,
const css::uno::Sequence< css::beans::PropertyValue >& lObjArgs ) override;
// XClassifiedObject
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getClassID() override;
virtual OUString SAL_CALL getClassName() override;
virtual void SAL_CALL setClassInfo(
const css::uno::Sequence< sal_Int8 >& aClassID, const OUString& aClassName ) override;
// XComponentSupplier
virtual css::uno::Reference< css::util::XCloseable > SAL_CALL getComponent() override;
// XStateChangeBroadcaster
virtual void SAL_CALL addStateChangeListener( const css::uno::Reference< css::embed::XStateChangeListener >& xListener ) override;
virtual void SAL_CALL removeStateChangeListener( const css::uno::Reference< css::embed::XStateChangeListener >& xListener ) override;
// XCloseable
virtual void SAL_CALL close( sal_Bool DeliverOwnership ) override;
virtual void SAL_CALL addCloseListener(
const css::uno::Reference< css::util::XCloseListener >& Listener ) override;
virtual void SAL_CALL removeCloseListener(
const css::uno::Reference< css::util::XCloseListener >& Listener ) override;
// XEventBroadcaster
virtual void SAL_CALL addEventListener(
const css::uno::Reference< css::document::XEventListener >& Listener ) override;
virtual void SAL_CALL removeEventListener(
const css::uno::Reference< css::document::XEventListener >& Listener ) override;
// XServiceInfo
OUString SAL_CALL getImplementationName() override;
sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */