office-gobmx/include/comphelper/types.hxx
Noel Grandin 451a66438a use more concrete UNO types in chart2
Change-Id: Id2d58ad76b6e8ff569bd7b65f86a7fdd0152f3d5
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/173324
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2024-09-13 18:51:41 +02:00

98 lines
3.6 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 INCLUDED_COMPHELPER_TYPES_HXX
#define INCLUDED_COMPHELPER_TYPES_HXX
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/lang/XComponent.hpp>
#include <comphelper/comphelperdllapi.h>
#include <rtl/ref.hxx>
namespace com::sun::star::awt {
struct FontDescriptor;
}
namespace com::sun::star::uno { class Any; }
namespace com::sun::star::uno { class XInterface; }
namespace comphelper
{
/// returns sal_True if objects of the types given are "compatible"
COMPHELPER_DLLPUBLIC bool isAssignableFrom(const css::uno::Type& _rAssignable, const css::uno::Type& _rFrom);
/** ask the given object for an XComponent interface and dispose on it
*/
template <class TYPE>
void disposeComponent(css::uno::Reference<TYPE>& _rxComp)
{
css::uno::Reference<css::lang::XComponent> xComp(_rxComp, css::uno::UNO_QUERY);
if (xComp.is())
{
xComp->dispose();
_rxComp = nullptr;
}
}
template <class TYPE>
void disposeComponent(rtl::Reference<TYPE>& _rxComp)
{
if (_rxComp.is())
{
_rxComp->dispose();
_rxComp = nullptr;
}
}
/** get a css::awt::FontDescriptor that is fully initialized with
the XXX_DONTKNOW enum values (which isn't the case if you instantiate it
via the default constructor)
*/
COMPHELPER_DLLPUBLIC css::awt::FontDescriptor getDefaultFont();
/** examine a sequence for the com.sun.star.uno::Type of its elements.
*/
COMPHELPER_DLLPUBLIC css::uno::Type getSequenceElementType(const css::uno::Type& _rSequenceType);
//= replacement of the former UsrAny.getXXX methods
// may be used if you need the return value just as temporary, else it's may be too inefficient...
// no, we don't use templates here. This would lead to a lot of implicit uses of the conversion methods,
// which would be difficult to trace...
COMPHELPER_DLLPUBLIC sal_Int64 getINT64(const css::uno::Any& _rAny);
COMPHELPER_DLLPUBLIC sal_Int32 getINT32(const css::uno::Any& _rAny);
COMPHELPER_DLLPUBLIC sal_Int16 getINT16(const css::uno::Any& _rAny);
COMPHELPER_DLLPUBLIC double getDouble(const css::uno::Any& _rAny);
COMPHELPER_DLLPUBLIC float getFloat(const css::uno::Any& _rAny);
COMPHELPER_DLLPUBLIC OUString getString(const css::uno::Any& _rAny);
COMPHELPER_DLLPUBLIC bool getBOOL(const css::uno::Any& _rAny);
/// @throws css::lang::IllegalArgumentException
COMPHELPER_DLLPUBLIC sal_Int32 getEnumAsINT32(const css::uno::Any& _rAny);
} // namespace comphelper
#endif // INCLUDED_COMPHELPER_TYPES_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */