include/vcl/BitmapPalette.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 #pragma once
  21
  22 #include <vcl/dllapi.h>
  23 #include <vcl/BitmapColor.hxx>
  24 #include <vcl/checksum.hxx>
  25 #include <o3tl/cow_wrapper.hxx>
  26
  27 #include <array>
  28
  29 class ImplBitmapPalette;
  30
  31 class VCL_DLLPUBLIC BitmapPalette
  32 {
  33     friend class SalBitmap;
  34     friend class BitmapAccess;
  35
  36 public:
  37
  38     SAL_DLLPRIVATE const BitmapColor* ImplGetColorBuffer() const;
  39
  40     SAL_DLLPRIVATE BitmapColor* ImplGetColorBuffer();
  41
  42     SAL_DLLPRIVATE BitmapChecksum GetChecksum() const;
  43
  44     BitmapPalette();
  45     BitmapPalette( const BitmapPalette& );
  46     SAL_DLLPRIVATE BitmapPalette( BitmapPalette&& ) noexcept;
  47     BitmapPalette(std::initializer_list<BitmapColor> aBitmapColor);
  48     template <size_t N> BitmapPalette(const std::array<BitmapColor, N>& colors);
  49     explicit BitmapPalette(sal_uInt16 nCount);
  50     ~BitmapPalette();
  51
  52     BitmapPalette& operator=( const BitmapPalette& );
  53     SAL_DLLPRIVATE BitmapPalette& operator=( BitmapPalette&& ) noexcept;
  54
  55     bool operator==( const BitmapPalette& rBitmapPalette ) const;
  56     bool operator!=(const BitmapPalette& rBitmapPalette) const
  57     {
  58         return !( *this == rBitmapPalette );
  59     }
  60     bool operator!() const;
  61
  62     sal_uInt16 GetEntryCount() const;
  63     void SetEntryCount(sal_uInt16 nCount);
  64
  65     const BitmapColor& operator[](sal_uInt16 nIndex) const;
  66     BitmapColor& operator[](sal_uInt16 nIndex);
  67
  68     /// Returns the BitmapColor (i.e. palette index) that is either an exact match
  69     /// of the required color, or failing that, the entry that is the closest i.e. least error
  70     /// as measured by Color::GetColorError.
  71     sal_uInt16 GetBestIndex(const BitmapColor& rCol) const;
  72     /// Returns the BitmapColor (i.e. palette index) that is an exact match
  73     /// of the required color. Returns SAL_MAX_UINT16 if nothing found.
  74     SAL_DLLPRIVATE sal_uInt16 GetMatchingIndex(const BitmapColor& rCol) const;
  75
  76     /// Returns true if the palette is 8-bit grey palette.
  77     bool IsGreyPalette8Bit() const;
  78     /// Returns true if the palette is a grey palette (may not be 8-bit).
  79     SAL_DLLPRIVATE bool IsGreyPaletteAny() const;
  80
  81     typedef o3tl::cow_wrapper< ImplBitmapPalette > ImplType;
  82
  83 private:
  84     BitmapPalette(const BitmapColor* first, const BitmapColor* last);
  85
  86     ImplType mpImpl;
  87 };
  88
  89 template <size_t N>
  90 BitmapPalette::BitmapPalette(const std::array<BitmapColor, N>& colors)
  91     : BitmapPalette(colors.data(), colors.data() + N)
  92 {
  93 }
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */