[gegl-qt] Update README.txt and FIXME/TODO comments



commit 55a83ca88e6aaf356d71d363c2ed0a95ff31bf9e
Author: Jon Nordby <jononor gmail com>
Date:   Sun May 13 18:51:25 2012 -0700

    Update README.txt and FIXME/TODO comments

 README.txt                                  |   19 ++++++++++-------
 gegl-qt/internal/nodeviewimplementation.cpp |    3 +-
 gegl-qt/nodeviewdeclarativeitem.cpp         |    2 +-
 gegl-qt/nodeviewoptions.cpp                 |   29 +--------------------------
 gegl-qt/nodeviewoptions.h                   |    9 ++++++++
 5 files changed, 23 insertions(+), 39 deletions(-)
---
diff --git a/README.txt b/README.txt
index 5940519..cd92909 100644
--- a/README.txt
+++ b/README.txt
@@ -27,6 +27,9 @@ To use gegl-qt in your project, use the provided pkg-config file.
 See this file, the examples and source code, for now. :)
 
 == Features ==
+
+- Support for both Qt4 and Qt5.
+
 === View widgets ===
 - Shows the output of a Gegl graph.
 - QML, QGraphicsView and QWidget versions are provided.
@@ -34,14 +37,14 @@ See this file, the examples and source code, for now. :)
 - Can do automatic scaling and centering
 
 === Gegl display operation ===
-Allows applications to show a
+Allows applications to show a GEGL graph in a window without linking
+against a specific UI library.
 
 == Purpose & Scope ==
 The purpose of gegl-qt is to make it easy for application developers to
 use GEGL in applications with Qt based user interfaces.
 
-gegl-qt aims to support Qt4 and both QWidget, QGraphicsView and QML based user interfaces.
-Qt5 support will be considered in the future.
+gegl-qt aims to support Qt4 and Qt5 for both QWidget, QGraphicsView and QML based user interfaces.
 
 == Contributing ==
 To contribute code, please file a bug and attach git-formatted patches there, or link to
@@ -61,13 +64,13 @@ Should at happen before or together with the next Gegl release.
 Need to build and work with whatever is the latest Gegl release.
 
 - Do API review
-- API documentation
+
+- Complete Qt5 support
 
 - Have a basic set of tests, and good test infrastructure
 - Distribute a set of basic examples for the provided features
-* Missing: use of view->model transformations
-* Examples needs to have a description, and be commented
-- Add information about gegl-qt to gegl.org website
+ * Missing: use of view->model transformations
+ * Examples needs to have a description, and be commented
 
 === Later ===
 
@@ -77,7 +80,7 @@ Display operation
 
 View widgets
 - Rotation support
-- Background and overlay draw support for GeglQtView
+- Background and overlay draw support for GeglQt::NodeView
 
 QImage IO loader plugin that uses GEGL loaders
 
diff --git a/gegl-qt/internal/nodeviewimplementation.cpp b/gegl-qt/internal/nodeviewimplementation.cpp
index d4928bc..784632c 100644
--- a/gegl-qt/internal/nodeviewimplementation.cpp
+++ b/gegl-qt/internal/nodeviewimplementation.cpp
@@ -167,8 +167,7 @@ NodeViewImplementation::setOptions(NodeViewOptions *newOptions)
         return;
     }
 
-    /* FIXME: Don't take complete ownership of the options instance.
-     * Use refcounting instead? */
+    /* XXX: Don't take complete ownership of the options instance, use QSharedPointer instead? */
     delete mOptions;
     mOptions = newOptions ? newOptions : new NodeViewOptions();
 
diff --git a/gegl-qt/nodeviewdeclarativeitem.cpp b/gegl-qt/nodeviewdeclarativeitem.cpp
index d60683c..7a25f18 100644
--- a/gegl-qt/nodeviewdeclarativeitem.cpp
+++ b/gegl-qt/nodeviewdeclarativeitem.cpp
@@ -104,7 +104,7 @@ NodeViewDeclarativeItem::paint(QPainter *painter,
                              QWidget *widget)
 {
     // Handled by private class
-    Q_UNUSED(widget);
+    Q_UNUSED(painter);
     Q_UNUSED(option);
     Q_UNUSED(widget);
 }
diff --git a/gegl-qt/nodeviewoptions.cpp b/gegl-qt/nodeviewoptions.cpp
index 4620b43..62d771c 100644
--- a/gegl-qt/nodeviewoptions.cpp
+++ b/gegl-qt/nodeviewoptions.cpp
@@ -31,34 +31,7 @@ struct GeglQtViewOptionsPrivate {
     NodeViewOptions::AutoScale autoScale;
 };
 
-/*
-  TODO: support more options
-
-  double rotation;
-*/
-
-
-/* FIXME: find a better name? */
-/* TODO: evaluate what is the best behavior when the Auto options are enabled,
- * and trying to use the manual setters as well.
- *
- * Currently enabling autoCenter/autoScaling means that
- * - The view implementation will change the scale/translation values
- * - Using the manual setters will set the value, but it will be overwritten as soon
- * the auto value update is triggered (by viewport/model changes, et.c)
- *
- * A challenge is that GeglQtViewImplementation should still be able to set the values
- * when autocenter/autoscale is enabled.
- *
- * Possible behaviors include
- * 0. Ignoring values from explicit setters
- * Suprising that when toggling auto enable/disable, the previously manually set values will be gone?
- * 1. Setting scale/translation manually will quit auto mode.
- * Could be suprising if one accidentically calls it?
- * 2. Allowing one to set scale/translation manually, but they are overridden when auto mode is on
- * Suprising that calling setSomething(), and then something() would not return the same value;
- * or that scale() returns a different value from the current transformation (and that transformation() indicates)
- */
+/* TODO: support rotation */
 NodeViewOptions::NodeViewOptions(QObject *parent)
     : QObject(parent)
     , priv(new GeglQtViewOptionsPrivate())
diff --git a/gegl-qt/nodeviewoptions.h b/gegl-qt/nodeviewoptions.h
index a50c1b1..3e3a30d 100644
--- a/gegl-qt/nodeviewoptions.h
+++ b/gegl-qt/nodeviewoptions.h
@@ -26,6 +26,15 @@ class GeglQtViewOptionsPrivate;
 namespace GeglQt
 {
 
+/*!
+ * Options available for NodeView widgets
+ *
+ * Note: when enabling autoCenter/autoScaling the values for translation/scale
+ * will be automatically managed. Values set manually will be overwritten.
+ *
+ * \sa NodeViewWidget, NodeViewGraphicsWidget, NodeViewDeclarativeItem
+ */
+
 class NodeViewOptions : public QObject
 {
     Q_OBJECT



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]