You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdelibs/tdeui/kpixmapregionselectorwidget.h

171 lines
4.9 KiB

/* This file is part of the KDE libraries
Copyright (C) 2004 Antonio Larrosa <larrosa@kde.org
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef __KPIXMAPREGIONSELECTORWIDGET_H__
#define __KPIXMAPREGIONSELECTORWIDGET_H__
#include <tqvbox.h>
#include <tqpixmap.h>
#include <tqrect.h>
#include <tqlabel.h>
#include <kimageeffect.h>
class KPopupMenu;
#include <tdelibs_export.h>
/**
* KPixmapRegionSelectorWidget is a widget that shows a picture and provides the
* user with a friendly way to select a rectangular subregion of the pixmap.
*
* NOTE: There are two copies of this .h and the .cpp file, with subtle differences.
* One copy is in tdelibs/tdeui, and the other copy is in tdepim/libtdepim
* This is because tdepim has to remain backwards compatible. Any changes
* to either file should be made to the other.
*
* @author Antonio Larrosa <larrosa@kde.org>
* @since 3.4
*/
class TDEUI_EXPORT KPixmapRegionSelectorWidget : public TQWidget
{
Q_OBJECT
public:
/**
* Constructor for a KPixmapRegionSelectorWidget.
*/
KPixmapRegionSelectorWidget( TQWidget *parent = 0L, const char *name=0L);
/**
* Destructor for a KPixmapRegionSelectorWidget
*/
~KPixmapRegionSelectorWidget();
/**
* Sets the pixmap which will be shown for the user to select a region from.
* @param pixmap The pixmap. Must be non-null.
*
*/
void setPixmap( const TQPixmap &pixmap );
/**
* @return the original whole pixmap that we're using in this widget as the
* pixmap the user is selecting a region from.
*/
TQPixmap pixmap() const { return m_unzoomedPixmap; }
/**
* Sets the selected region to be @p rect (in zoomed pixmap coordinates)
*/
void setSelectedRegion(const TQRect &rect);
/**
* Returns the selected region ( in zoomed pixmap coordinates )
*/
TQRect selectedRegion() const;
/**
* Returns the selected region ( in unzoomed, original pixmap coordinates )
*/
TQRect unzoomedSelectedRegion() const;
/**
* Resets the selection to use the whole image
*/
void resetSelection();
/**
* @returns a TQImage object with just the region the user selected from the
* image
*/
TQImage selectedImage() const;
/**
* Sets the aspect ration that the selected subimage should have. The way to
* select it, is specifying an example valid @p width and @p height.
* @see setFreeSelectionAspectRatio()
*/
void setSelectionAspectRatio(int width, int height);
/**
* Allows the user to do a selection which has any aspect ratio. This is
* the default.
* @see setSelectionAspectRatio()
*/
void setFreeSelectionAspectRatio();
/**
* Sets the maximum size for the widget. If the image is larger than this
* (either horizontally or vertically), it's scaled to adjust to the maximum
* size (preserving the aspect ratio)
*/
void setMaximumWidgetSize( int width, int height );
/**
* Rotates the image as specified by the @p direction parameter, also tries
* to rotate the selected region so that it doesn't change, as long as the
* forced aspect ratio setting is respected, in other case, the selected region
* is resetted.
*/
void rotate(KImageEffect::RotateDirection direction);
public slots:
/**
* Rotates the current image 90º clockwise
*/
void rotateClockwise();
/**
* Rotates the current image 90º counterclockwise
*/
void rotateCounterclockwise();
protected:
/**
* Creates a KPopupMenu with the menu that appears when clicking with the right button on the label
*/
virtual KPopupMenu *createPopupMenu();
private:
bool eventFilter(TQObject *obj, TQEvent *ev);
/**
* Recalculates the pixmap that is shown based on the current selected area,
* the original image, etc.
*/
void updatePixmap();
TQRect calcSelectionRectangle( const TQPoint &startPoint, const TQPoint & endPoint );
enum CursorState { None=0, Resizing, Moving };
CursorState m_state;
TQPixmap m_unzoomedPixmap;
TQPixmap m_originalPixmap;
TQPixmap m_linedPixmap;
TQRect m_selectedRegion;
TQLabel *m_label;
TQPoint m_tempFirstClick;
double m_forcedAspectRatio;
int m_maxWidth, m_maxHeight;
double m_zoomFactor;
};
#endif