include/svx/svdouno.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 <com/sun/star/awt/XControlModel.hpp>
  23 #include <com/sun/star/awt/XControl.hpp>
  24 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  25 #include <com/sun/star/awt/XControlContainer.hpp>
  26 #include <svx/svxdllapi.h>
  27 #include <svx/svdorect.hxx>
  28 #include <memory>
  29
  30
  31 // Forward declaration
  32 class SdrView;
  33 class SdrPageWindow;
  34 class SdrControlEventListenerImpl;
  35
  36 namespace sdr::contact {
  37     class ViewContactOfUnoControl;
  38 }
  39
  40
  41 // SdrUnoObj
  42 struct SdrUnoObjDataHolder;
  43 class SVXCORE_DLLPUBLIC SdrUnoObj : public SdrRectObj
  44 {
  45     friend class                SdrPageView;
  46     friend class                SdrControlEventListenerImpl;
  47
  48     std::unique_ptr<SdrUnoObjDataHolder>        m_pImpl;
  49
  50     OUString                    aUnoControlModelTypeName;
  51     OUString                    aUnoControlTypeName;
  52
  53 protected:
  54     css::uno::Reference< css::awt::XControlModel > xUnoControlModel; // Can also be set from outside
  55
  56 private:
  57     SVX_DLLPRIVATE void CreateUnoControlModel(const OUString& rModelName);
  58     SVX_DLLPRIVATE void CreateUnoControlModel(const OUString& rModelName,
  59         const css::uno::Reference< css::lang::XMultiServiceFactory >& rxSFac );
  60
  61 public:
  62     explicit SdrUnoObj(
  63         SdrModel& rSdrModel,
  64         const OUString& rModelName);
  65     // Copy constructor
  66     SdrUnoObj(SdrModel& rSdrModel, SdrUnoObj const & rSource);
  67     SdrUnoObj(
  68         SdrModel& rSdrModel,
  69         const OUString& rModelName,
  70         const css::uno::Reference< css::lang::XMultiServiceFactory >& rxSFac);
  71     virtual ~SdrUnoObj() override;
  72
  73     virtual void TakeObjInfo(SdrObjTransformInfoRec& rInfo) const override;
  74     virtual SdrObjKind GetObjIdentifier() const override;
  75
  76     virtual rtl::Reference<SdrObject> CloneSdrObject(SdrModel& rTargetModel) const override;
  77     virtual void NbcResize(const Point& rRef, const Fraction& xFact, const Fraction& yFact) override;
  78     virtual void NbcSetLayer(SdrLayerID nLayer) override;
  79
  80     // SpecialDrag support
  81     virtual bool hasSpecialDrag() const override;
  82
  83     virtual OUString TakeObjNameSingul() const override;
  84     virtual OUString TakeObjNamePlural() const override;
  85
  86     virtual void SetContextWritingMode( const sal_Int16 _nContextWritingMode ) override;
  87
  88     const css::uno::Reference< css::awt::XControlModel >& GetUnoControlModel() const {return xUnoControlModel;}
  89     css::uno::Reference< css::awt::XControl > GetUnoControl(const SdrView& _rView, const OutputDevice& _rOut) const;
  90
  91     /** Retrieves a temporary XControl instance for a given output device
  92
  93         The method GetUnoControl, used to retrieve the XControl whose parent is a given device, only works
  94         if the SdrUnoObj has already been painted at least once onto this device. However, there are valid
  95         scenarios where you need certain information on how a control is painted onto a window, without
  96         actually painting it. For example, you might be interested in the DeviceInfo of a UNO control.
  97
  98         For those cases, you can contain an XControl which behaves as the control which *would* be used to
  99         paint onto a window.
 100
 101         @param  _rWindow
 102             the window for which should act as parent for the temporary control
 103         @param  _inout_ControlContainer
 104             the control container belonging to the window, necessary as context
 105             for the newly created control. A control container is usually created by calling
 106             VCLUnoHelper::CreateControlContainer.
 107             If _inout_ControlContainer is <NULL/>, it will be created internally, and passed to the caller.
 108             In this case, the caller also takes ownership of the control container, and is responsible for
 109             disposing it when not needed anymore.
 110         @return
 111             The requested control. This control is temporary only, and the caller is responsible for it.
 112             In particular, the caller is required to dispose it when it's not needed anymore.
 113
 114     */
 115     css::uno::Reference< css::awt::XControl >
 116         GetTemporaryControlForWindow(
 117             const vcl::Window& _rWindow,
 118             css::uno::Reference< css::awt::XControlContainer >& _inout_ControlContainer
 119         ) const;
 120
 121     const OUString& GetUnoControlTypeName() const { return aUnoControlTypeName; }
 122     const OUString& getUnoControlModelTypeName() const { return aUnoControlModelTypeName; }
 123
 124     virtual void SetUnoControlModel( const css::uno::Reference< css::awt::XControlModel >& xModel );
 125
 126 protected:
 127     // SdrObject overridables
 128     virtual std::unique_ptr<sdr::contact::ViewContact> CreateObjectSpecificViewContact() override;
 129
 130 private:
 131     /** Retrieves the typed ViewContact for the object
 132         @param _out_rpContact
 133             Upon successful return, ->_out_rpContact contains the ViewContact.
 134         @return
 135             <TRUE/> if and only if the contact was successfully retrieved. In this case,
 136             ->_out_rpContact contains a pointer to this contact.
 137             A failure to retrieve the contact object fires an assertion in non-product builds.
 138     */
 139     SVX_DLLPRIVATE  bool    impl_getViewContact( sdr::contact::ViewContactOfUnoControl*& _out_rpContact ) const;
 140 };
 141
 142 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */