kolourpaint/views/kpUnzoomedThumbnailView.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
  29 #ifndef KP_UNZOOMED_THUMBNAIL_VIEW_H
  30 #define KP_UNZOOMED_THUMBNAIL_VIEW_H
  31
  32
  33 #include <kpThumbnailView.h>
  34
  35
  36 class kpViewScrollableContainer;
  37
  38
  39 /**
  40  * @short Unzoomed thumbnail view of a document.
  41  *
  42  * This is an unzoomed thumbnail view of a document.  Unlike
  43  * @ref kpZoomedThumbnailView, it never changes the zoom level.  And unlike
  44  * @ref kpZoomedView, it never resizes itself.  Instead, it changes its
  45  * origin according to the main view's scrollable container so that the
  46  * top-left most document pixel displayed in the scrollable container will
  47  * be visible.
  48  *
  49  * Do not call setZoomLevel() nor setOrigin().
  50  *
  51  * This class is sealed.  Do not derive from it.
  52  *
  53  * @author Clarence Dang <dang@kde.org>
  54  */
  55 /*sealed*/ class kpUnzoomedThumbnailView : public kpThumbnailView
  56 {
  57 Q_OBJECT
  58
  59 public:
  60     /**
  61      * Constructs an unzoomed thumbnail view.
  62      */
  63     kpUnzoomedThumbnailView (kpDocument *document,
  64             kpToolToolBar *toolToolBar,
  65             kpViewManager *viewManager,
  66             kpView *buddyView,
  67             kpViewScrollableContainer *scrollableContainer,
  68             QWidget *parent);
  69
  70     /**
  71      * Destructs an unzoomed thumbnail view.
  72      */
  73     virtual ~kpUnzoomedThumbnailView ();
  74
  75
  76     /**
  77      * Implements @ref kpThumbnailView.
  78      */
  79     QString caption () const;
  80
  81
  82 public slots:
  83     /**
  84      * Changes its origin according to the main view's scrollable container
  85      * so that the top-left most document pixel displayed in the scrollable
  86      * container will be visible.
  87      *
  88      * It tries to maximise the used area of this view.  Unused areas will
  89      * be set to the widget background thanks to the mask.
  90      *
  91      * Call this if the size of the document changes.
  92      * Already connected to buddyViewScrollableContainer()'s
  93      * contentsMovingSoon(int,int) signal.
  94      * Already called by @ref kpThumbnailView resizeEvent().
  95      *
  96      * Implements @ref kpView.
  97      */
  98     virtual void adjustToEnvironment ();
  99
 100
 101 private:
 102     struct kpUnzoomedThumbnailViewPrivate *d;
 103 };
 104
 105
 106 #endif  // KP_UNZOOMED_THUMBNAIL_VIEW_H