![]() |
![]() |
![]() |
GOffice Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
GOComponent; GOComponentClass; void (*GOComponentSaxHandler) (GOComponent *component
,gpointer user_data
); enum GOSnapshotType; GOSnapshotType go_component_build_snapshot (GOComponent *component
); GOComponent * go_component_duplicate (GOComponent const *component
); GtkWindow* go_component_edit (GOComponent *component
); void go_component_emit_changed (GOComponent *component
); gboolean go_component_export_image (GOComponent *component
,GOImageFormat format
,GsfOutput *output
,double x_dpi
,double y_dpi
); GOCmdContext * go_component_get_command_context (GOComponent *component
); gboolean go_component_get_data (GOComponent *component
,gpointer *data
,int *length
,GDestroyNotify *clearfunc
,gpointer *user_data
); char const * go_component_get_mime_type (GOComponent *component
); void go_component_get_size (GOComponent *component
,double *width
,double *height
); void const * go_component_get_snapshot (GOComponent *component
,GOSnapshotType *type
,size_t *length
); gboolean go_component_is_editable (GOComponent *component
); gboolean go_component_is_resizable (GOComponent *component
); GOComponent * go_component_new_by_mime_type (char const *mime_type
); GOComponent * go_component_new_from_uri (char const *uri
); void go_component_render (GOComponent *component
,cairo_t *cr
,double width
,double height
); void go_component_sax_push_parser (GsfXMLIn *xin
,xmlChar const **attrs
,GOComponentSaxHandler handler
,gpointer user_data
); void go_component_set_command_context (GOComponent *component
,GOCmdContext *cc
); void go_component_set_data (GOComponent *component
,char const *data
,int length
); void go_component_set_default_command_context (GOCmdContext *cc
); void go_component_set_default_size (GOComponent *component
,double width
,double ascent
,double descent
); gboolean go_component_set_font (GOComponent *component
,PangoFontDescription const *desc
); void go_component_set_size (GOComponent *component
,double width
,double height
); void go_component_set_window (GOComponent *component
,GdkWindow *window
); void go_component_stop_editing (GOComponent *component
); void go_component_write_xml_sax (GOComponent *component
,GsfXMLOut *output
);
"ascent" gdouble : Read / Write "descent" gdouble : Read / Write "height" gdouble : Read "mime-type" gchar* : Read / Write / Construct Only "width" gdouble : Read / Write
typedef struct { GObjectClass parent_class; GtkWindow* (*edit) (GOComponent *component); gboolean (*get_data) (GOComponent *component, gpointer *data, int *length, GDestroyNotify *clearfunc, gpointer *user_data); void (*mime_type_set) (GOComponent* component); void (*set_data) (GOComponent *component); void (*set_default_size) (GOComponent* component); void (*set_size) (GOComponent *component); void (*render) (GOComponent *component, cairo_t *cr, double width, double height); gboolean (*set_font) (GOComponent *component, PangoFontDescription const *desc); } GOComponentClass;
The component base object class.
GObjectClass |
the parent object class. |
callback for component edition. | |
returns the data embedded in the component. | |
sets the mime type. | |
sets the data embedded in the component. | |
sets the default size for the component. | |
sets the requested size. | |
displays the contents. | |
sets the default font for the component. |
void (*GOComponentSaxHandler) (GOComponent *component
,gpointer user_data
);
|
|
|
typedef enum { GO_SNAPSHOT_NONE, GO_SNAPSHOT_SVG, GO_SNAPSHOT_PNG, /* <private> */ GO_SNAPSHOT_MAX } GOSnapshotType;
GOSnapshotType go_component_build_snapshot (GOComponent *component
);
|
|
Returns : |
GOComponent * go_component_duplicate (GOComponent const *component
);
Duplicates the component.
|
a GOComponent |
Returns : |
the duplicated component. [transfer full] |
GtkWindow* go_component_edit (GOComponent *component
);
Opens a top level window editor for the component if it can be edited.
|
GOComponent |
Returns : |
the editor window or NULL. [transfer none] |
gboolean go_component_export_image (GOComponent *component
,GOImageFormat format
,GsfOutput *output
,double x_dpi
,double y_dpi
);
Exports an image of graph
in given format
, writing results in a GsfOutput stream.
If export format type is a bitmap one, it computes image size with x_dpi, y_dpi and
graph
size (see @gog_graph_get_size()
).
|
a GOComponent |
|
image format for export |
|
a GsfOutput stream |
|
x resolution of exported graph |
|
y resolution of exported graph |
Returns : |
TRUE if export succeed.
|
GOCmdContext * go_component_get_command_context (GOComponent *component
);
|
GOComponent |
Returns : |
the command context used by the component or the default command context if the argument is NULL. [transfer none] |
gboolean go_component_get_data (GOComponent *component
,gpointer *data
,int *length
,GDestroyNotify *clearfunc
,gpointer *user_data
);
|
|
|
|
|
|
|
|
|
|
Returns : |
char const * go_component_get_mime_type (GOComponent *component
);
|
|
Returns : |
void go_component_get_size (GOComponent *component
,double *width
,double *height
);
|
|
|
|
|
void const * go_component_get_snapshot (GOComponent *component
,GOSnapshotType *type
,size_t *length
);
Returns a snapshot is either svg or png format for the component.
|
GOComponent |
|
GOSnapshotType |
|
where to store the data length |
Returns : |
the snapshot as an arry of bytes. [transfer none] |
gboolean go_component_is_editable (GOComponent *component
);
|
|
Returns : |
gboolean go_component_is_resizable (GOComponent *component
);
|
|
Returns : |
GOComponent * go_component_new_by_mime_type (char const *mime_type
);
|
|
Returns : |
GOComponent * go_component_new_from_uri (char const *uri
);
|
|
Returns : |
void go_component_render (GOComponent *component
,cairo_t *cr
,double width
,double height
);
|
|
|
|
|
|
|
void go_component_sax_push_parser (GsfXMLIn *xin
,xmlChar const **attrs
,GOComponentSaxHandler handler
,gpointer user_data
);
Loads the component from the xml stream. handler
will be called when done.
|
GsfInput |
|
the current node attributes. |
|
GOComponentSaxHandler. [scope call] |
|
data to pass to handler
|
void go_component_set_command_context (GOComponent *component
,GOCmdContext *cc
);
|
|
|
void go_component_set_data (GOComponent *component
,char const *data
,int length
);
|
|
|
|
|
void go_component_set_default_command_context
(GOCmdContext *cc
);
|
void go_component_set_default_size (GOComponent *component
,double width
,double ascent
,double descent
);
|
|
|
|
|
|
|
gboolean go_component_set_font (GOComponent *component
,PangoFontDescription const *desc
);
Sets the font the component should use. Not all components will actually changed the font they use.
|
GOComponent |
|
PangoFontDescription |
Returns : |
TRUE if size changed.
|
void go_component_set_size (GOComponent *component
,double width
,double height
);
|
|
|
|
|
void go_component_set_window (GOComponent *component
,GdkWindow *window
);
|
|
|
void go_component_write_xml_sax (GOComponent *component
,GsfXMLOut *output
);
|
|
|
"ascent"
property"ascent" gdouble : Read / Write
Component ascent.
Allowed values: >= 0
Default value: 0
"descent"
property"descent" gdouble : Read / Write
Component descent.
Allowed values: >= 0
Default value: 0
"height"
property"height" gdouble : Read
Component height.
Allowed values: >= 0
Default value: 0
"mime-type"
property"mime-type" gchar* : Read / Write / Construct Only
mime type of the content of the component.
Default value: NULL
"width"
property"width" gdouble : Read / Write
Component width.
Allowed values: >= 0
Default value: 0
"changed"
signalvoid user_function (GOComponent *gocomponent, gpointer user_data) : Run Last
@:
|
the object which received the signal. |
|
user data set when the signal handler was connected. |