include/vcl/imagerepository.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_VCL_IMAGEREPOSITORY_HXX
  21 #define INCLUDED_VCL_IMAGEREPOSITORY_HXX
  22
  23 #include <vcl/dllapi.h>
  24 #include <rtl/ustring.hxx>
  25
  26 class BitmapEx;
  27
  28
  29 namespace vcl
  30 {
  31
  32
  33
  34     //= ImageRepository
  35
  36     // provides access to the application's image repository (image.zip)
  37     class VCL_DLLPUBLIC ImageRepository
  38     {
  39     public:
  40         /** loads an image from the application's image repository
  41             @param  _rName
  42                 the name of the image to load.
  43             @param  _out_rImage
  44                 will take the image upon successful return.
  45             @param  bSearchLanguageDependent
  46                 determines whether a language-dependent image is to be searched.
  47             @return
  48                 whether or not the image could be loaded successfully.
  49         */
  50         static bool loadImage(
  51             const OUString& _rName,
  52             BitmapEx& _out_rImage,
  53             bool bSearchLanguageDependent,
  54             bool loadMissing = false
  55         );
  56
  57         static bool loadDefaultImage(
  58             BitmapEx& _out_rImage
  59         );
  60     };
  61
  62
  63 } // namespace vcl
  64
  65
  66 #endif // INCLUDED_VCL_IMAGEREPOSITORY_HXX
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */