1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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 <tqimage.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(TQWidget *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 TQRect getSelectedRegion(const TQPixmap &pixmap, TQWidget *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 TQRect getSelectedRegion(const TQPixmap &pixmap, int aspectRatioWidth, int aspectRatioHeight, TQWidget *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 TQImage getSelectedImage(const TQPixmap &pixmap, TQWidget *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 TQImage getSelectedImage(const TQPixmap &pixmap, int aspectRatioWidth, int aspectRatioHeight, TQWidget *parent = 0L );
protected:
KPIM::KPixmapRegionSelectorWidget *m_pixmapSelectorWidget;
};
}
#endif
|
