framework/source/uiconfiguration/ImageList.cxx

   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 #include <osl/file.hxx>
  21 #include <sal/log.hxx>
  22 #include <tools/debug.hxx>
  23 #include <tools/stream.hxx>
  24 #include <vcl/settings.hxx>
  25 #include <vcl/outdev.hxx>
  26 #include <vcl/graph.hxx>
  27 #include <vcl/graphicfilter.hxx>
  28 #include <vcl/svapp.hxx>
  29 #include <vcl/image.hxx>
  30 #include <vcl/imagerepository.hxx>
  31 #include <vcl/ImageTree.hxx>
  32 #include "ImageList.hxx"
  33
  34 ImageList::ImageList()
  35 {
  36 }
  37
  38 ImageList::ImageList(const std::vector< OUString >& rNameVector,
  39                      const OUString& rPrefix)
  40 {
  41     SAL_INFO( "vcl", "vcl: ImageList::ImageList(const vector< OUString >& ..." );
  42
  43     maImages.reserve( rNameVector.size() );
  44
  45     maPrefix = rPrefix;
  46     for( size_t i = 0; i < rNameVector.size(); ++i )
  47         ImplAddImage( rPrefix, rNameVector[ i ], static_cast< sal_uInt16 >( i ) + 1, Image() );
  48 }
  49
  50 // FIXME: Rather a performance hazard
  51 BitmapEx ImageList::GetAsHorizontalStrip() const
  52 {
  53     sal_uInt16 nCount = maImages.size();
  54     if( !nCount )
  55         return BitmapEx();
  56     Size aSize( maImageSize.Width() * nCount, maImageSize.Height() );
  57
  58     BitmapEx aTempl = maImages[ 0 ]->maImage.GetBitmapEx();
  59     BitmapEx aResult( aTempl, Point(), aSize );
  60
  61     tools::Rectangle aSrcRect( Point( 0, 0 ), maImageSize );
  62     for (sal_uInt16 nIdx = 0; nIdx < nCount; nIdx++)
  63     {
  64         tools::Rectangle aDestRect( Point( nIdx * maImageSize.Width(), 0 ),
  65                              maImageSize );
  66         ImageAryData *pData = maImages[ nIdx ].get();
  67         BitmapEx aTmp = pData->maImage.GetBitmapEx();
  68         aResult.CopyPixel( aDestRect, aSrcRect, &aTmp);
  69     }
  70
  71     return aResult;
  72 }
  73
  74 void ImageList::InsertFromHorizontalStrip( const BitmapEx &rBitmapEx,
  75                                            const std::vector< OUString > &rNameVector )
  76 {
  77     sal_uInt16 nItems = sal::static_int_cast< sal_uInt16 >( rNameVector.size() );
  78
  79     if (!nItems)
  80             return;
  81
  82     Size aSize( rBitmapEx.GetSizePixel() );
  83     DBG_ASSERT (rBitmapEx.GetSizePixel().Width() % nItems == 0,
  84                 "ImageList::InsertFromHorizontalStrip - very odd size");
  85     aSize.setWidth( aSize.Width() / nItems );
  86     maImages.clear();
  87     maNameHash.clear();
  88     maImages.reserve( nItems );
  89     maImageSize = aSize;
  90     maPrefix.clear();
  91
  92     for (sal_uInt16 nIdx = 0; nIdx < nItems; nIdx++)
  93     {
  94         BitmapEx aBitmap( rBitmapEx, Point( nIdx * aSize.Width(), 0 ), aSize );
  95         ImplAddImage( maPrefix, rNameVector[ nIdx ], nIdx + 1, Image( aBitmap ) );
  96     }
  97 }
  98
  99 sal_uInt16 ImageList::ImplGetImageId( const OUString& rImageName ) const
 100 {
 101     auto it = maNameHash.find( rImageName );
 102     if (it == maNameHash.end())
 103         return 0;
 104     return it->second->mnId;
 105 }
 106
 107 void ImageList::AddImage( const OUString& rImageName, const Image& rImage )
 108 {
 109     SAL_WARN_IF( GetImagePos( rImageName ) != IMAGELIST_IMAGE_NOTFOUND, "vcl", "ImageList::AddImage() - ImageName already exists" );
 110
 111     ImplAddImage( maPrefix, rImageName, GetImageCount() + 1, rImage );
 112 }
 113
 114 void ImageList::ReplaceImage( const OUString& rImageName, const Image& rImage )
 115 {
 116     const sal_uInt16 nId = ImplGetImageId( rImageName );
 117
 118     if( nId )
 119     {
 120         // Just replace the bitmap rather than doing RemoveImage / AddImage
 121         // which breaks index-based iteration.
 122         ImageAryData *pImg = maNameHash[ rImageName ];
 123         pImg->maImage = rImage;
 124     }
 125 }
 126
 127 void ImageList::RemoveImage( sal_uInt16 nId )
 128 {
 129     for( size_t i = 0; i < maImages.size(); ++i )
 130     {
 131         if( maImages[ i ]->mnId == nId )
 132         {
 133             ImplRemoveImage( static_cast< sal_uInt16 >( i ) );
 134             break;
 135         }
 136     }
 137 }
 138
 139 Image ImageList::GetImage( const OUString& rImageName ) const
 140 {
 141     auto it = maNameHash.find( rImageName );
 142     if (it == maNameHash.end())
 143         return Image();
 144     return it->second->maImage;
 145 }
 146
 147 sal_uInt16 ImageList::GetImageCount() const
 148 {
 149     return static_cast< sal_uInt16 >( maImages.size() );
 150 }
 151
 152 sal_uInt16 ImageList::GetImagePos( const OUString& rImageName ) const
 153 {
 154     if( !rImageName.isEmpty() )
 155     {
 156         for( size_t i = 0; i < maImages.size(); i++ )
 157         {
 158             if (maImages[i]->maName == rImageName)
 159                 return static_cast< sal_uInt16 >( i );
 160         }
 161     }
 162
 163     return IMAGELIST_IMAGE_NOTFOUND;
 164 }
 165
 166 sal_uInt16 ImageList::GetImageId( sal_uInt16 nPos ) const
 167 {
 168     return maImages[ nPos ]->mnId;
 169 }
 170
 171 OUString ImageList::GetImageName( sal_uInt16 nPos ) const
 172 {
 173     return maImages[ nPos ]->maName;
 174 }
 175
 176 void ImageList::GetImageNames( std::vector< OUString >& rNames ) const
 177 {
 178     SAL_INFO( "vcl", "vcl: ImageList::GetImageNames" );
 179
 180     rNames = std::vector< OUString >();
 181
 182     for(auto const & pImage : maImages)
 183     {
 184         const OUString& rName( pImage->maName );
 185         if( !rName.isEmpty())
 186             rNames.push_back( rName );
 187     }
 188 }
 189
 190 void ImageList::ImplAddImage( const OUString &aPrefix, const OUString &aName,
 191                               sal_uInt16 nId, const Image &aImage )
 192 {
 193     Image aInsert = aImage;
 194     if (!aInsert)
 195         aInsert = Image( "private:graphicrepository/" + aPrefix + aName );
 196
 197     ImageAryData *pImg = new ImageAryData{ aName, nId, aInsert };
 198     maImages.emplace_back( pImg );
 199     if( !aName.isEmpty() )
 200         maNameHash [ aName ] = pImg;
 201 }
 202
 203 void ImageList::ImplRemoveImage( sal_uInt16 nPos )
 204 {
 205     ImageAryData *pImg = maImages[ nPos ].get();
 206     if( !pImg->maName.isEmpty() )
 207         maNameHash.erase( pImg->maName );
 208     maImages.erase( maImages.begin() + nPos );
 209 }
 210
 211 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */