include/vcl/animate/AnimationBitmap.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_ANIMATE_ANIMATIONBITMAP_HXX
  21 #define INCLUDED_VCL_ANIMATE_ANIMATIONBITMAP_HXX
  22
  23 #include <vcl/dllapi.h>
  24 #include <vcl/timer.hxx>
  25 #include <vcl/bitmapex.hxx>
  26
  27 enum class Disposal
  28 {
  29     Not,
  30     Back,
  31     Previous
  32 };
  33
  34 struct VCL_DLLPUBLIC AnimationBitmap
  35 {
  36     BitmapEx maBitmapEx;
  37     Point maPositionPixel;
  38     Size maSizePixel;
  39     long mnWait;
  40     Disposal meDisposal;
  41     bool mbUserInput;
  42
  43     AnimationBitmap()
  44         : mnWait(0)
  45         , meDisposal(Disposal::Not)
  46         , mbUserInput(false)
  47     {
  48     }
  49
  50     AnimationBitmap(const BitmapEx& rBitmapEx, const Point& rPositionPixel, const Size& rSizePixel,
  51                     long nWait = 0, Disposal eDisposal = Disposal::Not)
  52         : maBitmapEx(rBitmapEx)
  53         , maPositionPixel(rPositionPixel)
  54         , maSizePixel(rSizePixel)
  55         , mnWait(nWait)
  56         , meDisposal(eDisposal)
  57         , mbUserInput(false)
  58     {
  59     }
  60
  61     bool operator==(const AnimationBitmap& rAnimationBitmap) const
  62     {
  63         return (rAnimationBitmap.maBitmapEx == maBitmapEx
  64                 && rAnimationBitmap.maPositionPixel == maPositionPixel
  65                 && rAnimationBitmap.maSizePixel == maSizePixel && rAnimationBitmap.mnWait == mnWait
  66                 && rAnimationBitmap.meDisposal == meDisposal
  67                 && rAnimationBitmap.mbUserInput == mbUserInput);
  68     }
  69
  70     bool operator!=(const AnimationBitmap& rAnimationBitmap) const
  71     {
  72         return !(*this == rAnimationBitmap);
  73     }
  74
  75     BitmapChecksum GetChecksum() const;
  76 };
  77
  78 #endif // INCLUDED_VCL_ANIMATE_ANIMATIONBITMAP_HXX
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */