KDE PIM / Developers / API Docs / libkdepim

KPIM::KPixmapRegionSelectorWidget Class Reference

KPixmapRegionSelectorWidget is a widget that shows a picture and provides the user with a friendly way to select a rectangular subregion of the pixmap. More...

#include <kpixmapregionselectorwidget.h>

Inherits QWidget.

List of all members.

Public Slots

Public Member Functions

Protected Member Functions


Detailed Description

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 kdelibs/kdeui, and the other copy is in kdepim/libkdepim This is because kdepim 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


Constructor & Destructor Documentation

KPixmapRegionSelectorWidget::KPixmapRegionSelectorWidget QWidget *  parent = 0L,
const char *  name = 0L
 

Constructor for a KPixmapRegionSelectorWidget.

KPixmapRegionSelectorWidget::~KPixmapRegionSelectorWidget  ) 
 

Destructor for a KPixmapRegionSelectorWidget.


Member Function Documentation

void KPixmapRegionSelectorWidget::setPixmap const QPixmap &  pixmap  ) 
 

Sets the pixmap which will be shown for the user to select a region from.

Parameters:
pixmap The pixmap. Must be non-null.

QPixmap KPIM::KPixmapRegionSelectorWidget::pixmap  )  const [inline]
 

Returns:
the original whole pixmap that we're using in this widget as the pixmap the user is selecting a region from.

void KPixmapRegionSelectorWidget::setSelectedRegion const QRect &  rect  ) 
 

Sets the selected region to be rect (in zoomed pixmap coordinates).

QRect KPixmapRegionSelectorWidget::selectedRegion  )  const
 

Returns the selected region ( in zoomed pixmap coordinates ).

QRect KPixmapRegionSelectorWidget::unzoomedSelectedRegion  )  const
 

Returns the selected region ( in unzoomed, original pixmap coordinates ).

void KPixmapRegionSelectorWidget::resetSelection  ) 
 

Resets the selection to use the whole image.

QImage KPixmapRegionSelectorWidget::selectedImage  )  const
 

Returns:
a QImage object with just the region the user selected from the image

void KPixmapRegionSelectorWidget::setSelectionAspectRatio int  width,
int  height
 

Sets the aspect ration that the selected subimage should have.

The way to select it, is specifying an example valid width and height.

See also:
setFreeSelectionAspectRatio()

void KPixmapRegionSelectorWidget::setFreeSelectionAspectRatio  ) 
 

Allows the user to do a selection which has any aspect ratio.

This is the default.

See also:
setSelectionAspectRatio()

void KPixmapRegionSelectorWidget::setMaximumWidgetSize int  width,
int  height
 

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 KPixmapRegionSelectorWidget::rotate KImageEffect::RotateDirection  direction  ) 
 

Rotates the image as specified by the 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 KPixmapRegionSelectorWidget::rotateClockwise  )  [slot]
 

Rotates the current image 90º clockwise.

void KPixmapRegionSelectorWidget::rotateCounterclockwise  )  [slot]
 

Rotates the current image 90º counterclockwise.

KPopupMenu * KPixmapRegionSelectorWidget::createPopupMenu  )  [protected, virtual]
 

Creates a KPopupMenu with the menu that appears when clicking with the right button on the label.


The documentation for this class was generated from the following files: