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
113
114
115
116
117
118
119
120
121
|
/* This file is part of the KDE project
Copyright (C) 2004 Cedric Pasteur <cedric.pasteur@free.fr>
Copyright (C) 2004 Alexander Dymo <cloudtemple@mskat.net>
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 KPROPERTY_PROPERTYWIDGET_H
#define KPROPERTY_PROPERTYWIDGET_H
#include <tqwidget.h>
#include "koproperty_global.h"
namespace KoProperty {
class WidgetPrivate;
class Property;
/*! \brief The base class for all item editors used in Editor.
\author Cedric Pasteur <cedric.pasteur@free.fr>
\author Alexander Dymo <cloudtemple@mskat.net>
*/
class KOPROPERTY_EXPORT Widget : public TQWidget
{
Q_OBJECT
public:
Widget(Property *property, TQWidget *parent, const char *name="property_editor");
virtual ~Widget();
/*! \return the value currently entered in the item editor widget.*/
virtual TQVariant value() const = 0;
/*! Sets the value shown in the item editor widget. Set emitChange to false
if you don't want to emit propertyChanged signal.*/
virtual void setValue(const TQVariant &value, bool emitChange=true) = 0;
/*! \return edited property. */
virtual Property* property() const;
/*! Sets the name of edited property.*/
virtual void setProperty(Property *property);
/*! Function to draw a property viewer when the item editor isn't shown.*/
virtual void drawViewer(TQPainter *p, const TQColorGroup &cg, const TQRect &r, const TQVariant &value);
/*! Reverts the property value to previous setting.*/
virtual void undo();
/*! Sets the widget that will receive focus when the Widget is selected. */
void setFocusWidget(TQWidget*focusProxy);
//! \sa d->leaveTheSpaceForRevertButton description
bool leavesTheSpaceForRevertButton() const;
/*! \return true if this editor has borders.
Editors with borders have slightly larger height and width set by property editor widget. */
bool hasBorders() const;
/*! \return true if the widget is read-only.
Read-only property widget does not allow to change its property value.
The flag is inherited from the underlying property and property set.
Editor::setValue() method will still work, however.
@see Set::isReadOnly(). */
bool isReadOnly() const;
/*! Sets this widget to be read-only.
Disables or enables editing in the appropriate widget(s).
@see isReadOnly() */
void setReadOnly(bool readOnly);
/*! @internal
This flag is checked by Editor when the widget is about to show. */
bool visibleFlag() const;
signals:
void valueChanged(Widget *widget);
void acceptInput(Widget *widget);
void rejectInput(Widget *widget);
protected:
void setEditor(TQWidget* editor);
/*! Filters some event for main widget, eg Enter or Esc key presses. */
virtual bool eventFilter(TQObject* watched, TQEvent* e);
virtual void resizeEvent(TQResizeEvent *e);
void setLeavesTheSpaceForRevertButton(bool set);
void setHasBorders(bool set);
/*! Called by setReadOnly(bool).
For implementation: for read-only you should disable editing in the appropriate widget(s). */
virtual void setReadOnlyInternal(bool readOnly) = 0;
/*! Used only in setReadOnlyInternal() to make the widget visible or invisible.
This flag is checked by Editor when the widget is about to show.
By default widgets are visible. */
void setVisibleFlag(bool visible);
protected:
WidgetPrivate *d;
};
}
#endif
|
