include/svx/galleryitem.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 #ifndef INCLUDED_SVX_GALLERYITEM_HXX
  20 #define INCLUDED_SVX_GALLERYITEM_HXX
  21
  22 #include <svx/svxdllapi.h>
  23 #include <svl/poolitem.hxx>
  24
  25 #include <com/sun/star/uno/Reference.hxx>
  26
  27 namespace com::sun::star::graphic { class XGraphic; }
  28 namespace com::sun::star::lang { class XComponent; }
  29
  30 // property names map those from css::gallery::GalleryItem
  31 // with exception of "AsLink" and "FilterName"
  32 inline constexpr OUStringLiteral SVXGALLERYITEM_TYPE = u"GalleryItemType";
  33 inline constexpr OUStringLiteral SVXGALLERYITEM_URL = u"URL";
  34 inline constexpr OUStringLiteral SVXGALLERYITEM_FILTER = u"FilterName";
  35 inline constexpr OUStringLiteral SVXGALLERYITEM_DRAWING = u"Drawing";
  36 inline constexpr OUStringLiteral SVXGALLERYITEM_GRAPHIC = u"Graphic";
  37 #define SVXGALLERYITEM_PARAMS   5
  38 inline constexpr OUStringLiteral SVXGALLERYITEM_ARGNAME = u"GalleryItem";
  39
  40 class SVXCORE_DLLPUBLIC SvxGalleryItem final : public SfxPoolItem
  41 {
  42     sal_Int8 m_nType;
  43     OUString m_aURL;
  44     css::uno::Reference< css::lang::XComponent > m_xDrawing;
  45     css::uno::Reference< css::graphic::XGraphic > m_xGraphic;
  46
  47 public:
  48     static SfxPoolItem* CreateDefault();
  49
  50     SvxGalleryItem();
  51     SvxGalleryItem( const SvxGalleryItem& );
  52     virtual ~SvxGalleryItem() override;
  53
  54     sal_Int8 GetType() const { return m_nType; }
  55     const OUString& GetURL() const { return m_aURL; }
  56     const css::uno::Reference< css::graphic::XGraphic >& GetGraphic() const { return m_xGraphic; }
  57
  58     // pure virtual methods from SfxPoolItem
  59     virtual bool         operator==( const SfxPoolItem& ) const override;
  60     virtual SvxGalleryItem* Clone( SfxItemPool *pPool = nullptr ) const override;
  61     // bridge to UNO
  62     virtual bool         QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  63     virtual bool         PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  64 };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */