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 <vector>
  26 #include <o3tl/cow_wrapper.hxx>
  27
  28 class ImplBitmapPalette;
  29
  30 class VCL_DLLPUBLIC BitmapPalette
  31 {
  32     friend class SalBitmap;
  33     friend class BitmapAccess;
  34
  35 public:
  36
  37     SAL_DLLPRIVATE const BitmapColor* ImplGetColorBuffer() const;
  38
  39     SAL_DLLPRIVATE BitmapColor* ImplGetColorBuffer();
  40
  41     BitmapChecksum GetChecksum() const;
  42
  43     BitmapPalette();
  44     BitmapPalette( const BitmapPalette& );
  45     BitmapPalette( BitmapPalette&& ) noexcept;
  46     BitmapPalette(std::initializer_list<BitmapColor> aBitmapColor);
  47     explicit BitmapPalette(sal_uInt16 nCount);
  48     ~BitmapPalette();
  49
  50     BitmapPalette& operator=( const BitmapPalette& );
  51     BitmapPalette& operator=( BitmapPalette&& ) noexcept;
  52
  53     bool operator==( const BitmapPalette& rBitmapPalette ) const;
  54     bool operator!=(const BitmapPalette& rBitmapPalette) const
  55     {
  56         return !( *this == rBitmapPalette );
  57     }
  58     bool operator!() const;
  59
  60     sal_uInt16 GetEntryCount() const;
  61     void SetEntryCount(sal_uInt16 nCount);
  62
  63     const BitmapColor& operator[](sal_uInt16 nIndex) const;
  64     BitmapColor& operator[](sal_uInt16 nIndex);
  65
  66     sal_uInt16 GetBestIndex(const BitmapColor& rCol) const;
  67
  68     /// Returns true if the palette is 8-bit grey palette.
  69     bool IsGreyPalette8Bit() const;
  70     /// Returns true if the palette is a grey palette (may not be 8-bit).
  71     bool IsGreyPaletteAny() const;
  72
  73     typedef o3tl::cow_wrapper< ImplBitmapPalette > ImplType;
  74
  75 private:
  76     ImplType mpImpl;
  77 };
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */