ImageList.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#pragma once
 
#include <vcl/image.hxx>
 
#include <string_view>
#include <unordered_map>
#include <vector>
 
// Images identified by either name, or by id
struct ImageAryData
{
    OUString    maName;
    sal_uInt16  mnId;
    Image       maImage;
};
 
 
class ImageList
{
public:
                    explicit ImageList();
                    ImageList( const std::vector<OUString>& rNameVector,
                               const OUString& rPrefix);
 
    void            InsertFromHorizontalStrip( const BitmapEx &rBitmapEx,
                                   const std::vector< OUString > &rNameVector );
    BitmapEx        GetAsHorizontalStrip() const;
    sal_uInt16      GetImageCount() const;
 
    void            AddImage( const OUString& rImageName, const Image& rImage );
 
    void            ReplaceImage( const OUString& rImageName, const Image& rImage );
 
    void            RemoveImage( sal_uInt16 nId );
 
    Image           GetImage( const OUString& rImageName ) const;
 
    sal_uInt16      GetImagePos( std::u16string_view rImageName ) const;
 
    sal_uInt16      GetImageId( sal_uInt16 nPos ) const;
 
    const OUString & GetImageName( sal_uInt16 nPos ) const;
    void            GetImageNames( ::std::vector< OUString >& rNames ) const;
 
private:
 
    std::vector< std::unique_ptr<ImageAryData> >   maImages;
    std::unordered_map< OUString, ImageAryData * > maNameHash;
    OUString               maPrefix;
 
    sal_uInt16  ImplGetImageId( const OUString& rImageName ) const;
    void ImplAddImage( std::u16string_view aPrefix, const OUString &aName, sal_uInt16 nId, const Image &aImage );
    void ImplRemoveImage( sal_uInt16 nPos );
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */