KPixmapRegionSelectorDialog Class
A dialog that uses a KPixmapRegionSelectorWidget to allow the user to select a region of an image. More...
| Header: | #include <KPixmapRegionSelectorDialog> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS WidgetsAddons)target_link_libraries(mytarget PRIVATE KF6::WidgetsAddons) |
| Inherits: | QDialog |
Public Functions
| KPixmapRegionSelectorDialog(QWidget *parent = nullptr) | |
(since 4.4.3) void | adjustRegionSelectorWidgetSizeToFitScreen() |
| KPixmapRegionSelectorWidget * | pixmapRegionSelectorWidget() const |
Static Public Members
| QImage | getSelectedImage(const QPixmap &pixmap, QWidget *parent = nullptr) |
| QImage | getSelectedImage(const QPixmap &pixmap, int aspectRatioWidth, int aspectRatioHeight, QWidget *parent = nullptr) |
| QRect | getSelectedRegion(const QPixmap &pixmap, QWidget *parent = nullptr) |
| QRect | getSelectedRegion(const QPixmap &pixmap, int aspectRatioWidth, int aspectRatioHeight, QWidget *parent = nullptr) |
Detailed Description
If you want to use special features like forcing the selected area to have a fixed aspect ratio, you can use pixmapRegionSelectorWidget() to get the pointer to the KPixmapRegionSelectorWidget 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.
Member Function Documentation
[explicit] KPixmapRegionSelectorDialog::KPixmapRegionSelectorDialog(QWidget *parent = nullptr)
The constructor of an empty KPixmapRegionSelectorDialog, you have to call later the setPixmap method of the KPixmapRegionSelectorWidget widget of the new object.
[since 4.4.3] void KPixmapRegionSelectorDialog::adjustRegionSelectorWidgetSizeToFitScreen()
Adjusts the size of the KPixmapRegionSelectorWidget to not overflow the screen size
This function was introduced in 4.4.3.
[static] QImage KPixmapRegionSelectorDialog::getSelectedImage(const QPixmap &pixmap, QWidget *parent = nullptr)
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.
[static] QImage KPixmapRegionSelectorDialog::getSelectedImage(const QPixmap &pixmap, int aspectRatioWidth, int aspectRatioHeight, QWidget *parent = nullptr)
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.
[static] QRect KPixmapRegionSelectorDialog::getSelectedRegion(const QPixmap &pixmap, QWidget *parent = nullptr)
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.
[static] QRect KPixmapRegionSelectorDialog::getSelectedRegion(const QPixmap &pixmap, int aspectRatioWidth, int aspectRatioHeight, QWidget *parent = nullptr)
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.
KPixmapRegionSelectorWidget *KPixmapRegionSelectorDialog::pixmapRegionSelectorWidget() const
Returns the KPixmapRegionSelectorWidget widget so that additional parameters can be set by using it.