Views
Data Access Package API Reference Guide
Product Documentation:
Views Documentation Home
Classes | Typedefs | Enumerations
dbgraphe.h File Reference
#include <ilviews/grapher/links.h>
#include <ilviews/grapher/inters.h>
#include <ilviews/base/error.h>
#include <ilviews/base/gadget.h>
#include <ilviews/gadgraph/rectscgr.h>
#include <ilviews/dataccess/gadgets/dsusage.h>
#include <ilviews/dataccess/reposit.h>
#include <ilviews/graphics/label.h>
#include <ilviews/dataccess/gadgets/labelbmp.h>

Classes

class  IliDbGrapher
 Gadget. More...
 
class  IliGrapher
 Grapher. More...
 

Typedefs

typedef IlvGraphic *(* IliCreateObjectCallback) (IliTableBuffer *buff, IlAny arg)
 
typedef IlBoolean(* IliDefineObjectCallback) (IliTableBuffer *buff, IlvGraphic *g, IlAny arg)
 
typedef IlvGraphic *(* IliUpdateObjectCallback) (IlvGraphic *previous, IliTableBuffer *buff, IlAny arg)
 

Enumerations

enum  IliGrapherColor { IliGrapherLinkColor, IliGrapherForegroundLabelColor, IliGrapherBackgroundLabelColor }
 This enumerated type defines the colors of the IliDbGrapher. More...
 
enum  IliGrapherColumn {
  IliGrapherNodeXColumn, IliGrapherNodeYColumn, IliGrapherNodeIdColumn, IliGrapherNodeLabelColumn,
  IliGrapherNodeBitmapColumn, IliGrapherNodeForegroundColumn, IliGrapherNodeBackgroundColumn, IliGrapherLinkFromColumn,
  IliGrapherLinkToColumn, IliGrapherLinkColorColumn, IliGrapherLinkTypeColumn, IliGrapherLinkOrientedColumn
}
 This enumerated type defines the data source columns used by the IliDbGrapher. More...
 

Detailed Description

Library: dbgraphe
Declarations about grapher

Typedef Documentation

◆ IliCreateObjectCallback

IliCreateObjectCallback

This type defines the prototype of a function that is called to create a node (or a link).

Parameters
buffThe definition of the object.
argThe user data.
Returns
The created object or 0 if there is a problem.
See also
IliDbGrapher.

◆ IliDefineObjectCallback

IliDefineObjectCallback

This type defines the prototype of a function that is called to define the data of a node (or a link) before appending into a data source.

Parameters
buffThe data buffer which contains the object data.
gThe current graphic object if already exists.
argThe user data.
Returns
IlTrue if the node (or link) can be created. Otherwise, it returns IlFalse.
See also
IliDbGrapher.

◆ IliUpdateObjectCallback

IliUpdateObjectCallback

This type defines the prototype of a function that is called to update a node or a link.

Parameters
previousThe object that must be updated.
buffThe new definition of the object.
argThe user data.
Returns
The updated object. If the returned object is a new object, the old object is deleted by the IliDbGrapher object.
See also
IliDbGrapher.

Enumeration Type Documentation

◆ IliGrapherColor

This enumerated type defines the colors of the IliDbGrapher.

Enumerator
IliGrapherLinkColor 

The color used to draw the links.

IliGrapherForegroundLabelColor 

The foreground color used to draw the node label.

IliGrapherBackgroundLabelColor 

The background color used to draw the node label.

◆ IliGrapherColumn

This enumerated type defines the data source columns used by the IliDbGrapher.

Enumerator
IliGrapherNodeXColumn 

Column for the x-position of the node.

IliGrapherNodeYColumn 

Column for the y-position of the node.

IliGrapherNodeIdColumn 

Column for the node identifier.

IliGrapherNodeLabelColumn 

Column for the node label.

IliGrapherNodeBitmapColumn 

Column for the node bitmap.

IliGrapherNodeForegroundColumn 

Column for the node foreground.

IliGrapherNodeBackgroundColumn 

Column for the node background.

IliGrapherLinkFromColumn 

Column for the link from.

IliGrapherLinkToColumn 

Column for the link to.

IliGrapherLinkColorColumn 

Column for the link color.

IliGrapherLinkTypeColumn 

Column for the link type. The type can be an integer from 0 to 6 inclusive.

IliGrapherLinkOrientedColumn 

Column to indicate if the link is oriented.