![]() |
![]() |
![]() |
Gcr Library Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Prerequisites |
GcrViewer; struct GcrViewerIface; GcrViewer * gcr_viewer_new (void
); GcrViewer * gcr_viewer_new_scrolled (void
); void gcr_viewer_add_renderer (GcrViewer *viewer
,GcrRenderer *renderer
); void gcr_viewer_insert_renderer (GcrViewer *viewer
,GcrRenderer *renderer
,GcrRenderer *before
); void gcr_viewer_remove_renderer (GcrViewer *viewer
,GcrRenderer *renderer
); guint gcr_viewer_count_renderers (GcrViewer *viewer
); GcrRenderer * gcr_viewer_get_renderer (GcrViewer *viewer
,guint index_
);
A GcrViewer is an abstract interface that represents a widget that can hold various renderers and display their contents.
The interaction between GcrRenderer and GcrViewer is not stable yet, and so viewers cannot be implemented outside the Gcr library at this time.
Use the gcr_viewer_new()
and gcr_viewer_new_scrolled()
to get default
implementations of viewers.
typedef struct _GcrViewer GcrViewer;
An abstract viewer which displays renderers contents.
struct GcrViewerIface { GTypeInterface parent; void (*add_renderer) (GcrViewer *viewer, GcrRenderer *renderer); void (*insert_renderer) (GcrViewer *viewer, GcrRenderer *renderer, GcrRenderer *before); void (*remove_renderer) (GcrViewer *viewer, GcrRenderer *renderer); guint (*count_renderers) (GcrViewer *viewer); GcrRenderer* (*get_renderer) (GcrViewer *viewer, guint index_); };
The interface for GcrViewer
GTypeInterface |
The parent interface |
Virtual method to add a renderer | |
Virtual method to insert a renderer | |
Virtual method to remove a renderer | |
Virtual method to count renderers | |
Virtual method to get a renderer |
GcrViewer * gcr_viewer_new (void
);
Get an implementation of GcrViewer that supports a view of multiple renderers.
Returns : |
a newly allocated GcrViewer, which should be
released with g_object_unref() . [transfer full]
|
GcrViewer * gcr_viewer_new_scrolled (void
);
Get an implementation of GcrViewer that supports a scrolled view of multiple renderers.
Returns : |
a newly allocated GcrViewer, which should be
released with g_object_unref() . [transfer full]
|
void gcr_viewer_add_renderer (GcrViewer *viewer
,GcrRenderer *renderer
);
Add a renderer to this viewer.
|
The viewer |
|
The renderer to add |
void gcr_viewer_insert_renderer (GcrViewer *viewer
,GcrRenderer *renderer
,GcrRenderer *before
);
Insert a renderer at a specific point in the viewer
|
the viewer |
|
the renderer to insert |
|
the renderer to insert before. [allow-none] |
void gcr_viewer_remove_renderer (GcrViewer *viewer
,GcrRenderer *renderer
);
Remove a renderer from this viewer.
|
The viewer |
|
The renderer to remove |
guint gcr_viewer_count_renderers (GcrViewer *viewer
);
Get the number of renderers present in the viewer.
|
The viewer |
Returns : |
The number of renderers. |
GcrRenderer * gcr_viewer_get_renderer (GcrViewer *viewer
,guint index_
);
Get a pointer to the renderer at the given index. It is an error to request an index that is out of bounds.
|
The viewer |
|
The index of the renderer to get |
Returns : |
the render, owned by the viewer. [transfer none] |