![]() |
![]() |
![]() |
Conglomerate Programmer's Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
#define CONG_PLUGIN (obj) #define CONG_PLUGIN_CLASS (klass) #define IS_CONG_PLUGIN (obj) CongPlugin * cong_plugin_construct (CongPlugin *plugin, const gchar *plugin_id, CongPluginCallbackRegister register_callback, CongPluginCallbackConfigure configure_callback); void cong_plugin_add_service (CongPlugin *plugin, CongService *service); void cong_plugin_for_each_service (CongPlugin *plugin, void (callbackCongService *service,gpointer user_data) (), gpointer user_data); void cong_plugin_for_each_service_of_type (CongPlugin *plugin, GType type, void (callbackCongService *service,gpointer user_data) (), gpointer user_data); CongService * cong_plugin_locate_service_by_id (CongPlugin *plugin, GType type, const gchar *service_id); CongServiceNodePropertyDialog * cong_plugin_locate_custom_property_dialog_by_id (CongPlugin *plugin, const gchar *service_id); CongServiceEditorNodeFactory * cong_plugin_locate_editor_node_factory_by_id (CongPlugin *plugin, const gchar *service_id); const gchar * cong_plugin_get_id (CongPlugin *plugin); gchar * cong_plugin_get_gconf_namespace (CongPlugin *plugin); gchar * cong_plugin_get_gconf_key (CongPlugin *plugin, const gchar *local_part); CongDocument * cong_ui_new_document_from_manufactured_xml (xmlDocPtr xml_doc, GtkWindow *parent_window); CongDocument * cong_ui_new_document_from_imported_xml (xmlDocPtr xml_doc, GtkWindow *parent_window); xmlDocPtr cong_ui_transform_doc (CongDocument *doc, const gchar *stylesheet_filename, GList *list_of_parameters, GtkWindow *toplevel_window); gboolean cong_ui_transform_doc_to_uri (CongDocument *doc, const gchar *stylesheet_filename, GList *list_of_parameters, const gchar *string_uri, GtkWindow *toplevel_window); gboolean cong_ui_load_imported_file_content (const gchar *uri, char **buffer, GnomeVFSFileSize *size, GtkWindow *parent_window); void cong_ui_append_advanced_node_properties_page (GtkNotebook *notebook, CongDocument *doc, CongNodePtr node);
#define CONG_PLUGIN(obj) G_TYPE_CHECK_INSTANCE_CAST (obj, CONG_PLUGIN_TYPE, CongPlugin)
|
#define CONG_PLUGIN_CLASS(klass) G_TYPE_CHECK_CLASS_CAST (klass, CONG_PLUGIN_TYPE, CongPluginClass)
|
#define IS_CONG_PLUGIN(obj) G_TYPE_CHECK_INSTANCE_TYPE (obj, CONG_PLUGIN_TYPE)
|
CongPlugin * cong_plugin_construct (CongPlugin *plugin, const gchar *plugin_id, CongPluginCallbackRegister register_callback, CongPluginCallbackConfigure configure_callback);
TODO: Write me
|
|
|
|
|
|
|
|
Returns : |
void cong_plugin_add_service (CongPlugin *plugin, CongService *service);
TODO: Write me
|
|
|
void cong_plugin_for_each_service (CongPlugin *plugin, void (callbackCongService *service,gpointer user_data) (), gpointer user_data);
TODO: Write me
|
|
|
|
|
void cong_plugin_for_each_service_of_type (CongPlugin *plugin, GType type, void (callbackCongService *service,gpointer user_data) (), gpointer user_data);
TODO: Write me
|
|
|
|
|
|
|
CongService * cong_plugin_locate_service_by_id (CongPlugin *plugin, GType type, const gchar *service_id);
TODO: Write me
|
|
|
|
|
|
Returns : |
CongServiceNodePropertyDialog * cong_plugin_locate_custom_property_dialog_by_id (CongPlugin *plugin, const gchar *service_id);
TODO: Write me
|
|
|
|
Returns : |
CongServiceEditorNodeFactory * cong_plugin_locate_editor_node_factory_by_id (CongPlugin *plugin, const gchar *service_id);
TODO: Write me
|
|
|
|
Returns : |
const gchar * cong_plugin_get_id (CongPlugin *plugin);
TODO: Write me
|
|
Returns : |
gchar * cong_plugin_get_gconf_namespace (CongPlugin *plugin);
TODO: Write me
|
|
Returns : |
gchar * cong_plugin_get_gconf_key (CongPlugin *plugin, const gchar *local_part);
Convert a "local" GConf key for this plugin to a GConf key with a full-path. e.g. converts "enable-fubar" to "/apps/conglomerate/plugins/docbook/enable-fubar" Caller must delete returned string.
|
|
|
|
Returns : |
CongDocument * cong_ui_new_document_from_manufactured_xml (xmlDocPtr xml_doc, GtkWindow *parent_window);
TODO: Write me
|
|
|
|
Returns : |
CongDocument * cong_ui_new_document_from_imported_xml (xmlDocPtr xml_doc, GtkWindow *parent_window);
TODO: Write me
|
|
|
|
Returns : |
xmlDocPtr cong_ui_transform_doc (CongDocument *doc, const gchar *stylesheet_filename, GList *list_of_parameters, GtkWindow *toplevel_window);
TODO: Write me
The routine sets all primary windows of Conglomerate to have a busy cursor whilst the processing occurs. It will not pick up any dialog, or other, windows that may have been created by Conglomerate. At the moment this is not a problem, but it may be in the future. It may be possible to use GTK (or GDK) functions to fid all the windows that are currently controlled by Conglomerate, and so avoid this issue.
|
|
|
|
|
a GList of CongStylesheetParameter |
|
|
Returns : |
gboolean cong_ui_transform_doc_to_uri (CongDocument *doc, const gchar *stylesheet_filename, GList *list_of_parameters, const gchar *string_uri, GtkWindow *toplevel_window);
Applies the stylesheet (stylesheet_filename
) to the
document (doc
) and saves the output to string_uri
.
At present, it is assumed that a dialog window will be created if there is an error in the processing (e.g. unable to find the stylesheet or write to the given URI). No dialog is created on success (so that the calling routine can customise such a dialog, or not have one).
It also relies on the #cong_ui_transform_doc()
routines for
providing feed-back to the user that something is happening.
|
|
|
|
|
a GList of CongStylesheetParameter |
|
|
|
|
Returns : |
true on success, false on failure. |
gboolean cong_ui_load_imported_file_content (const gchar *uri, char **buffer, GnomeVFSFileSize *size, GtkWindow *parent_window);
TODO: Write me
|
|
|
|
|
|
|
|
Returns : |
void cong_ui_append_advanced_node_properties_page (GtkNotebook *notebook, CongDocument *doc, CongNodePtr node);
TODO: Write me
|
|
|
|
|