tdegraphics/kolourpaint/views/kpzoomedthumbnailview.h

/*
   Copyright (c) 2003,2004,2005 Clarence Dang <dang@kde.org>
   All rights reserved.

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

   1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.

   THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
   IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/


#ifndef KP_ZOOMED_THUMBNAIL_VIEW_H
#define KP_ZOOMED_THUMBNAIL_VIEW_H


#include <kpthumbnailview.h>


/**
 * @short Zoomed thumbnail view of a document.
 *
 * This is a zoomed thumbnail view of a document.  Unlike @ref kpZoomedView,
 * it never resizes itself.  Instead, it changes its zoom level to
 * accommodate the display of entire document in the view, while
 * maintaining aspect.
 *
 * Do not call setZoomLevel() nor setOrigin().
 *
 * This class is sealed.  Do not derive from it.
 *
 * @author Clarence Dang <dang@kde.org>
 */
/*sealed*/ class kpZoomedThumbnailView : public kpThumbnailView
{
TQ_OBJECT
  

public:
    /**
     * Constructs a zoomed thumbnail view.
     */
    kpZoomedThumbnailView (kpDocument *document,
            kpToolToolBar *toolToolBar,
            kpViewManager *viewManager,
            kpView *buddyView,
            kpViewScrollableContainer *scrollableContainer,
            TQWidget *parent, const char *name);

    /**
     * Destructs a zoomed thumbnail view.
     */
    virtual ~kpZoomedThumbnailView ();


    /**
     * Implements @ref kpThumbnailView.
     */
    TQString caption () const;


public slots:
    /**
     * Changes its zoom level to accommodate the display of entire document
     * in the view.  It maintains aspect by changing the origin and mask.
     *
     * Call this if the size of the document changes.
     * Already called by @ref kpThumbnailView resizeEvent().
     *
     * Implements @ref kpView.
     */
    virtual void adjustToEnvironment ();


private:
    struct kpZoomedThumbnailViewPrivate *d;
};


#endif  // KP_ZOOMED_THUMBNAIL_VIEW_H