File indexing completed on 2024-05-05 04:21:19

0001 
0002 /*
0003    Copyright (c) 2003-2007 Clarence Dang <dang@kde.org>
0004    All rights reserved.
0005 
0006    Redistribution and use in source and binary forms, with or without
0007    modification, are permitted provided that the following conditions
0008    are met:
0009 
0010    1. Redistributions of source code must retain the above copyright
0011       notice, this list of conditions and the following disclaimer.
0012    2. Redistributions in binary form must reproduce the above copyright
0013       notice, this list of conditions and the following disclaimer in the
0014       documentation and/or other materials provided with the distribution.
0015 
0016    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
0017    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
0018    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
0019    IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
0020    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
0021    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0022    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0023    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0024    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
0025    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0026 */
0027 
0028 
0029 #ifndef KP_THUMBNAIL_VIEW_H
0030 #define KP_THUMBNAIL_VIEW_H
0031 
0032 
0033 #include "views/kpView.h"
0034 
0035 
0036 /**
0037  * @short Abstract base class for all thumbnail views.
0038  *
0039  * @author Clarence Dang <dang@kde.org>
0040  */
0041 class kpThumbnailView : public kpView
0042 {
0043 Q_OBJECT
0044 
0045 public:
0046     /**
0047      * Constructs a thumbnail view.
0048      *
0049      * You must call adjustEnvironment() at the end of your constructor.
0050      */
0051     kpThumbnailView (kpDocument *document,
0052                      kpToolToolBar *toolToolBar,
0053                      kpViewManager *viewManager,
0054                      kpView *buddyView,
0055                      kpViewScrollableContainer *scrollableContainer,
0056                      QWidget *parent);
0057 
0058     /**
0059      * Destructs this thumbnail view.
0060      */
0061     ~kpThumbnailView () override;
0062 
0063 
0064     /**
0065      * @returns the caption to display in an enclosing thumbnail window.
0066      */
0067     virtual QString caption () const = 0;
0068 
0069 
0070 protected:
0071     /**
0072      * Sets the mask to cover the rectangle with top-left, origin() and
0073      * dimensions equal to or slightly less than (in case of rounding
0074      * error) the size of the document in view coordinates.  This ensures
0075      * that all pixels are initialised with either document pixels or the
0076      * standard widget background.
0077      */
0078     void setMaskToCoverDocument ();
0079 
0080 
0081     /**
0082      * Calls adjustToEnvironment() in response to a resize event.
0083      *
0084      * Extends @ref kpView.
0085      */
0086     void resizeEvent (QResizeEvent *e) override;
0087 };
0088 
0089 
0090 #endif  // KP_THUMBNAIL_VIEW_H