office-gobmx/include/svx/svdouno.hxx
Caolán McNamara a307e03946 convert TakeObjNamePlural family to OUString
Change-Id: I947e47934677a4f9ced0bfc0db3932bcbbb25f36
2013-07-26 09:01:30 +01:00

155 lines
6.5 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 .
*/
#ifndef _SVDOUNO_HXX
#define _SVDOUNO_HXX
#include <com/sun/star/awt/XControlModel.hpp>
#include <com/sun/star/awt/XControl.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/awt/XControlContainer.hpp>
#include "svx/svxdllapi.h"
#include <svx/svdorect.hxx>
//************************************************************
// Vorausdeklarationen
//************************************************************
class SdrView;
class SdrPageWindow;
class SdrControlEventListenerImpl;
namespace sdr { namespace contact {
class ViewContactOfUnoControl;
}}
//************************************************************
// SdrUnoObj
//************************************************************
struct SdrUnoObjDataHolder;
class SVX_DLLPUBLIC SdrUnoObj : public SdrRectObj
{
friend class SdrPageView;
friend class SdrControlEventListenerImpl;
SdrUnoObjDataHolder* m_pImpl;
String aUnoControlModelTypeName;
String aUnoControlTypeName;
sal_Bool bOwnUnoControlModel;
protected:
::com::sun::star::uno::Reference< com::sun::star::awt::XControlModel > xUnoControlModel; // kann auch von aussen gesetzt werden
private:
SVX_DLLPRIVATE void CreateUnoControlModel(const String& rModelName);
SVX_DLLPRIVATE void CreateUnoControlModel(const String& rModelName,
const ::com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >& rxSFac );
public:
TYPEINFO();
explicit SdrUnoObj(const String& rModelName, sal_Bool bOwnsModel = sal_True);
SdrUnoObj(const String& rModelName,
const ::com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >& rxSFac,
sal_Bool bOwnsModel = sal_True);
virtual ~SdrUnoObj();
virtual void SetPage(SdrPage* pNewPage);
virtual void SetModel(SdrModel* pModel);
virtual void TakeObjInfo(SdrObjTransformInfoRec& rInfo) const;
virtual sal_uInt16 GetObjIdentifier() const;
virtual SdrUnoObj* Clone() const;
SdrUnoObj& operator= (const SdrUnoObj& rObj);
virtual void NbcResize(const Point& rRef, const Fraction& xFact, const Fraction& yFact);
virtual void NbcSetLayer(SdrLayerID nLayer);
// SpecialDrag support
virtual bool hasSpecialDrag() const;
// FullDrag support
virtual bool supportsFullDrag() const;
virtual SdrObject* getFullDragClone() const;
virtual OUString TakeObjNameSingul() const;
virtual OUString TakeObjNamePlural() const;
virtual void SetContextWritingMode( const sal_Int16 _nContextWritingMode );
::com::sun::star::uno::Reference< com::sun::star::awt::XControlModel > GetUnoControlModel() const {return xUnoControlModel;}
::com::sun::star::uno::Reference< com::sun::star::awt::XControl > GetUnoControl(const SdrView& _rView, const OutputDevice& _rOut) const;
/** retrieves a temporary XControl instance for a given output device
The method GetUnoControl, used to retrieve the XControl whose parent is a given device, only works
if the SdrUnoObj has already been painted at least once onto this device. However, there are valid
scenarios where you need certain information on how a control is painted onto a window, without
actually painting it. For example, you might be interested in the DeviceInfo of an UNO control.
For those cases, you can ontain an XControl which behaves as the control which *would* be used to
paint onto a window.
@param _rWindow
the window for which should act as parent for the temporary control
@param _inout_ControlContainer
the control container belonging to the window, necessary as context
for the newly created control. A control container is usually created by calling
VCLUnoHelper::CreateControlContainer.
If _inout_ControlContainer is <NULL/>, it will be created internally, and passed to the caller.
In this case, the caller also takes ownership of the control container, and is responsible for
disposing it when not needed anymore.
@return
The requested control. This control is temporary only, and the caller is responsible for it.
In particular, the caller is required to dispose it when it's not needed anymore.
*/
::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl >
GetTemporaryControlForWindow(
const Window& _rWindow,
::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlContainer >& _inout_ControlContainer
) const;
const String& GetUnoControlModelTypeName() const { return aUnoControlTypeName; }
const String& GetUnoControlTypeName() const { return aUnoControlTypeName; }
virtual void SetUnoControlModel( const ::com::sun::star::uno::Reference< com::sun::star::awt::XControlModel >& xModel );
protected:
// SdrObject overridables
virtual ::sdr::contact::ViewContact* CreateObjectSpecificViewContact();
private:
/** retrieves the typed ViewContact for the object
@param _out_rpContact
Upon successful return, ->_out_rpContact contains the ViewContact.
@return
<TRUE/> if and only if the contact was successfully retrieved. In this case,
->_out_rpContact contains a pointer to this contact.
A failure to retrieve the contact object fires an assertion in non-product builds.
*/
SVX_DLLPRIVATE bool impl_getViewContact( ::sdr::contact::ViewContactOfUnoControl*& _out_rpContact ) const;
};
#endif // _SVDOUNO_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */