[Ocemp-CVS] ocempgui/doc manual.xml,1.79,1.80
Status: Beta
Brought to you by:
marcusva
Menu
▾
▴
[Ocemp-CVS] ocempgui/doc manual.xml,1.79,1.80
|
From: Marcus v. A. <mar...@us...> - 2007-05-08 14:46:23
|
Update of /cvsroot/ocemp/ocempgui/doc In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv3930/doc Modified Files: manual.xml Log Message: Fixed Style.copy_style() bug (thanks to Ryan Dhuse). Added experimental FormatEntry widget class. Brushed up manual. Index: manual.xml =================================================================== RCS file: /cvsroot/ocemp/ocempgui/doc/manual.xml,v retrieving revision 1.79 retrieving revision 1.80 diff -u -d -r1.79 -r1.80 --- manual.xml 1 Feb 2007 08:30:06 -0000 1.79 +++ manual.xml 8 May 2007 14:46:21 -0000 1.80 @@ -3860,8 +3860,8 @@ The <classname>Diagram</classname> class is an abstract base class for Diagram like widgets such as the <classname>Graph2D</classname>. It provides interfaces to create - two-dimensional statistical diagrams easily, be it graphs, bar - and pie charts or whatever else. + statistical diagrams easily, be it graphs, bar and pie charts or + whatever else. </para> <para> You usually will not create an <classname>Diagram</classname> @@ -3876,15 +3876,179 @@ <sect2 id="widgets_graph2d"> <title>Graph2D</title> <para> + The <classname>Graph2D</classname> class allows you to plot + two-diemensional graphs using a cartesian coordinate plane. + You can choose the names of the axes, scale units and units to + display and set up the evaluation function for plotting the graph + freely. + </para> + <para> + To create a <classname>Graph2D</classname> widget, you simply invoke + its constructor with the minimum size to occupy by the widget. + <programlisting> +graph = Graph2D (400, 400) + </programlisting> + </para> + <para> + The default names of the axes are "x" and "y". They can be changed + using the <property>axes</property> attribute and + <methodname>set_axes</methodname> method. + <programlisting> +graph.axes = "t", "v" # Set velocity related to time. +graph.set_axes ("t", "v") + </programlisting> + </para> + <para> + To set the scale units to display for the horizontal and vertical axis, + the <property>scale_units</property> attribute and + <methodname>set_scale_units()</methodname> method can be used. + The first value is used for the horizontal, the second for the vertical + axis. + <programlisting> +graph.scale_units = ("cm", "kp") +graph.set_scale_units ("cm", "kp") + </programlisting> + </para> + <para> + To show or hide the scale units and axes names on the graph, the + <property>show_names</property> attribute and + <methodname>set_show_names</methodname> method are used. + The names and units are usually diplayed on the right of the axes. + <programlisting> +graph.show_names = True # Show the names +graph.set_show_names (False) # Do not display them. + </para> + <para> + The distance from one unit to another can be set using the + <property>units</property> and <methodname>set_units</methodname> + method. The distance is given in pixels and defaults to 10 to 10. + <programlisting> +graph.units = 10, 25 # Set 10 px for the horizontal units, 25 for vertical +graph.set_units (10, 25) + </programlisting> + </para> + <para> + You can rotate the graph clockwise by 90 degrees by adjusting the + <property>orientation</property> attribute. The default is a + horizontal orientation. + <programlisting> +graph.orientation = ORIENTATION_VERTICAL # Rotate the graph +grap.set_orientation (ORIENTATION_HORIZONTAL) + </programlisting> TODO </para> + <example id="ex_gui_graph2d"> + <title>Graph2D example</title> + <para> + You can find the following example as a python script under + <filename>examples/graph2d.py</filename>. + </para> + <indexterm zone="ex_gui_graph2d"> + <primary>GUI widgets: Graph2D example</primary> + </indexterm> + <programlisting><xi:include href="examples/graph2d.py" + parse="text" + xmlns:xi="http://www.w3.org/2001/XInclude"/></programlisting> + </example> </sect2> <sect2 id="widgets_statusbar"> <title>StatusBar</title> <para> - TODO + The <classname>StatusBar</classname> widget class can display various + text information using a stack system as well as the current date and + time. It also supports the placement of widgets on its area. + </para> + <para> + To create a new <classname>StatusBar</classname> widget, you simply + invoke its constructor with no arguments. + <programlisting> +statusbar = StatusBar () + </programlisting> + </para> + <para> + To set set the current information to display, the + <methodname>push_tip()</methodname> method has to be used. + <programlisting> +statusbar.push_tip ("Display this tip") + </programlisting> + To remove the currently displayed information and to show the + previous information the <methodname>pop_tip()<methodname> method + has to be used. + <programlisting> +statusbar.pop_tip () + </programlisting> + The currently displayed information can be received using the + <property>current_tip</property> attribute or the + <methodname>get_current_tip()</methodname> method. + <programlisting> +info = statusbar.current_tip +info = statusbar.get_current_tip() + </programlisting> </para> + <para> + To show or hide the information on the <classname>StatusBar</classname> + the <property>tips</property> attribute and + <methodname>show_tips</methodname> method are used. + <programlisting> +statusbar.tips = True +statusbar.show_tips (False) + </programlisting> + You also can show or hide the date to display using the + <property>date</property> attribute and + <methodname>show_date</methodname> method, + <programlisting> +statusbar.date = True +statusbar.show_date (False) + </programlisting> + </para> + <para> + You can supply your own date and time format string to customize + the date output. The <property>date_format</property> attribute and + <methodname>set_date_format()</methodname> method allow you to use + python specific date format strings, which can be understood by + python's <methodname>datetime.strftime()</methodname> method. + <programlisting> +statusbar.date_format = "%x" +statusbar.set_date_format ("%H:%M") + </programlisting> + </para> + <para> + To get the currently displayed date and time, use the + <property>current_date</property> attribute. Its value matches + the set <property>date_format</property> attribute. + <programlisting> +date = statusbar.current_date + </programlisting> + </para> + <para> + You can customize the size occupied by the displayed information + and date using the <property>tip_width</property> and + <property>date_width</property> properties and + <methodname>set_tip_width</methodname> and + <methodname>set_date_width</methodname> methods. + <programlisting> +statusbar.tip_width = 50 # Set the information display width to 50 px. +statusbar.set_tip_width (50) + +statusbar.date_width = 50 # Set the date display width tto 50 px. +statusbar.set_date_width (50) + </programlisting> + </para> + <example id="ex_gui_statusbar"> + <title>StatusBar example</title> + <para> + You can find the following example as a python script under + <filename>examples/statusbar.py</filename>. + </para> + <indexterm zone="ex_gui_statusbar"> + <primary>GUI widgets: StatusBar example</primary> + </indexterm> + <programlisting><xi:include href="examples/statusbar.py" + parse="text" + xmlns:xi="http://www.w3.org/2001/XInclude"/></programlisting> + </example> + </sect2> <sect2 id="widgets_tooltipwindow"> |