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 <vcl/bitmapex.hxx>
  27
  28 enum class ImageLoadFlags : sal_uInt16
  29 {
  30     NONE                = 0,
  31     IgnoreScalingFactor = 1,
  32     IgnoreDarkTheme     = 2,
  33 };
  34
  35 namespace o3tl {
  36 template<> struct typed_flags<ImageLoadFlags>: is_typed_flags<ImageLoadFlags, 0x3> {};
  37 }
  38
  39 namespace com { namespace sun { namespace star { namespace container {
  40     class XNameAccess;
  41 }}}}
  42
  43 class ImplImageTree;
  44
  45 class ImageTree
  46 {
  47 private:
  48     std::unique_ptr<ImplImageTree> mpImplImageTree;
  49
  50 public:
  51     ImageTree();
  52
  53     VCL_DLLPUBLIC static ImageTree & get();
  54
  55     VCL_DLLPUBLIC OUString getImageUrl(
  56         OUString const & name, OUString const & style, OUString const & lang);
  57
  58     VCL_DLLPUBLIC bool loadImage(
  59         OUString const & name, OUString const & style,
  60         BitmapEx & bitmap, bool localized,
  61         const ImageLoadFlags eFlags = ImageLoadFlags::NONE);
  62
  63     VCL_DLLPUBLIC css::uno::Reference<css::container::XNameAccess> getNameAccess();
  64
  65
  66     /** a crude form of life cycle control (called from DeInitVCL; otherwise,
  67      *  if the ImplImageTree singleton were destroyed during exit that would
  68      *  be too late for the destructors of the bitmaps in maIconCache)*/
  69     void shutdown();
  70 };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */