gcucrystalviewer.h File Reference

#include <gtk/gtkbin.h>
#include <libxml/tree.h>

Go to the source code of this file.

Defines

#define GCU_TYPE_CRYSTAL_VIEWER   (gcu_crystal_viewer_get_type ())
#define GCU_CRYSTAL_VIEWER(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GCU_TYPE_CRYSTAL_VIEWER, GcuCrystalViewer))
#define GCU_CRYSTAL_VIEWER_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), GCU_TYPE_CRYSTAL_VIEWER, GcuCrystalViewerClass))
#define GCU_IS_CRYSTAL_VIEWER(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GCU_TYPE_CRYSTAL_VIEWER))
#define GCU_IS_CRYSTAL_VIEWER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GCU_TYPE_CRYSTAL_VIEWER))
#define GCU_CRYSTAL_VIEWER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GCU_TYPE_CRYSTAL_VIEWER, GcuCrystalViewerClass))

Typedefs

typedef struct _GcuCrystalViewer GcuCrystalViewer
typedef struct
_GcuCrystalViewerClass 
GcuCrystalViewerClass

Functions

GtkWidget * gcu_crystal_viewer_new (xmlNodePtr node)
void gcu_crystal_viewer_set_data (GcuCrystalViewer *viewer, xmlNodePtr node)
GdkPixbuf * gcu_crystal_viewer_new_pixbuf (GcuCrystalViewer *viewer, guint width, guint height)
void gcu_crystal_viewer_set_uri_with_mime_type (GcuCrystalViewer *viewer, const gchar *uri, const gchar *mime_type)
void gcu_crystal_viewer_set_uri (GcuCrystalViewer *viewer, const gchar *uri)


Detailed Description

Declaration of the GtkCrystalViewer widget.

Definition in file gcucrystalviewer.h.


Define Documentation

#define GCU_CRYSTAL_VIEWER ( obj   )     (G_TYPE_CHECK_INSTANCE_CAST ((obj), GCU_TYPE_CRYSTAL_VIEWER, GcuCrystalViewer))

Casts obj to a GtkCrystalViewer * pointer.

Returns:
a pointer to the GtkCrystalViewer * or NULL if obj does not point to a GcuCrystalViewer widget.

Definition at line 42 of file gcucrystalviewer.h.

#define GCU_CRYSTAL_VIEWER_CLASS ( klass   )     (G_TYPE_CHECK_CLASS_CAST ((klass), GCU_TYPE_CRYSTAL_VIEWER, GcuCrystalViewerClass))

Casts klass to a GcuCrystalViewerClass * pointer.

Returns:
a pointer to the GcuCrystalViewerClass * or NULL if obj not point to a GcuCrystalViewerClass.

Definition at line 47 of file gcucrystalviewer.h.

#define GCU_CRYSTAL_VIEWER_GET_CLASS ( obj   )     (G_TYPE_INSTANCE_GET_CLASS ((obj), GCU_TYPE_CRYSTAL_VIEWER, GcuCrystalViewerClass))

Returns:
the GcuCrystalViewerClass * associated to obj if obj points to a GcuCrystalViewer widget, NULL otherwise.

Definition at line 60 of file gcucrystalviewer.h.

#define GCU_IS_CRYSTAL_VIEWER ( obj   )     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GCU_TYPE_CRYSTAL_VIEWER))

Returns:
TRUE if obj points to a GcuCrystalViewer widget, FALSE otherwise.

Definition at line 51 of file gcucrystalviewer.h.

#define GCU_IS_CRYSTAL_VIEWER_CLASS ( klass   )     (G_TYPE_CHECK_CLASS_TYPE ((klass), GCU_TYPE_CRYSTAL_VIEWER))

Returns:
TRUE if klass points to a GcuCrystalViewerClass, FALSE otherwise.

Definition at line 55 of file gcucrystalviewer.h.

#define GCU_TYPE_CRYSTAL_VIEWER   (gcu_crystal_viewer_get_type ())

Returns:
the GType associated to GtkCrystalViewer

Definition at line 36 of file gcucrystalviewer.h.


Typedef Documentation

typedef struct _GcuCrystalViewer GcuCrystalViewer

The GcuCrystalViewer widget.

Definition at line 63 of file gcucrystalviewer.h.

typedef struct _GcuCrystalViewerClass GcuCrystalViewerClass

The GcuCrystalViewer widget object class.

Definition at line 65 of file gcucrystalviewer.h.


Function Documentation

GtkWidget* gcu_crystal_viewer_new ( xmlNodePtr  node  ) 

Parameters:
node,: a pointer to an xlNode (from libxml) containing the serialized version of the crystal to display as saved by Gnome Crystal or NULL.
Builds a new GcuCrystalViewer widget and, if node is not NULL, fills it with the Crystal structure described in node.
Returns:
a pointer to the new viewer.

Referenced by main().

GdkPixbuf* gcu_crystal_viewer_new_pixbuf ( GcuCrystalViewer viewer,
guint  width,
guint  height 
)

Parameters:
viewer a pointer to a GcuCrystalViewer widget.
width the width of the new pixbuf.
height the height of the new pixbuf.
Renders the scene to a newly allocated pixbuf.
Returns:
the new GdkPixbuf*.

void gcu_crystal_viewer_set_data ( GcuCrystalViewer viewer,
xmlNodePtr  node 
)

Parameters:
viewer,: a pointer to a GcuCrystalViewer widget.
node,: a pointer to an xlNode (from libxml) containing the serialized version of the crystal to display as saved by Gnome Crystal.
Replaces the content of viewer by the Crystal structure described in node.

void gcu_crystal_viewer_set_uri ( GcuCrystalViewer viewer,
const gchar *  uri 
)

Parameters:
viewer a pointer to a GcuCrystalViewer widget.
uri the URI of the file containing the crystal structure to display.
Changes the crystal structure displayed by the one described in the uri. Nothing happens if uri is NULL.

void gcu_crystal_viewer_set_uri_with_mime_type ( GcuCrystalViewer viewer,
const gchar *  uri,
const gchar *  mime_type 
)

Parameters:
viewer a pointer to a GcuCrystalViewer widget.
uri the URI of the file containing the crystal structure to display.
mime_type,: the mime_type of the data.
Changes the crystal structure displayed by the one described in the uri. Nothing happens if uri is NULL.


Generated on Fri Sep 24 15:58:42 2010 for The Gnome Chemistry Utils by  doxygen 1.5.9