khtml/imload/animprovider.h

   1 /*
   2     Large image displaying library.
   3
   4     Copyright (C) 2004 Maks Orlovich (maksim@kde.org)
   5
   6     Permission is hereby granted, free of charge, to any person obtaining a copy
   7     of this software and associated documentation files (the "Software"), to deal
   8     in the Software without restriction, including without limitation the rights
   9     to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10     copies of the Software, and to permit persons to whom the Software is
  11     furnished to do so, subject to the following conditions:
  12
  13     The above copyright notice and this permission notice shall be included in
  14     all copies or substantial portions of the Software.
  15
  16     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  19     AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  20     AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  21     CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22
  23 */
  24
  25 #ifndef ANIM_PROVIDER_H
  26 #define ANIM_PROVIDER_H
  27
  28 #include <khtml_settings.h>
  29
  30 class QPainter;
  31
  32 namespace khtmlImLoad {
  33
  34 class PixmapPlane;
  35 class Image;
  36
  37 /**
  38  A base class for animation support. This should be implemented by decoders
  39  wishing to implement animation. When this is installed, paint events
  40  for the image are redirected here.
  41 */
  42 class AnimProvider
  43 {
  44 protected:
  45     PixmapPlane* frame0;
  46     PixmapPlane* curFrame;
  47     Image*       image;
  48     bool         shouldSwitchFrame; //Set by AnimTimer
  49     KHTMLSettings::KAnimationAdvice animationAdvice;
  50
  51     void nextFrame(); //Helper that goes to next frame or wraps around
  52 public:
  53     AnimProvider(PixmapPlane* plane, Image* img):frame0(plane), curFrame(plane),
  54                                      image(img), shouldSwitchFrame(false),
  55                                      animationAdvice(KHTMLSettings::KAnimationEnabled)
  56     {}
  57
  58     void switchFrame();
  59
  60     virtual ~AnimProvider();
  61
  62     //Must be implemented to create animation provider for the given
  63     //plane describing the same animation
  64     virtual AnimProvider* clone(PixmapPlane* newParentPlane) = 0;
  65
  66     //Must be implemented to paint the given region. Note that clipping to the
  67     //overall canvas will be performed already
  68     virtual void paint(int dx, int dy, QPainter* p, int sx, int sy, int width, int height) = 0;
  69
  70     /**
  71      Enables or disables animations
  72     */
  73     void setShowAnimations(KHTMLSettings::KAnimationAdvice);
  74 };
  75
  76 }
  77
  78 #endif
  79 // kate: indent-width 4; replace-tabs on; tab-width 4; space-indent on;