---

lib/gobj/viewer.h File Reference

Object viewer. More...

#include <gobjconfig.h>
#include <gobj/decls.h>
#include <gobj/id.h>
#include <gobj/context.h>
#include <gobj/stream.h>
#include <stdio.h>

Go to the source code of this file.

Compounds
struct	Gj_Viewer_struct
Functions
Gj_Viewer*	Gj_viewer_new (Gj_Ctx* ctx, Gj_View* view)
	Create a new viewer. More...
Gj_Viewer*	Gj_viewer_create (Gj_Ctx* ctx, Gj_Model* model, Gj_Stream* stream)
	Create a viewer from a stream. More...
Gj_Viewer*	Gj_viewer_duplicate (Gj_Ctx* ctx, Gj_Viewer* viewer)
	Create a new viewer as a duplicate of an existing one. More...
int	Gj_viewer_write (Gj_Ctx* ctx, Gj_Viewer* viewer, Gj_Stream* stream)
	Write a viewer to a given stream. More...
int	Gj_viewer_delete (Gj_Ctx* ctx, Gj_Viewer* ptr)
	Delete a viewer structure. More...
int	Gj_viewer_getParameterByName (Gj_Ctx* ctx, Gj_Viewer* viewer, char* name, Gj_Object** value)
	Get the value of a parameter given by its name. More...
int	Gj_viewer_getParameterByNumber (Gj_Ctx* ctx, Gj_Viewer* viewer, int index, Gj_Object** value)
	Get the value of a parameter given by its number. More...
int	Gj_viewer_setParameterByName (Gj_Ctx* ctx, Gj_Viewer* viewer, char* name, Gj_Object* value)
	Set the value of a parameter given by its name. More...
int	Gj_viewer_setParameterByNumber (Gj_Ctx* ctx, Gj_Viewer* viewer, int index, Gj_Object* value)
	Set the value of a parameter given by its index. More...
Gj_Object*	Gj_viewer_view (Gj_Ctx* ctx, Gj_Viewer* viewer, Gj_Object* obj)
	View a given object through the viewer. More...
void	Gj_viewer_dump (Gj_Ctx* ctx, Gj_Viewer* viewer, FILE* s, int* indent)
	Dump the viewer onto the given stream. More...

---

Detailed Description

Object viewer.

---

Function Documentation

Gj_Viewer * Gj_viewer_new ( Gj_Ctx * ctx, Gj_View * view )

Create a new viewer. Returns: The pointer to the new viewer on success, 0 otherwise.

Gj_Viewer * Gj_viewer_create ( Gj_Ctx * ctx, Gj_Model * model, Gj_Stream * stream )

Create a viewer from a stream. Returns: The pointer to the viewer on success, 0 otherwise.

Gj_Viewer * Gj_viewer_duplicate ( Gj_Ctx * ctx, Gj_Viewer * viewer )

Create a new viewer as a duplicate of an existing one. Returns: The pointer to the new viewer on success, 0 otherwise.

int Gj_viewer_write ( Gj_Ctx * ctx, Gj_Viewer * viewer, Gj_Stream * stream )

Write a viewer to a given stream. Returns: 0 on success, -1 otherwise.

int Gj_viewer_delete ( Gj_Ctx * ctx, Gj_Viewer * ptr )

Delete a viewer structure. Returns: 0 on success, -1 otherwise.

int Gj_viewer_getParameterByName ( Gj_Ctx * ctx, Gj_Viewer * viewer, char * name, Gj_Object ** value )

Get the value of a parameter given by its name. Returns: 0 on success, -1 otherwise.

int Gj_viewer_getParameterByNumber ( Gj_Ctx * ctx, Gj_Viewer * viewer, int index, Gj_Object ** value )

Get the value of a parameter given by its number. Returns: 0 on success, -1 otherwise.

int Gj_viewer_setParameterByName ( Gj_Ctx * ctx, Gj_Viewer * viewer, char * name, Gj_Object * value )

Set the value of a parameter given by its name. The value is NOT being DUPLICATED. Returns: 0 on success, -1 otherwise.

int Gj_viewer_setParameterByNumber ( Gj_Ctx * ctx, Gj_Viewer * viewer, int index, Gj_Object * value )

Set the value of a parameter given by its index. The value is NOT being DUPLICATED. Returns: 0 on success, -1 otherwise.

Gj_Object * Gj_viewer_view ( Gj_Ctx * ctx, Gj_Viewer * viewer, Gj_Object * obj )

View a given object through the viewer. If the resulting ptr is != obj, delete the resulting object afterwards via Gj_object_deleteTemp(). Returns: The pointer to the resulting object on success, 0 otherwise.

void Gj_viewer_dump ( Gj_Ctx * ctx, Gj_Viewer * viewer, FILE * s, int * indent )

Dump the viewer onto the given stream. If you call this function yourself *indent should be 0.

---