kolourpaint/layers/tempImage/kpTempImage.h

   1
   2 /*
   3    Copyright (c) 2003-2007 Clarence Dang <dang@kde.org>
   4    All rights reserved.
   5
   6    Redistribution and use in source and binary forms, with or without
   7    modification, are permitted provided that the following conditions
   8    are met:
   9
  10    1. Redistributions of source code must retain the above copyright
  11       notice, this list of conditions and the following disclaimer.
  12    2. Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in the
  14       documentation and/or other materials provided with the distribution.
  15
  16    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19    IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 */
  27
  28 // REFACTOR: maybe make us and kpAbstractSelection share a new kpLayer base?
  29
  30
  31 #ifndef kpTempImage_H
  32 #define kpTempImage_H
  33
  34
  35 #include <qpoint.h>
  36
  37 #include <kpImage.h>
  38
  39
  40 class kpViewManager;
  41
  42
  43 class kpTempImage
  44 {
  45 public:
  46     // REFACTOR: Extract into class hierarchy.
  47     enum RenderMode
  48     {
  49         SetImage,
  50         PaintImage,
  51         UserFunction
  52     };
  53
  54     // REFACTOR: Function pointers imply a need for a proper class hierarchy.
  55     typedef void (*UserFunctionType) (kpImage * /*destImage*/,
  56         const QPoint & /*topLeft*/,
  57         void * /*userData*/);
  58
  59     /*
  60      * <isBrush>    Specifies that its visibility is dependent on whether or
  61      *              not the mouse cursor is inside a view.  If false, the
  62      *              image is always displayed.
  63      *
  64      * <userFunction>   This is the only way of specifying the "UserFunction"
  65      *                  <renderMode>.  <userFunction> must not draw outside
  66      *                  the claimed rectangle.
  67      */
  68     kpTempImage (bool isBrush, RenderMode renderMode, const QPoint &topLeft, const kpImage &image);
  69     kpTempImage (bool isBrush, const QPoint &topLeft,
  70         UserFunctionType userFunction, void *userData,
  71         int width, int height);
  72     kpTempImage (const kpTempImage &rhs);
  73     kpTempImage &operator= (const kpTempImage &rhs);
  74     ~kpTempImage ();
  75
  76     bool isBrush () const;
  77     RenderMode renderMode () const;
  78     QPoint topLeft () const;
  79     kpImage image () const;
  80     UserFunctionType userFunction () const;
  81     void *userData () const;
  82
  83     bool isVisible (const kpViewManager *vm) const;
  84     QRect rect () const;
  85     int width () const;
  86     int height () const;
  87
  88
  89     // Returns whether a call to paint() may add a mask to <*destImage>.
  90     bool paintMayAddMask () const;
  91
  92     /*
  93      * Draws itself onto <*destImage>, given that <*destImage> represents
  94      * the unzoomed <docRect> of the kpDocument.  You should check for
  95      * visibility before calling this function.
  96      */
  97     void paint (kpImage *destImage, const QRect &docRect) const;
  98
  99 private:
 100     bool m_isBrush;
 101     RenderMode m_renderMode;
 102     QPoint m_topLeft;
 103     kpImage m_image;
 104     // == m_image.{width,height}() unless m_renderMode == UserFunction.
 105     int m_width, m_height;
 106     UserFunctionType m_userFunction;
 107     void *m_userData;
 108 };
 109
 110
 111 #endif  // kpTempImage_H