Warning, file /office/calligra/libs/flake/KoShapeUserData.h was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).
0001 /* This file is part of the KDE project 0002 * Copyright (C) 2006 Thomas Zander <zander@kde.org> 0003 * 0004 * This library is free software; you can redistribute it and/or 0005 * modify it under the terms of the GNU Library General Public 0006 * License as published by the Free Software Foundation; either 0007 * version 2 of the License, or (at your option) any later version. 0008 * 0009 * This library is distributed in the hope that it will be useful, 0010 * but WITHOUT ANY WARRANTY; without even the implied warranty of 0011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 0012 * Library General Public License for more details. 0013 * 0014 * You should have received a copy of the GNU Library General Public License 0015 * along with this library; see the file COPYING.LIB. If not, write to 0016 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 0017 * Boston, MA 02110-1301, USA. 0018 */ 0019 0020 #ifndef KOSHAPEUSERDATA_H 0021 #define KOSHAPEUSERDATA_H 0022 0023 #include <QObject> 0024 0025 #include "flake_export.h" 0026 0027 /** 0028 * The KoShapeUserData class is used to associate custom data with a shape. 0029 * 0030 * KoShapeUserData provides an abstract interface for container classes 0031 * that are used to associate application-specific user data with shapes in KoShape 0032 * Generally, subclasses of this class provide functions to allow data to 0033 * be stored and retrieved, and instances are attached to KoShape using 0034 * KoShape::setUserData(). This makes it possible to store additional data per 0035 * shape in a way that allows applications to not know the implementation of a 0036 * specific KoShape extending class. 0037 * 0038 * Each subclass should provide a reimplementation of the destructor to ensure that 0039 * any private data is automatically cleaned up when user data objects are deleted. 0040 * 0041 * Please note that this object is a QObject to allow a 0042 * <code>qobject_cast<MyData*> (shape->userData())</code> to work which is useful in an environment 0043 * where classes from plugins may not be castable using a static_cast or a dynamic_cast 0044 */ 0045 class FLAKE_EXPORT KoShapeUserData : public QObject 0046 { 0047 Q_OBJECT 0048 public: 0049 /// Constructor 0050 explicit KoShapeUserData(QObject *parent = 0); 0051 ~KoShapeUserData() override; 0052 }; 0053 0054 #endif