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
|
/* This file is part of the KDE project
* Copyright (C) 2006-2007 Thomas Zander <zander@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 KOSHAPECONFIGWIDGETBASE_H
#define KOSHAPECONFIGWIDGETBASE_H
#include "KoCanvasResourceManager.h"
#include <QWidget>
#include "flake_export.h"
#include <kaction.h>
#include <KoUnit.h>
class KoShape;
class KUndo2Command;
/**
* Base widget for shape-configuration panels.
* This is an interface type class used by classes that intend to provide
* a GUI for configuring newly created shapes as created by a KoShapeFactoryBase.
*
* Every time after a shape is created the KoShapeFactoryBase for that shape-type
* will be queried for all the config widgets; both factory specific as well as
* those set by the hosting application.
* A dialog will be shown with all those panels, each extending this class.
* The framework will then call open() to populate the widget with data from
* the param shape. After the user ok-ed the dialog the save() will be called
* to allow the widget to apply all settings from the widget to the shape.
*/
class FLAKE_EXPORT KoShapeConfigWidgetBase : public QWidget
{
Q_OBJECT
public:
/**
* Default constructor
*/
KoShapeConfigWidgetBase();
virtual ~KoShapeConfigWidgetBase();
/**
* Open the argument shape by interpreting the data and setting that data on this
* widget.
* @param shape the shape that is to be queried for the data this widget can edit.
*/
virtual void open(KoShape *shape) = 0;
/**
* Save the data of this widget to the shape passed to open earlier to
* apply any user changed options.
* Called by the tool that created the shape.
*/
virtual void save() = 0;
/**
* Overwrite this method to set the application unit type and update all unit-widgets
* in this panel.
* Called by the tool that created the shape using KoCavasBase::unit()
* @param unit the new unit to show data in.
*/
virtual void setUnit(KoUnit unit);
/// called to set the canvas resource manager of the canvas the user used to insert the new shape.
void setResourceManager(KoCanvasResourceManager *rm);
/// Return true if the shape config panel should be shown after the shape is created
virtual bool showOnShapeCreate();
/// Return true if the shape config panel should be shown when the shape is selected
virtual bool showOnShapeSelect();
/// Creates a command which applies all changes to the opened shape
virtual KUndo2Command * createCommand();
signals:
/// is emitted after one of the config options has changed
void propertyChanged();
/// is emitted when the dialog should be accepted ie a file double clicked in a filebrowser
void accept();
protected:
KoCanvasResourceManager *m_resourceManager; ///< the resource provider with data for this canvas
};
#endif
|
