include/vcl/ImageTree.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 #ifndef INCLUDED_INCLUDE_VCL_IMAGETREE_HXX
  21 #define INCLUDED_INCLUDE_VCL_IMAGETREE_HXX
  22
  23 #include <memory>
  24 #include <sal/config.h>
  25 #include <vcl/dllapi.h>
  26 #include <rtl/ustring.hxx>
  27 #include <o3tl/typed_flags_set.hxx>
  28
  29 namespace com::sun::star::uno { template <class interface_type> class Reference; }
  30
  31 enum class ImageLoadFlags : sal_uInt16
  32 {
  33     NONE                = 0,
  34     IgnoreScalingFactor = 1,
  35     IgnoreDarkTheme     = 2,
  36 };
  37
  38 namespace o3tl {
  39 template<> struct typed_flags<ImageLoadFlags>: is_typed_flags<ImageLoadFlags, 0x3> {};
  40 }
  41
  42 namespace com::sun::star::container {
  43     class XNameAccess;
  44 }
  45
  46 namespace com::sun::star::io {
  47     class XInputStream;
  48 }
  49
  50 class ImplImageTree;
  51 class BitmapEx;
  52 class SvMemoryStream;
  53
  54 class ImageTree
  55 {
  56 private:
  57     std::unique_ptr<ImplImageTree> mpImplImageTree;
  58
  59 public:
  60     ImageTree();
  61
  62     VCL_DLLPUBLIC static ImageTree & get();
  63
  64     VCL_DLLPUBLIC OUString getImageUrl(
  65         OUString const & name, OUString const & style, OUString const & lang);
  66
  67     VCL_DLLPUBLIC std::shared_ptr<SvMemoryStream> getImageStream(
  68         OUString const & rName, OUString const & rStyle, OUString const & rLang);
  69
  70     VCL_DLLPUBLIC css::uno::Reference<css::io::XInputStream> getImageXInputStream(OUString const & rName,
  71         OUString const & rStyle, OUString const & rLang);
  72
  73     VCL_DLLPUBLIC bool loadImage(
  74         OUString const & name, OUString const & style,
  75         BitmapEx & bitmap, bool localized,
  76         const ImageLoadFlags eFlags = ImageLoadFlags::NONE);
  77
  78     VCL_DLLPUBLIC bool loadImage(
  79         OUString const & name, OUString const & style,
  80         BitmapEx & bitmap, bool localized,
  81         sal_Int32 nScalePercentage,
  82         const ImageLoadFlags eFlags = ImageLoadFlags::NONE);
  83
  84     VCL_DLLPUBLIC css::uno::Reference<css::container::XNameAccess> const & getNameAccess();
  85
  86
  87     /** a crude form of life cycle control (called from DeInitVCL; otherwise,
  88      *  if the ImplImageTree singleton were destroyed during exit that would
  89      *  be too late for the destructors of the bitmaps in maIconCache)*/
  90     VCL_DLLPUBLIC void shutdown();
  91 };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */