[Boost-commit] svn:boost r43030 - sandbox/SOC/2007/visualization/libs/svg_plot/doc

From: JakeVoytko_at_[hidden]
Date: 2008-01-31 00:46:52

Author: jakevoytko
Date: 2008-01-31 00:46:52 EST (Thu, 31 Jan 2008)
New Revision: 43030
URL: http://svn.boost.org/trac/boost/changeset/43030

Log:
Added the documentation for the new <tspan>s

Text files modified: 
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_interface.qbk |    20 ++++++++++++++++++++                    
   1 files changed, 20 insertions(+), 0 deletions(-)

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_interface.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_interface.qbk	(original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_interface.qbk	2008-01-31 00:46:52 EST (Thu, 31 Jan 2008)
@@ -129,6 +129,26 @@
   [[`void write(std::ostream&)`] [Writes the document to the stream represented by the argument.][]] 
 ] [/table `svg` document settings and writing]
 
+[table `tspan` attributes
+  [[Signature] [Description] [Notes & Examples]]
+  [[`tspan_element(const std::string&, const text_style&)`][Constructor. Adds the text and an optional style][]]
+  [[`tspan_element& text(const std::string&)`][Changes the text to the member function input][<tspan>Text goes here</tspan>]]
+  [[`tspan_element& dx(double)`][The "change in x" attribute][]]
+  [[`tspan_element& dy(double)`][The "change in y" attribute][]]
+  [[`tspan_element& rotation(int)`][Currently, this is broken and only rotates the first character of the string.][]]
+  [[`tspan_element& x(double)`][The "position of x" attribute][]]
+  [[`tspan_element& y(double)`][The "position of y" attribute][]]
+  [[`tspan_element& text_length(double)`][Allows the absolute maximum length of the text to be defined][]]
+  [[`double dx()`][The getter for the "change in x" attribute][]]
+  [[`double dy()`][The getter for the "change in y" attribute][]]
+  [[`int rotation()`][The getter for the rotation function.][]]
+  [[`double x()`][The getter for the "position of x" attribute][]]
+  [[`double y()`][The getter for the "position of y" attribute][]]
+  [[`std::string text()`][Getter for the text][<tspan>Text goes here</tspan>]]
+  [[`text_style& font_style()`][Allows access to the font style][]]
+  [[`const text_style& font_style()`][`const` access to the font style][]]
+  [[`void write(std::ostream&)`][Outputs the text of the element into the stream][]]
+]
 [endsect] [/section:svg_interface]