Code

Some consistency cleanup for descriptions.
[inkscape.git] / src / bind / javabind.h
index c73afa58194dc5d35575648d9845e207a940da5a..894f52d5dddffe902625054a7b4d97ffbbf34f8f 100644 (file)
@@ -1,7 +1,6 @@
-#ifndef __JAVABIND_H__
-#define __JAVABIND_H__
 /**
- * This is a simple mechanism to bind Inkscape to Java, and thence
+ * @file
+ * @brief This is a simple mechanism to bind Inkscape to Java, and thence
  * to all of the nice things that can be layered upon that. 
  *
  * Authors:
@@ -24,6 +23,9 @@
  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
+#ifndef __JAVABIND_H__
+#define __JAVABIND_H__
+
 #include <glibmm.h>
 #include <vector>
 
@@ -41,6 +43,28 @@ namespace Bind
 typedef Glib::ustring String;
 
 
+/**
+ * This is the base class of all things which will be C++ object
+ * instances
+ */  
+class BaseObject
+{
+public:
+
+    /**
+     * Simple constructor
+     */             
+    BaseObject()
+        {}
+
+    /**
+     * Destructor
+     */             
+    virtual ~BaseObject()
+        {}
+
+};
+
 
 /**
  *
@@ -70,6 +94,42 @@ public:
         init();
         }
 
+    /**
+     *
+     */
+    Value(int ival)
+        {
+        init();
+        setInt(ival);
+        }
+
+    /**
+     *
+     */
+    Value(bool bval)
+        {
+        init();
+        setBoolean(bval);
+        }
+
+    /**
+     *
+     */
+    Value(double dval)
+        {
+        init();
+        setDouble(dval);
+        }
+
+    /**
+     *
+     */
+    Value(const String &sval)
+        {
+        init();
+        setString(sval);
+        }
+
     /**
      *
      */
@@ -258,49 +318,43 @@ public:
     /**
      *
      */
-    virtual bool doBinding()
+    virtual bool scriptRun(const String &/*lang*/, const String &/*script*/)
         {
         return false;
         }
-        
+
     /**
      *
      */
-    virtual String getException()
-        {
-               return "";
-               }
-        
-    virtual String stdOutGet()
-        {
-        return stdOutBuf;
-        }
-
-    virtual void stdOutClear()
+    virtual bool scriptRunFile(const String &/*lang*/, const String &/*fileName*/)
         {
-        stdOutBuf.clear();
-        }
-
-    virtual void stdOut(int ch)
-        {
-        stdOutBuf.push_back((char)ch);
+        return false;
         }
 
-    virtual String stdErrGet()
+    /**
+     *
+     */
+    virtual bool showConsole()
         {
-        return stdErrBuf;
+        return false;
         }
 
-    virtual void stdErrClear()
+    /**
+     *
+     */
+    virtual bool doBinding()
         {
-        stdErrBuf.clear();
+        return false;
         }
-
-    virtual void stdErr(int ch)
+        
+    /**
+     *
+     */
+    virtual String getException()
         {
-        stdErrBuf.push_back((char)ch);
-        }
-
+               return "";
+               }
+        
     virtual String logGet()
         {
         return logBuf;