|  |  |  | Gcr Library Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals | ||||
GcrViewerWidget; GcrViewerWidget * gcr_viewer_widget_new (void); void gcr_viewer_widget_load_data (GcrViewerWidget *self,const gchar *display_name,const guchar *data,gsize n_data); void gcr_viewer_widget_load_file (GcrViewerWidget *self,GFile *file); GcrParser * gcr_viewer_widget_get_parser (GcrViewerWidget *self); void gcr_viewer_widget_show_error (GcrViewerWidget *self,const gchar *message,GError *error); void gcr_viewer_widget_clear_error (GcrViewerWidget *self); const gchar * gcr_viewer_widget_get_display_name (GcrViewerWidget *self); void gcr_viewer_widget_set_display_name (GcrViewerWidget *self,const gchar *display_name);
GObject +----GInitiallyUnowned +----GtkWidget +----GtkContainer +----GtkBox +----GcrViewerWidget
GcrViewerWidget implements AtkImplementorIface, GtkBuildable and GtkOrientable.
GcrViewerWidget *   gcr_viewer_widget_new               (void);
Create a new viewer widget.
| Returns : | A new GcrViewerWidget object. [transfer full] | 
void gcr_viewer_widget_load_data (GcrViewerWidget *self,const gchar *display_name,const guchar *data,gsize n_data);
Parse and load some data to be displayed into the viewer widgets. The data may contain multiple parseable items if the format can contain multiple items.
| 
 | a viewer widget | 
| 
 | label for the loaded data. [allow-none] | 
| 
 | data to load. [array length=n_data] | 
| 
 | length of data to load | 
void gcr_viewer_widget_load_file (GcrViewerWidget *self,GFile *file);
Display contents of a file in the viewer widget. Multiple files can be loaded.
| 
 | a viewer widget | 
| 
 | a file to load | 
GcrParser *         gcr_viewer_widget_get_parser        (GcrViewerWidget *self);
Get the parser used to parse loaded data into viewable items.
| 
 | a viewer widget | 
| Returns : | the parser. [transfer none] | 
void gcr_viewer_widget_show_error (GcrViewerWidget *self,const gchar *message,GError *error);
Show an error on the viewer widget. This is displayed on a info bar near the edge of the widget.
| 
 | a viewer widget | 
| 
 | descriptive error message | 
| 
 | detailed error. [allow-none] | 
void                gcr_viewer_widget_clear_error       (GcrViewerWidget *self);
Clear the error displayed on the viewer widget.
| 
 | a viewer widget | 
const gchar *       gcr_viewer_widget_get_display_name  (GcrViewerWidget *self);
Get the display name for data being displayed. This is automatically calculated from a loaded file, or can be explicitly set.
Used as a hint when displaying a title for the data, but may be overridden by the parsed data.
| 
 | a viewer widget | 
| Returns : | the display name | 
void gcr_viewer_widget_set_display_name (GcrViewerWidget *self,const gchar *display_name);
Set the display name for data being displayed. Once explicitly set it will no longer be calculated automatically by loading data.
Used as a hint when displaying a title for the data, but may be overridden by the parsed data.
| 
 | a viewer widget | 
| 
 | the display name | 
"display-name" property"display-name" gchar* : Read / Write
Display name for data being displayed. This is automatically calculated from a loaded file, or can be explicitly set.
Used as a hint when displaying a title for the data, but may be overridden by the parsed data.
Default value: NULL
"parser" property"parser" GcrParser* : Read
The parser used to parse loaded data into viewable items.
"added" signalvoid                user_function                      (GcrViewerWidget *self,
                                                        GObject         *renderer,
                                                        GcrParsed       *parsed,
                                                        gpointer         user_data)      : Run Last
This signal is emitted when an item is added to the viewer widget.
| 
 | the viewer widget | 
| 
 | the renderer that was added. [type Gcr.Renderer] | 
| 
 | the parsed item that was added. [type Gcr.Parsed] | 
| 
 | user data set when the signal handler was connected. |