| | 1 | RpAbout |
| | 2 | |
| | 3 | The RpAbout is a class that tells the Gui how to describe the owners data to the user. A RpAbout object contains the following data members: |
| | 4 | * std::string label |
| | 5 | * std::string description |
| | 6 | * std::string hints |
| | 7 | * std::string color |
| | 8 | * std::string icon |
| | 9 | |
| | 10 | The RpAbout class allows the user to define an about section within a rappture object, setting the key values needed to create a gui from Rappture generated XML. When the owning rappture object calls its put() member function the about section of the object will be written in xml format to the outfile resultant xml should follow that specified in [wiki:rp_xml_ele_about About] |
| | 11 | |
| | 12 | How to use: |
| | 13 | * check out the example use in the test program RpVarable_test.cc in the svn repository. |
| | 14 | 1. The program is located in the test directory, read and understand it. |
| | 15 | 2. You can compile the program by going to the source directory (src) and issuing the command `make test`. |
| | 16 | 3. Go to the bin directory and run the program ./RpVariable_test |
| | 17 | * check out the header file for the class, located in the include/core directory |
| | 18 | * check out the class definition located in the src/core directory |
| | 19 | * to include this class into your application: |
| | 20 | 1. Go to the src directory |
| | 21 | 2. Issue command `make libRpAbout` |
| | 22 | 3. Compile your application against the shared object library libRpAbout, which will be located in the lib directory |
| | 23 | |
| | 24 | Design Comments / Considerations / Future Changes: |
