Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.

BUG:215923


git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdepim@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 112 insertions, 0 deletions

diff --git a/libkdepim/kpixmapregionselectordialog.h b/libkdepim/kpixmapregionselectordialog.h
new file mode 100644
index 000000000..1108d17ef
--- /dev/null
+++ b/libkdepim/kpixmapregionselectordialog.h
@@ -0,0 +1,112 @@
+/*
+    This file is part of libkdepim.
+
+    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 __KPIXMAPREGIONSELECTORDIALOG_H__
+#define __KPIXMAPREGIONSELECTORDIALOG_H__
+
+#include <kdialogbase.h>
+#include <libkdepim/kpixmapregionselectorwidget.h>
+#include <qimage.h>
+#include <kdepimmacros.h>
+
+namespace KPIM {
+
+/**
+ * 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 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 <larrosa@kde.org>
+ * @since 3.4
+ */
+class KDE_EXPORT KPixmapRegionSelectorDialog : public KDialogBase
+{
+public:
+   /**
+    * The constructor of an empty KPixmapRegionSelectorDialog, you have to call
+    * later the setPixmap method of the KPixmapRegionSelectorWidget widget of
+    * the new object.
+    */
+   KPixmapRegionSelectorDialog(QWidget *parent=0L, const char *name=0L,
+                      bool modal = false );
+   /**
+    * The destructor of the dialog
+    */
+   ~KPixmapRegionSelectorDialog();
+
+   /**
+    * @returns the KPixmapRegionSelectorWidget widget so that additional
+    * parameters can be set by using it.
+    */
+   KPIM::KPixmapRegionSelectorWidget *pixmapRegionSelectorWidget() const
+      { return m_pixmapSelectorWidget; }
+
+   /**
+    * Creates a modal dialog, lets the user to select a region of the @p 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 getSelectedRegion(const QPixmap &pixmap, QWidget *parent = 0L );
+
+   /**
+    * Creates a modal dialog, lets the user to select a region of the @p pixmap
+    * with the same aspect ratio than @p aspectRatioWidth x @p aspectRatioHeight
+    * and returns when the dialog is closed.
+    *
+    * @returns the selected rectangle, or an invalid rectangle if the user
+    * pressed the Cancel button.
+    */
+   static QRect getSelectedRegion(const QPixmap &pixmap, int aspectRatioWidth, int aspectRatioHeight, QWidget *parent = 0L );
+
+   /**
+    * Creates a modal dialog, lets the user to select a region of the @p 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 getSelectedImage(const QPixmap &pixmap, QWidget *parent = 0L );
+
+   /**
+    * Creates a modal dialog, lets the user to select a region of the @p pixmap
+    * with the same aspect ratio than @p aspectRatioWidth x @p aspectRatioHeight
+    * and returns when the dialog is closed.
+    *
+    * @returns the selected image, or an invalid image if the user
+    * pressed the Cancel button.
+    */
+   static QImage getSelectedImage(const QPixmap &pixmap, int aspectRatioWidth, int aspectRatioHeight, QWidget *parent = 0L );
+
+protected:
+   KPIM::KPixmapRegionSelectorWidget *m_pixmapSelectorWidget;
+};
+
+}
+
+#endif