summaryrefslogtreecommitdiffstats
path: root/chalk/core/kis_resource.h
diff options
context:
space:
mode:
Diffstat (limited to 'chalk/core/kis_resource.h')
-rw-r--r--chalk/core/kis_resource.h84
1 files changed, 84 insertions, 0 deletions
diff --git a/chalk/core/kis_resource.h b/chalk/core/kis_resource.h
new file mode 100644
index 00000000..e07763e3
--- /dev/null
+++ b/chalk/core/kis_resource.h
@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) 2003 Patrick Julien <freak@codepimps.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+#ifndef KIS_RESOURCE_H_
+#define KIS_RESOURCE_H_
+
+#include <tqimage.h>
+#include <tqobject.h>
+#include <tqstring.h>
+
+
+/**
+ * The KisResource class provides a representation of Chalk image resources. This
+ * includes, but not limited to, brushes and patterns.
+ *
+ * This replaces the KisKrayon facility that used to be present in Krayon.
+ */
+class KisResource : public TQObject {
+ typedef TQObject super;
+ Q_OBJECT
+ TQ_OBJECT
+
+public:
+
+ /**
+ * Creates a new KisResource object using @p filename. No file is opened
+ * in the constructor, you have to call load.
+ *
+ * @param filename the file name to save and load from.
+ */
+ KisResource(const TQString& filename);
+ virtual ~KisResource();
+
+public:
+ /**
+ * Load this resource.
+ */
+ virtual bool load() = 0;
+
+ /**
+ * Save this resource asynchronously. The signal saveComplete is emitted when
+ * the resource has been saved.
+ */
+ virtual bool save() = 0;
+
+ /**
+ * Returns a TQImage representing this resource. This image could be null.
+ */
+ virtual TQImage img() = 0;
+
+public:
+ TQString filename() const;
+ void setFilename(const TQString& filename);
+ TQString name() const;
+ void setName(const TQString& name);
+ bool valid() const;
+ void setValid(bool valid);
+
+private:
+ KisResource(const KisResource&);
+ KisResource& operator=(const KisResource&);
+
+private:
+ TQString m_name;
+ TQString m_filename;
+ bool m_valid;
+};
+
+#endif // KIS_RESOURCE_H_
+