.TH "KPixmapRegionSelectorDialog" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KPixmapRegionSelectorDialog \- A dialog that uses a \fBKPixmapRegionSelectorWidget\fP to allow the user to select a region of an image.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kpixmapregionselectordialog.h>\fP
.PP
Inherits \fBKDialogBase\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKPixmapRegionSelectorDialog\fP (\fBQWidget\fP *parent=0L, const char *name=0L, bool modal=false)"
.br
.ti -1c
.RI "\fB~KPixmapRegionSelectorDialog\fP ()"
.br
.ti -1c
.RI "\fBKPixmapRegionSelectorWidget\fP * \fBpixmapRegionSelectorWidget\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBQRect\fP \fBgetSelectedRegion\fP (const \fBQPixmap\fP &pixmap, \fBQWidget\fP *parent=0L)"
.br
.ti -1c
.RI "static \fBQRect\fP \fBgetSelectedRegion\fP (const \fBQPixmap\fP &pixmap, int aspectRatioWidth, int aspectRatioHeight, \fBQWidget\fP *parent=0L)"
.br
.ti -1c
.RI "static \fBQImage\fP \fBgetSelectedImage\fP (const \fBQPixmap\fP &pixmap, \fBQWidget\fP *parent=0L)"
.br
.ti -1c
.RI "static \fBQImage\fP \fBgetSelectedImage\fP (const \fBQPixmap\fP &pixmap, int aspectRatioWidth, int aspectRatioHeight, \fBQWidget\fP *parent=0L)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBKPixmapRegionSelectorWidget\fP * \fBm_pixmapSelectorWidget\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A dialog that uses a \fBKPixmapRegionSelectorWidget\fP to allow the user to select a region of an image. 

If you want to use special features like forcing the selected area to have a fixed aspect ratio, you can use 
.PP
\fBSee also:\fP
.RS 4
\fBpixmapRegionSelectorWidget()\fP to get the pointer to the \fBKPixmapRegionSelectorWidget\fP object and set the desired options there.
.RE
.PP
There are some convenience methods that allow to easily show a dialog for the user to select a region of an image, and just care about the selected image.
.PP
\fBAuthor:\fP
.RS 4
Antonio Larrosa <larrosa@kde.org> 
.RE
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 42 of file kpixmapregionselectordialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KPixmapRegionSelectorDialog::KPixmapRegionSelectorDialog (\fBQWidget\fP * parent = \fC0L\fP, const char * name = \fC0L\fP, bool modal = \fCfalse\fP)"
.PP
The constructor of an empty KPixmapRegionSelectorDialog, you have to call later the setPixmap method of the \fBKPixmapRegionSelectorWidget\fP widget of the new object. 
.PP
Definition at line 27 of file kpixmapregionselectordialog.cpp.
.PP
References KDialogBase::setMainWidget().
.SS "KPixmapRegionSelectorDialog::~\fBKPixmapRegionSelectorDialog\fP ()"
.PP
The destructor of the dialog. 
.PP
Definition at line 39 of file kpixmapregionselectordialog.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBKPixmapRegionSelectorWidget\fP* KPixmapRegionSelectorDialog::pixmapRegionSelectorWidget () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
the \fBKPixmapRegionSelectorWidget\fP widget so that additional parameters can be set by using it. 
.RE
.PP

.PP
Definition at line 61 of file kpixmapregionselectordialog.h.
.PP
Referenced by getSelectedImage(), and getSelectedRegion().
.SS "\fBQRect\fP KPixmapRegionSelectorDialog::getSelectedRegion (const \fBQPixmap\fP & pixmap, \fBQWidget\fP * parent = \fC0L\fP)\fC [static]\fP"
.PP
Creates a modal dialog, lets the user to select a region of the \fCpixmap\fP and returns when the dialog is closed. 
.PP
\fBReturns:\fP
.RS 4
the selected rectangle, or an invalid rectangle if the user pressed the Cancel button. 
.RE
.PP

.PP
Definition at line 43 of file kpixmapregionselectordialog.cpp.
.PP
References QDesktopWidget::availableGeometry(), QDialog::exec(), QRect::height(), pixmapRegionSelectorWidget(), KPixmapRegionSelectorWidget::setMaximumWidgetSize(), KPixmapRegionSelectorWidget::setPixmap(), KPixmapRegionSelectorWidget::unzoomedSelectedRegion(), and QRect::width().
.SS "\fBQRect\fP KPixmapRegionSelectorDialog::getSelectedRegion (const \fBQPixmap\fP & pixmap, int aspectRatioWidth, int aspectRatioHeight, \fBQWidget\fP * parent = \fC0L\fP)\fC [static]\fP"
.PP
Creates a modal dialog, lets the user to select a region of the \fCpixmap\fP with the same aspect ratio than \fCaspectRatioWidth\fP x \fCaspectRatioHeight\fP and returns when the dialog is closed. 
.PP
\fBReturns:\fP
.RS 4
the selected rectangle, or an invalid rectangle if the user pressed the Cancel button. 
.RE
.PP

.PP
Definition at line 64 of file kpixmapregionselectordialog.cpp.
.PP
References QDesktopWidget::availableGeometry(), QDialog::exec(), QRect::height(), pixmapRegionSelectorWidget(), KPixmapRegionSelectorWidget::setMaximumWidgetSize(), KPixmapRegionSelectorWidget::setPixmap(), KPixmapRegionSelectorWidget::setSelectionAspectRatio(), KPixmapRegionSelectorWidget::unzoomedSelectedRegion(), and QRect::width().
.SS "\fBQImage\fP KPixmapRegionSelectorDialog::getSelectedImage (const \fBQPixmap\fP & pixmap, \fBQWidget\fP * parent = \fC0L\fP)\fC [static]\fP"
.PP
Creates a modal dialog, lets the user to select a region of the \fCpixmap\fP and returns when the dialog is closed. 
.PP
\fBReturns:\fP
.RS 4
the selected image, or an invalid image if the user pressed the Cancel button. 
.RE
.PP

.PP
Definition at line 86 of file kpixmapregionselectordialog.cpp.
.PP
References QDesktopWidget::availableGeometry(), QDialog::exec(), QRect::height(), pixmapRegionSelectorWidget(), KPixmapRegionSelectorWidget::selectedImage(), KPixmapRegionSelectorWidget::setMaximumWidgetSize(), KPixmapRegionSelectorWidget::setPixmap(), and QRect::width().
.SS "\fBQImage\fP KPixmapRegionSelectorDialog::getSelectedImage (const \fBQPixmap\fP & pixmap, int aspectRatioWidth, int aspectRatioHeight, \fBQWidget\fP * parent = \fC0L\fP)\fC [static]\fP"
.PP
Creates a modal dialog, lets the user to select a region of the \fCpixmap\fP with the same aspect ratio than \fCaspectRatioWidth\fP x \fCaspectRatioHeight\fP and returns when the dialog is closed. 
.PP
\fBReturns:\fP
.RS 4
the selected image, or an invalid image if the user pressed the Cancel button. 
.RE
.PP

.PP
Definition at line 106 of file kpixmapregionselectordialog.cpp.
.PP
References QDesktopWidget::availableGeometry(), QDialog::exec(), QRect::height(), pixmapRegionSelectorWidget(), KPixmapRegionSelectorWidget::selectedImage(), KPixmapRegionSelectorWidget::setMaximumWidgetSize(), KPixmapRegionSelectorWidget::setPixmap(), KPixmapRegionSelectorWidget::setSelectionAspectRatio(), and QRect::width().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
