Changeset 1528 for trunk/src/objects/RpObject.h

Timestamp:

Jun 22, 2009, 3:16:39 PM (15 years ago)

Author:

dkearney

Message:

updating the objects code and adding some more examples describing how i want developers to use the objects. some of the objects don't work yet, like the tree, anything with an example should work

File:

• trunk/src/objects/RpObject.h (moved) (moved from trunk/src/objects/RpVariable.h) (3 diffs)

trunk/src/objects/RpObject.h

@@ -9 +9 @@
  */
 
-#ifndef RAPPTURE_VARIABLE_H
-#define RAPPTURE_VARIABLE_H
+#ifndef RAPPTURE_OBJECT_H
+#define RAPPTURE_OBJECT_H
 
 #include "RpInt.h"
@@ -16 +16 @@
 #include "RpAccessor.h"
 #include "RpBuffer.h"
+#include "RpPath.h"
 
 namespace Rappture {
 
-class Variable
+class Object
 {
     public:
-        Variable ();
-        Variable (  const char *path,
-                    const char *label,
-                    const char *desc,
-                    const char *hints,
-                    const char *color   );
-        Variable (const Variable& o);
-        virtual ~Variable();
+        Object ();
+        Object (const char *path,
+                const char *label,
+                const char *desc,
+                const char *hints,
+                const char *color);
+        Object (const Object& o);
+        virtual ~Object();
 
-        Accessor<const char *> path;
-        Accessor<const char *> label;
-        Accessor<const char *> desc;
-        Accessor<const char *> hints;
-        Accessor<const char *> color;
-        Accessor<Buffer> icon;
+        const char *path(void) const;
+        void path(const char *p);
+
+        const char *label(void) const;
+        void label(const char *p);
+
+        const char *desc(void) const;
+        void desc(const char *p);
+
+        const char *hints(void) const;
+        void hints(const char *p);
+
+        const char *color(void) const;
+        void color(const char *);
+
+        // void *icon(void) const;
+        // void icon(void *p, size_t nbytes);
 
         // these functions are not completely improper use proof
         // user is responsible for calling propremove() on any item
         // they put into the hash table.
-        const void *property (const char *key, const void *val);
-        const char *propstr (const char *key, const char *val);
-        void *propremove (const char *key);
+
+        // get/set void* property
+        const void *property (const char *key) const;
+        void property (const char *key, const void *val, size_t nbytes);
+
+        // get/set const char * property
+        const char *propstr (const char *key) const;
+        void propstr (const char *key, const char *val);
+
+        // remove property from hash table
+        void propremove (const char *key);
+
+        // get the Rappture1.1 xml text for this object
+        virtual const char *xml() const;
+
+        // set the object properties based on Rappture1.1 xml text
+        virtual void xml(const char *xmltext);
+
+        virtual const int is() const;
+
+    protected:
+
+        /// temprorary buffer for returning text to the user
+        SimpleCharBuffer _tmpBuf;
 
     private:
@@ -55 +88 @@
         /// close out the object, freeing its memory
         void __clear();
+
 };
 
-} // RAPPTURE_VARIABLE_H
+} // RAPPTURE_OBJECT_H
 
 /*--------------------------------------------------------------------------*/