Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
KPIM::KPixmapRegionSelectorDialog Class Reference

#include <kpixmapregionselectordialog.h>

Inherits KDialogBase.

Public Member Functions

 KPixmapRegionSelectorDialog (TQWidget *parent=0L, const char *name=0L, bool modal=false)
 
 ~KPixmapRegionSelectorDialog ()
 
KPIM::KPixmapRegionSelectorWidget * pixmapRegionSelectorWidget () const
 

Static Public Member Functions

static TQRect getSelectedRegion (const TQPixmap &pixmap, TQWidget *parent=0L)
 
static TQRect getSelectedRegion (const TQPixmap &pixmap, int aspectRatioWidth, int aspectRatioHeight, TQWidget *parent=0L)
 
static TQImage getSelectedImage (const TQPixmap &pixmap, TQWidget *parent=0L)
 
static TQImage getSelectedImage (const TQPixmap &pixmap, int aspectRatioWidth, int aspectRatioHeight, TQWidget *parent=0L)
 

Protected Attributes

KPIM::KPixmapRegionSelectorWidget * m_pixmapSelectorWidget
 

Detailed Description

A dialog that uses a KPixmapRegionSelectorWidget 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

See also
pixmapRegionSelectorWidget() to get the pointer to the pixmapRegionSelectorWidget object and set the desired options there.

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.

Author
Antonio Larrosa larro.nosp@m.sa@k.nosp@m.de.or.nosp@m.g
Since
3.4

Definition at line 46 of file kpixmapregionselectordialog.h.

Constructor & Destructor Documentation

◆ KPixmapRegionSelectorDialog()

KPixmapRegionSelectorDialog::KPixmapRegionSelectorDialog ( TQWidget *  parent = 0L,
const char *  name = 0L,
bool  modal = false 
)

The constructor of an empty KPixmapRegionSelectorDialog, you have to call later the setPixmap method of the KPixmapRegionSelectorWidget widget of the new object.

Definition at line 31 of file kpixmapregionselectordialog.cpp.

◆ ~KPixmapRegionSelectorDialog()

KPixmapRegionSelectorDialog::~KPixmapRegionSelectorDialog ( )

The destructor of the dialog.

Definition at line 43 of file kpixmapregionselectordialog.cpp.

Member Function Documentation

◆ getSelectedImage() [1/2]

TQImage KPixmapRegionSelectorDialog::getSelectedImage ( const TQPixmap &  pixmap,
int  aspectRatioWidth,
int  aspectRatioHeight,
TQWidget *  parent = 0L 
)
static

Creates a modal dialog, lets the user to select a region of the pixmap with the same aspect ratio than aspectRatioWidth x aspectRatioHeight and returns when the dialog is closed.

Returns
the selected image, or an invalid image if the user pressed the Cancel button.

Definition at line 110 of file kpixmapregionselectordialog.cpp.

◆ getSelectedImage() [2/2]

TQImage KPixmapRegionSelectorDialog::getSelectedImage ( const TQPixmap &  pixmap,
TQWidget *  parent = 0L 
)
static

Creates a modal dialog, lets the user to select a region of the pixmap and returns when the dialog is closed.

Returns
the selected image, or an invalid image if the user pressed the Cancel button.

Definition at line 90 of file kpixmapregionselectordialog.cpp.

◆ getSelectedRegion() [1/2]

TQRect KPixmapRegionSelectorDialog::getSelectedRegion ( const TQPixmap &  pixmap,
int  aspectRatioWidth,
int  aspectRatioHeight,
TQWidget *  parent = 0L 
)
static

Creates a modal dialog, lets the user to select a region of the pixmap with the same aspect ratio than aspectRatioWidth x aspectRatioHeight and returns when the dialog is closed.

Returns
the selected rectangle, or an invalid rectangle if the user pressed the Cancel button.

Definition at line 68 of file kpixmapregionselectordialog.cpp.

◆ getSelectedRegion() [2/2]

TQRect KPixmapRegionSelectorDialog::getSelectedRegion ( const TQPixmap &  pixmap,
TQWidget *  parent = 0L 
)
static

Creates a modal dialog, lets the user to select a region of the pixmap and returns when the dialog is closed.

Returns
the selected rectangle, or an invalid rectangle if the user pressed the Cancel button.

Definition at line 47 of file kpixmapregionselectordialog.cpp.

◆ pixmapRegionSelectorWidget()

KPIM::KPixmapRegionSelectorWidget * KPIM::KPixmapRegionSelectorDialog::pixmapRegionSelectorWidget ( ) const
inline
Returns
the KPixmapRegionSelectorWidget widget so that additional parameters can be set by using it.

Definition at line 65 of file kpixmapregionselectordialog.h.

Member Data Documentation

◆ m_pixmapSelectorWidget

KPIM::KPixmapRegionSelectorWidget* KPIM::KPixmapRegionSelectorDialog::m_pixmapSelectorWidget
protected

Definition at line 107 of file kpixmapregionselectordialog.h.

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