gtkdataboxmm  0.9.3
Public Member Functions | Protected Member Functions | Related Functions
GDatabox::Graph Class Reference

#include <gtkdataboxmm/graph.h>

Inheritance diagram for GDatabox::Graph:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~Graph ()
GtkDataboxGraph* gobj ()
 Provides access to the underlying C GObject.
const GtkDataboxGraph* gobj () const
 Provides access to the underlying C GObject.
GtkDataboxGraph* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void set_hide (bool hide)
 Hidden graphs are not shown, when the Gtk::Databox containing them is redrawn.
bool get_hide ()
 Gets the current "hide" status.
void set_color (const Gdk::Color& color) const
 Sets the color which the Gtk::DataboxGraph object is supposed to be using when drawing itself.
void set_size (int size)
 Sets the size (e.g. line width) which the Gtk::DataboxGraph object is supposed to be using when drawing itself.
int get_size () const
 Gets the size of the graph elements (e.g. the line width).
int calculate_extrema (float& min_x, float& max_x, float& min_y, float& max_y)
 Virtual function which determines the minimum and maximum x and y values of the values of this Gtk::DataboxGraph object if applicable (there are graphs which do not contain data).
Glib::PropertyProxy< Gdk::Color > property_color ()
 Color of graph.
Glib::PropertyProxy_ReadOnly
< Gdk::Color > 
property_color () const
 Color of graph.
Glib::PropertyProxy< int > property_size ()
 Size of displayed items.
Glib::PropertyProxy_ReadOnly< int > property_size () const
 Size of displayed items.
Glib::PropertyProxy< bool > property_hide ()
 Determine if graph is hidden or not.
Glib::PropertyProxy_ReadOnly
< bool > 
property_hide () const
 Determine if graph is hidden or not.

Protected Member Functions

 Graph ()

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< GDatabox::Graphwrap (GtkDataboxGraph* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Constructor & Destructor Documentation

virtual GDatabox::Graph::~Graph ( )
virtual
GDatabox::Graph::Graph ( )
protected

Member Function Documentation

int GDatabox::Graph::calculate_extrema ( float &  min_x,
float &  max_x,
float &  min_y,
float &  max_y 
)

Virtual function which determines the minimum and maximum x and y values of the values of this Gtk::DataboxGraph object if applicable (there are graphs which do not contain data).

Parameters:
min_xWill be filled with the lowest x value of the dataset.
max_xWill be filled with the highest x value of the dataset.
min_yWill be filled with the lowest y value of the dataset.
max_yWill be filled with the highest y value of the dataset.
Returns:
0 on success, -1 if no data is available,.
bool GDatabox::Graph::get_hide ( )

Gets the current "hide" status.

Returns:
Whether the graph is hidden (true) or not (false).
int GDatabox::Graph::get_size ( ) const

Gets the size of the graph elements (e.g. the line width).

Returns:
Size of the graph elements.
GtkDataboxGraph* GDatabox::Graph::gobj ( )
inline

Provides access to the underlying C GObject.

Reimplemented in GDatabox::Markers, GDatabox::Bars, GDatabox::CrossSimple, GDatabox::Grid, GDatabox::Lines, GDatabox::Points, and GDatabox::XYCGraph.

const GtkDataboxGraph* GDatabox::Graph::gobj ( ) const
inline

Provides access to the underlying C GObject.

Reimplemented in GDatabox::Markers, GDatabox::Bars, GDatabox::CrossSimple, GDatabox::Grid, GDatabox::Lines, GDatabox::Points, and GDatabox::XYCGraph.

GtkDataboxGraph* GDatabox::Graph::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Reimplemented in GDatabox::Markers, GDatabox::Bars, GDatabox::CrossSimple, GDatabox::Grid, GDatabox::Lines, GDatabox::Points, and GDatabox::XYCGraph.

Glib::PropertyProxy< Gdk::Color > GDatabox::Graph::property_color ( )

Color of graph.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Gdk::Color > GDatabox::Graph::property_color ( ) const

Color of graph.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > GDatabox::Graph::property_hide ( )

Determine if graph is hidden or not.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > GDatabox::Graph::property_hide ( ) const

Determine if graph is hidden or not.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > GDatabox::Graph::property_size ( )

Size of displayed items.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > GDatabox::Graph::property_size ( ) const

Size of displayed items.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
void GDatabox::Graph::set_color ( const Gdk::Color &  color) const

Sets the color which the Gtk::DataboxGraph object is supposed to be using when drawing itself.

Parameters:
colorColor which is to be used by the graph object.
void GDatabox::Graph::set_hide ( bool  hide)

Hidden graphs are not shown, when the Gtk::Databox containing them is redrawn.

Parameters:
hideDeclares whether should be hidden (true) or not (false).
void GDatabox::Graph::set_size ( int  size)

Sets the size (e.g. line width) which the Gtk::DataboxGraph object is supposed to be using when drawing itself.

Parameters:
sizeSize of graph elements for the graph object.

Friends And Related Function Documentation

Glib::RefPtr< GDatabox::Graph > wrap ( GtkDataboxGraph *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters:
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file: