diff options
Diffstat (limited to 'doc/devel')
14 files changed, 1097 insertions, 0 deletions
diff --git a/doc/devel/executive-summary/Makefile.am b/doc/devel/executive-summary/Makefile.am new file mode 100644 index 0000000000..9aa53af4ec --- /dev/null +++ b/doc/devel/executive-summary/Makefile.am @@ -0,0 +1,125 @@ +# The name of the module. +DOC_MODULE=evolution-services + +# The directory containing the source code +DOC_SOURCE_DIR=$(EVOLUTION_DIR)/executive-summary/evolution-services + +CFLAGS =" \ + -I$(top_srcdir)/executive-summary/evolution-services \ + -I$(top_srcdir)/executive-summary \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + $(BONOBO_VFS_GNOME_CFLAGS) \ + " + +LDFLAGS=" \ + $(BONOBO_VFS_GNOME_LIBS) \ + $(top_builddir)/executive-summary/evolution-services/.libs/libevolution-services.a \ + " + +DOC_DIR=$(datadir)/gnome/html + +DOC_DIR_INSTALL_FILES = \ + evolution-services.args \ + evolution-services.hierarchy \ + evolution-services.signals \ + evolution-services.types \ + evolution-services-decl.txt \ + evolution-services-sections.txt + +SOURCE_FILES = \ + $(top_srcdir)/executive-summary/evolution-services/executive-summary-component.c \ + $(top_srcdir)/executive-summary/evolution-services/executive-summary-component-factory-client.c \ + $(top_srcdir)/executive-summary/evolution-services/executive-summary-html-view.c + +IGNORED_HEADER_FILES = \ + Executive-Summary.h + +scan_generated = \ + evolution-services-decl.txt \ + evolution-services.args \ + evolution-services.hierarchy \ + evolution-services.signals \ + evolution-services.types + +tmpl_dependencies = \ + evolution-services-decl.txt \ + evolution-services-sections.txt \ + evolution-services.args \ + evolution-services.hierarchy \ + evolution-services.signals + +tmpl_sources = \ + tmpl/evolution-services.sgml \ + tmpl/evolution-services-unused.sgml + +tmpl_generated = \ + evolution-services-unused.txt + +sgml_dependencies = \ + evolution-services-decl.txt \ + evolution-services-sections.txt \ + evolution-services.args \ + evolution-services.hierarchy \ + evolution-services.signals \ + tmpl/evolution-services.sgml + +sgml_generated = \ + sgml/evolution-services.sgml \ + sgml/evolution-services-doc.bottom \ + sgml/evolution-services-doc.top \ + sgml/object_index.sgml \ + sgml/tree_index.sgml + +EXTRA_DIST = \ + evolution-services.args \ + evolution-services.hierarchy \ + evolution-services.signals \ + evolution-services.types \ + evolution-services-decl.txt \ + evolution-services-sections.txt + +all: $(sgml_generated) + +if ENABLE_GTK_DOC +scan $(scan_generated): $(SOURCE_FILES) + -(cd $(srcdir) \ + && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ + gtkdoc-scanobj --module=$(DOC_MODULE) \ + && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \ + --ignore-headers="$(IGNORED_HEADER_FILES)" ) + +templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) + cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) + +sgml $(sgml_generated): $(sgml_dependencies) + cd $(srcdir) \ + && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) +else +scan $(scan_generated): $(SOURCE_FILE) + +templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) + +sgml $(sgml_generated): $(sgml_dependencies) +endif + +clean-local: + rm -f *~ *.bak *.signals *-unused.txt + +maintainer-clean-local: clean + cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + +install-data-local: + $(mkinstalldirs) $(DOC_DIR) + for i in $(DOC_DIR_INSTALL_FILES); do \ + $(INSTALL_DATA) $$i $(DOC_DIR); \ + done + +dist-hook: + mkdir $(distdir)/sgml + mkdir $(distdir)/tmpl + -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl + -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml + -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml + +.PHONY: scan templates sgml diff --git a/doc/devel/executive-summary/evolution-services-decl.txt b/doc/devel/executive-summary/evolution-services-decl.txt new file mode 100644 index 0000000000..df84080700 --- /dev/null +++ b/doc/devel/executive-summary/evolution-services-decl.txt @@ -0,0 +1,599 @@ +<MACRO> +<NAME>EXECUTIVE_SUMMARY_CLIENT_TYPE</NAME> +#define EXECUTIVE_SUMMARY_CLIENT_TYPE (executive_summary_client_get_type ()) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_CLIENT</NAME> +#define EXECUTIVE_SUMMARY_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE, ExecutiveSummaryClient)) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_CLIENT_CLASS</NAME> +#define EXECUTIVE_SUMMARY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_CLIENT_TYPE, ExecutiveSummaryClientClass)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_CLIENT</NAME> +#define IS_EXECUTIVE_SUMMARY_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_CLIENT_CLASS</NAME> +#define IS_EXECUTIVE_SUMMARY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE)) +</MACRO> +<STRUCT> +<NAME>ExecutiveSummaryClientPrivate</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryClient</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryClientClass</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryClient</NAME> +struct ExecutiveSummaryClient { + BonoboObjectClient parent; + + ExecutiveSummaryClientPrivate *private; +}; +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryClientClass</NAME> +struct ExecutiveSummaryClientClass { + BonoboObjectClientClass parent_class; +}; +</STRUCT> +<FUNCTION> +<NAME>executive_summary_client_get_type</NAME> +<RETURNS>GtkType </RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_client_construct</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryClient *client,CORBA_Object object +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_client_set_title</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryClient *client,int id,const char *title +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_client_set_icon</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryClient *client,int id,const char *icon +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_client_flash</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryClient *client,int id +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_client_update</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryClient *client,int id,const char *html +</FUNCTION> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE (executive_summary_component_factory_client_get_type ()) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE, ExecutiveSummaryComponentFactoryClient)) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE, ExecutiveSummaryComponentFactoryClientClass)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT</NAME> +#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS</NAME> +#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE)) +</MACRO> +<STRUCT> +<NAME>ExecutiveSummaryComponentFactoryClientPrivate</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentFactoryClient</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentFactoryClientClass</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentFactoryClient</NAME> +struct ExecutiveSummaryComponentFactoryClient { + BonoboObjectClient parent; + + ExecutiveSummaryComponentFactoryClientPrivate *private; +}; +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentFactoryClientClass</NAME> +struct ExecutiveSummaryComponentFactoryClientClass { + BonoboObjectClientClass parent_class; +}; +</STRUCT> +<FUNCTION> +<NAME>executive_summary_component_factory_client_get_type</NAME> +<RETURNS>GtkType </RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_factory_client_construct</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentFactoryClient *client,CORBA_Object corba_object +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_factory_client_new</NAME> +<RETURNS>ExecutiveSummaryComponentFactoryClient *</RETURNS> +const char *id +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_factory_client_create_view</NAME> +<RETURNS>CORBA_Object </RETURNS> +ExecutiveSummaryComponentFactoryClient *client +</FUNCTION> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_TYPE</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_TYPE (executive_summary_component_get_type ()) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE, ExecutiveSummaryComponent)) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLASS</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_TYPE, ExecutiveSummaryComponentClass)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT</NAME> +#define IS_EXECUTIVE_SUMMARY_COMPONENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_CLASS</NAME> +#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE)) +</MACRO> +<STRUCT> +<NAME>ExecutiveSummaryComponentPrivate</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponent</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentClass</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponent</NAME> +struct ExecutiveSummaryComponent { + BonoboObject parent; + + ExecutiveSummaryComponentPrivate *private; +}; +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentClass</NAME> +struct ExecutiveSummaryComponentClass { + BonoboObjectClass parent_class; +}; +</STRUCT> +<FUNCTION> +<NAME>executive_summary_component_get_type</NAME> +<RETURNS>GtkType </RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_new</NAME> +<RETURNS>BonoboObject *</RETURNS> +void +</FUNCTION> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE (executive_summary_component_factory_get_type ()) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE, ExecutiveSummaryComponentFactory)) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE, ExecutiveSummaryComponentFactoryClass)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY</NAME> +#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS</NAME> +#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE)) +</MACRO> +<STRUCT> +<NAME>ExecutiveSummaryComponentFactoryPrivate</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentFactory</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentFactoryClass</NAME> +</STRUCT> +<USER_FUNCTION> +<NAME>EvolutionServicesCreateViewFn</NAME> +<RETURNS>BonoboObject *</RETURNS> +ExecutiveSummaryComponentFactory *factory, + void *closure +</USER_FUNCTION> +<STRUCT> +<NAME>ExecutiveSummaryComponentFactory</NAME> +struct ExecutiveSummaryComponentFactory { + BonoboObject parent; + + ExecutiveSummaryComponentFactoryPrivate *private; +}; +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentFactoryClass</NAME> +struct ExecutiveSummaryComponentFactoryClass { + BonoboObjectClass parent_class; +}; +</STRUCT> +<FUNCTION> +<NAME>executive_summary_component_factory_get_type</NAME> +<RETURNS>GtkType </RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_factory_new</NAME> +<RETURNS>BonoboObject *</RETURNS> +EvolutionServicesCreateViewFn create_view,void *closure +</FUNCTION> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED</NAME> +#define EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED "GNOME:Evolution:Summary:HTMLView:html_changed" +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_HTML_VIEW_TYPE</NAME> +#define EXECUTIVE_SUMMARY_HTML_VIEW_TYPE (executive_summary_html_view_get_type ()) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_HTML_VIEW</NAME> +#define EXECUTIVE_SUMMARY_HTML_VIEW(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE, ExecutiveSummaryHtmlView)) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_HTML_VIEW_CLASS</NAME> +#define EXECUTIVE_SUMMARY_HTML_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE, ExecutiveSummaryHtmlViewClass)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_HTML_VIEW</NAME> +#define IS_EXECUTIVE_SUMMARY_HTML_VIEW(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_HTML_VIEW_CLASS</NAME> +#define IS_EXECUTIVE_SUMMARY_HTML_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE)) +</MACRO> +<STRUCT> +<NAME>ExecutiveSummaryHtmlViewPrivate</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryHtmlView</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryHtmlViewClass</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryHtmlView</NAME> +struct ExecutiveSummaryHtmlView { + BonoboObject parent; + + ExecutiveSummaryHtmlViewPrivate *private; +}; +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryHtmlViewClass</NAME> +struct ExecutiveSummaryHtmlViewClass { + BonoboObjectClass parent_class; +}; +</STRUCT> +<FUNCTION> +<NAME>executive_summary_html_view_get_type</NAME> +<RETURNS>GtkType </RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_html_view_new_full</NAME> +<RETURNS>BonoboObject *</RETURNS> +BonoboEventSource *event_source +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_html_view_new</NAME> +<RETURNS>BonoboObject *</RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_html_view_set_html</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryHtmlView *view,const char *html +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_html_view_get_html</NAME> +<RETURNS>const char *</RETURNS> +ExecutiveSummaryHtmlView *view +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_html_view_get_event_source</NAME> +<RETURNS>BonoboEventSource *</RETURNS> +ExecutiveSummaryHtmlView *view +</FUNCTION> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE (executive_summary_component_client_get_type ()) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLIENT</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE, ExecutiveSummaryComponentClient)) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE, ExecutiveSummaryComponentClientClass)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT</NAME> +#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS</NAME> +#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE)) +</MACRO> +<STRUCT> +<NAME>ExecutiveSummaryComponentClientPrivate</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentClient</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentClientClass</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentClient</NAME> +struct ExecutiveSummaryComponentClient { + BonoboObjectClient parent; + + ExecutiveSummaryComponentClientPrivate *private; +}; +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentClientClass</NAME> +struct ExecutiveSummaryComponentClientClass { + BonoboObjectClientClass parent_class; +}; +</STRUCT> +<FUNCTION> +<NAME>executive_summary_component_client_get_type</NAME> +<RETURNS>GtkType </RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_client_new</NAME> +<RETURNS>ExecutiveSummaryComponentClient *</RETURNS> +const char *id +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_client_set_owner</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentClient *client,ExecutiveSummary *summary +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_client_unset_owner</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentClient *client +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_client_supports</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentClient *client,gboolean *bonobo,gboolean *html +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_client_configure</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentClient *client,ExecutiveSummaryComponentView *view +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_client_destroy_view</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentClient *client,ExecutiveSummaryComponentView *view +</FUNCTION> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_TYPE</NAME> +#define EXECUTIVE_SUMMARY_TYPE (executive_summary_get_type ()) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY</NAME> +#define EXECUTIVE_SUMMARY(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_TYPE, ExecutiveSummary)) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_CLASS</NAME> +#define EXECUTIVE_SUMMARY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_TYPE, ExecutiveSummaryClass)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY</NAME> +#define IS_EXECUTIVE_SUMMARY(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_TYPE)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_CLASS</NAME> +#define IS_EXECUTIVE_SUMMARY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_TYPE)) +</MACRO> +<STRUCT> +<NAME>ExecutiveSummaryPrivate</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummary</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryClass</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummary</NAME> +struct ExecutiveSummary { + BonoboObject parent; + + ExecutiveSummaryPrivate *private; +}; +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryClass</NAME> +struct ExecutiveSummaryClass { + BonoboObjectClass parent_class; + + void (* update) (ExecutiveSummary *summary, + const GNOME_Evolution_Summary_Component component, + const char *html); + void (* set_title) (ExecutiveSummary *summary, + const GNOME_Evolution_Summary_Component component, + const char *title); + void (* set_icon) (ExecutiveSummary *summary, + const GNOME_Evolution_Summary_Component component, + const char *icon); + void (* flash) (ExecutiveSummary *summary, + const GNOME_Evolution_Summary_Component component); +}; +</STRUCT> +<FUNCTION> +<NAME>executive_summary_get_type</NAME> +<RETURNS>GtkType </RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_construct</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummary *es,GNOME_Evolution_Summary_ViewFrame corba_object +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_new</NAME> +<RETURNS>BonoboObject *</RETURNS> +void +</FUNCTION> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE (executive_summary_component_view_get_type ()) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_VIEW</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_VIEW(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE, ExecutiveSummaryComponentView)) +</MACRO> +<MACRO> +<NAME>EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS</NAME> +#define EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE, ExecutiveSummaryComponentClass)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW</NAME> +#define IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE)) +</MACRO> +<MACRO> +<NAME>IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS</NAME> +#define IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS_TYPE)) +</MACRO> +<STRUCT> +<NAME>ExecutiveSummaryComponentViewPrivate</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentView</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentViewClass</NAME> +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentView</NAME> +struct ExecutiveSummaryComponentView { + GtkObject object; + + ExecutiveSummaryComponentViewPrivate *private; +}; +</STRUCT> +<STRUCT> +<NAME>ExecutiveSummaryComponentViewClass</NAME> +struct ExecutiveSummaryComponentViewClass { + GtkObjectClass parent_class; + + /* Signals */ + void (* configure) (ExecutiveSummaryComponentView *view); +}; +</STRUCT> +<FUNCTION> +<NAME>executive_summary_component_view_get_type</NAME> +<RETURNS>GtkType </RETURNS> +void +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_construct</NAME> +<RETURNS>void</RETURNS> +ExecutiveSummaryComponentView *view,ExecutiveSummaryComponent *component,BonoboControl *control,const char *html,const char *title,const char *icon +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_new</NAME> +<RETURNS>ExecutiveSummaryComponentView *</RETURNS> +ExecutiveSummaryComponent *component,BonoboControl *control,const char *html,const char *title,const char *icon +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_set_title</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentView *view,const char *title +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_get_title</NAME> +<RETURNS>const char *</RETURNS> +ExecutiveSummaryComponentView *view +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_set_icon</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentView *view,const char *icon +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_get_icon</NAME> +<RETURNS>const char *</RETURNS> +ExecutiveSummaryComponentView *view +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_flash</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentView *view +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_set_html</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentView *view,const char *html +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_get_html</NAME> +<RETURNS>const char *</RETURNS> +ExecutiveSummaryComponentView *view +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_get_control</NAME> +<RETURNS>BonoboObject *</RETURNS> +ExecutiveSummaryComponentView *view +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_get_id</NAME> +<RETURNS>int </RETURNS> +ExecutiveSummaryComponentView *view +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_set_id</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentView *view,int id +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_configure</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentView *view +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_set_objref</NAME> +<RETURNS>void </RETURNS> +ExecutiveSummaryComponentView *view,Bonobo_Control objref +</FUNCTION> +<FUNCTION> +<NAME>executive_summary_component_view_get_widget</NAME> +<RETURNS>GtkWidget *</RETURNS> +ExecutiveSummaryComponentView *view +</FUNCTION> diff --git a/doc/devel/executive-summary/evolution-services-sections.txt b/doc/devel/executive-summary/evolution-services-sections.txt new file mode 100644 index 0000000000..8ba2b42317 --- /dev/null +++ b/doc/devel/executive-summary/evolution-services-sections.txt @@ -0,0 +1,95 @@ +<INCLUDE>executive-summary-component.h</INCLUDE> +<SECTION> +<FILE>executive-summary-component</FILE> +EXECUTIVE_SUMMARY_COMPONENT +<TITLE>ExecutiveSummaryComponent</TITLE> + +executive_summary_component_new + +<SUBSECTION Standard> +EXECUTIVE_SUMMARY_COMPONENT_TYPE +EXECUTIVE_SUMMARY_COMPONENT +EXECUTIVE_SUMMARY_COMPONENT_CLASS +IS_EXECUTIVE_SUMMARY_COMPONENT +IS_EXECUTIVE_SUMMARY_COMPONENT_CLASS +executive_summary_component_get_type + +<SUBSECTION Private> +ExecutiveSummaryComponent +ExecutiveSummaryComponentPrivate + +</SECTION> + +<SECTION> +<FILE>executive-summary-component-factory</FILE> +EXECUTIVE_SUMMARY_COMPONENT_FACTORY +<TITLE>ExecutiveSummaryComponentFactory</TITLE> + +EvolutionServicesCreateViewFn + +executive_summary_component_factory_new + +<SUBSECTION Standard> +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE +EXECUTIVE_SUMMARY_COMPONENT_FACTORY +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS +IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY +IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS +executive_summary_component_factory_get_type + +<SUBSECTION Private> +ExecutiveSummaryComponentFactory +ExecutiveSummaryComponentFactoryPrivate + +</SECTION> + +<INCLUDE>executive-summary-component-factory-client.h</INCLUDE> +<SECTION> +<FILE>executive-summary-component-factory-client</FILE> +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT +<TITLE>ExecutiveSummaryComponentFactoryClient</TITLE> + +executive_summary_component_factory_client_construct +executive_summary_component_factory_client_new +executive_summary_component_factory_client_create_view + +<SUBSECTION Standard> +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS +IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT +IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS +executive_summary_component_factory_client_get_type + +<SUBSECTION Private> +ExecutiveSummaryComponentFactoryClient +ExecutiveSummaryComponentFactoryClientPrivate + +</SECTION> + +<INCLUDE>executive-summary-html-view.h</INCLUDE> +<SECTION> +<FILE>executive-summary-html-view</FILE> +EXECUTIVE_SUMMARY_HTML_VIEW +<TITLE>ExecutiveSummaryHtmlView</TITLE> + +EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED + +executive_summary_html_view_new_full +executive_summary_html_view_new +executive_summary_html_view_set_html +executive_summary_html_view_get_html +executive_summary_html_view_get_event_source + +<SUBSECTION Standard> +EXECUTIVE_SUMMARY_HTML_VIEW_TYPE +EXECUTIVE_SUMMARY_HTML_VIEW +IS_EXECUTIVE_SUMMARY_HTML_VIEW +EXECUTIVE_SUMMARY_HTML_VIEW_CLASS +IS_EXECUTIVE_SUMMARY_HTML_VIEW_CLASS +executive_summary_html_view_get_type + +<SUBSECTION Private> +ExecutiveSummaryHtmlView +ExecutiveSummaryHtmlViewPrivate +</SECTION> diff --git a/doc/devel/executive-summary/evolution-services.args b/doc/devel/executive-summary/evolution-services.args new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/doc/devel/executive-summary/evolution-services.args diff --git a/doc/devel/executive-summary/evolution-services.hierarchy b/doc/devel/executive-summary/evolution-services.hierarchy new file mode 100644 index 0000000000..07e7aad6ff --- /dev/null +++ b/doc/devel/executive-summary/evolution-services.hierarchy @@ -0,0 +1,15 @@ +GtkObject + GtkWidget + GtkRange + GtkScale + GtkContainer + GtkBin + GtkButton + GtkToggleButton + GtkCheckButton + BonoboObject + ExecutiveSummaryComponent + ExecutiveSummaryComponentFactory + Handle to remote Bonobo::Unknown + ExecutiveSummaryComponentFactoryClient + ExecutiveSummaryHtmlView diff --git a/doc/devel/executive-summary/evolution-services.signals b/doc/devel/executive-summary/evolution-services.signals new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/doc/devel/executive-summary/evolution-services.signals diff --git a/doc/devel/executive-summary/evolution-services.types b/doc/devel/executive-summary/evolution-services.types new file mode 100644 index 0000000000..b7ac05b89c --- /dev/null +++ b/doc/devel/executive-summary/evolution-services.types @@ -0,0 +1,10 @@ +#include <gnome.h> +#include <bonobo.h> +#include <evolution-services/executive-summary-component.h> +#include <evolution-services/executive-summary-component-factory-client.h> +#include <evolution-services/executive-summary-html-view.h> + +executive_summary_component_get_type +executive_summary_component_factory_get_type +executive_summary_component_factory_client_get_type +executive_summary_html_view_get_type diff --git a/doc/devel/executive-summary/private-reference.sgml b/doc/devel/executive-summary/private-reference.sgml new file mode 100644 index 0000000000..e06d7c1690 --- /dev/null +++ b/doc/devel/executive-summary/private-reference.sgml @@ -0,0 +1,20 @@ + <reference id="evolution-services-private-reference"> + <title>Evolution Services Private API Reference</title> + + <partintro> + <para> + This part presents the class and function reference for the + private APIs of the different components of the &Evolution; + Executive Summary Services Framework. + </para> + </partintro> + + &ExecutiveSummaryComponentFactoryClient; + </reference> + +<!-- +Local variables: +mode: sgml +sml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") +End: +--> diff --git a/doc/devel/executive-summary/public-reference.sgml b/doc/devel/executive-summary/public-reference.sgml new file mode 100644 index 0000000000..7758a9a5c8 --- /dev/null +++ b/doc/devel/executive-summary/public-reference.sgml @@ -0,0 +1,22 @@ + <reference id="evolution-services-public-reference"> + <title>Evolution Services Public API Reference</title> + + <partintro> + <para> + This part presents the class and function reference for the + public APIs of the different components of the &Evolution; + Executive Summary Services Framework. + </para> + </partintro> + + &ExecutiveSummaryComponent; + &ExecutiveSummaryComponentFactory; + &ExecutiveSummaryHtmlView; + </reference> + +<!-- +Local variables: +mode: sgml +sml-parent-document: ("../evolution-devel-guide.sgml" "book" "part" "") +End: +--> diff --git a/doc/devel/executive-summary/tmpl/evolution-services-unused.sgml b/doc/devel/executive-summary/tmpl/evolution-services-unused.sgml new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/doc/devel/executive-summary/tmpl/evolution-services-unused.sgml diff --git a/doc/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml b/doc/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml new file mode 100644 index 0000000000..ee8ef25689 --- /dev/null +++ b/doc/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml @@ -0,0 +1,53 @@ +<!-- ##### SECTION Title ##### --> +ExecutiveSummaryComponentFactoryClient + +<!-- ##### SECTION Short_Description ##### --> +GtkObject client to simplfy use of GNOME_Evolution_Summary_ComponentFactory + +<!-- ##### SECTION Long_Description ##### --> +<para> +This object provides an easy wrapper around the CORBA object that represents the + GNOME_Evolution_Summary_ComponentFactory interface. It handles conversion from +normal types to CORBA types and has error checking. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### MACRO EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT ##### --> +<para> +Casts a #GtkObject into an #ExecutiveSummaryComponentFactoryClient +</para> + +@obj: + + +<!-- ##### FUNCTION executive_summary_component_factory_client_construct ##### --> +<para> + +</para> + +@client: +@corba_object: + + +<!-- ##### FUNCTION executive_summary_component_factory_client_new ##### --> +<para> + +</para> + +@id: +@Returns: + + +<!-- ##### FUNCTION executive_summary_component_factory_client_create_view ##### --> +<para> + +</para> + +@client: +@Returns: + + diff --git a/doc/devel/executive-summary/tmpl/executive-summary-component-factory.sgml b/doc/devel/executive-summary/tmpl/executive-summary-component-factory.sgml new file mode 100644 index 0000000000..7069eea9d0 --- /dev/null +++ b/doc/devel/executive-summary/tmpl/executive-summary-component-factory.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +ExecutiveSummaryComponentFactory + +<!-- ##### SECTION Short_Description ##### --> +GtkObject wrapper for GNOME/Evolution/Summary/ComponentFactory. + +<!-- ##### SECTION Long_Description ##### --> +<para> +An ExecutiveSummaryComponentFactory simplifies the creation of a +GNOME_Evolution_Summary_ComponentFactory object. It also allows error checking +and all the standard #GtkObject signals. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### MACRO EXECUTIVE_SUMMARY_COMPONENT_FACTORY ##### --> +<para> +Casts a #GtkObject to an #ExecutiveSummaryComponentFactory. +</para> + +@obj: A #GtkObject. + + +<!-- ##### USER_FUNCTION EvolutionServicesCreateViewFn ##### --> +<para> +The type of function that is called when the factory has to create a new view. +</para> + +@factory: The #ExecutiveSummaryComponent that is creating the view. +@closure: The data that was passed into executive_summary_factory_new (). +@Returns: An #ExecutiveSummaryComponent. + + +<!-- ##### FUNCTION executive_summary_component_factory_new ##### --> +<para> + +</para> + +@create_view: +@closure: +@Returns: + + diff --git a/doc/devel/executive-summary/tmpl/executive-summary-component.sgml b/doc/devel/executive-summary/tmpl/executive-summary-component.sgml new file mode 100644 index 0000000000..04768b1b1c --- /dev/null +++ b/doc/devel/executive-summary/tmpl/executive-summary-component.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +ExecutiveSummaryComponent + +<!-- ##### SECTION Short_Description ##### --> +The base #BonoboObject that implements GNOME/Evolution/Summary/Component. + +<!-- ##### SECTION Long_Description ##### --> +<para> +This #GtkObject wrapper around the GNOME/Evolution/Summary/Component, is the +base object that has all the other interfaces aggregated onto it. These +interfaces are: GNOME/Evolution/HTMLView, Bonobo/Control, Bonobo/EventSource, +Bonobo/PropertyBag, Bonobo/PropertyControl and Bonobo/PersistStream. Each of +the aggregated interfaces performs a specific job in the creation of the service. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> +#ExecutiveSummaryHtmlView, #BonoboControl, #BonoboEventSource, #BonoboPropertyBag, +#BonoboPropertyControl, #BonoboPersistStream. +</para> + +<!-- ##### MACRO EXECUTIVE_SUMMARY_COMPONENT ##### --> +<para> +Casts a #GtkObject to an #ExecutiveSummaryComponent. +</para> + +@obj: A #GtkObject. + + +<!-- ##### FUNCTION executive_summary_component_new ##### --> +<para> + +</para> + +@Returns: + + diff --git a/doc/devel/executive-summary/tmpl/executive-summary-html-view.sgml b/doc/devel/executive-summary/tmpl/executive-summary-html-view.sgml new file mode 100644 index 0000000000..2fb66a2035 --- /dev/null +++ b/doc/devel/executive-summary/tmpl/executive-summary-html-view.sgml @@ -0,0 +1,75 @@ +<!-- ##### SECTION Title ##### --> +ExecutiveSummaryHtmlView + +<!-- ##### SECTION Short_Description ##### --> +A Bonobo component used to implement HTML based services. + +<!-- ##### SECTION Long_Description ##### --> +<para> +When writing HTML services, this component is aggregated onto an #ExecutiveSummaryComponent, to allow the Executive Summary to be able to find the HTML. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> +#ExecutiveSummaryComponent, #BonoboEventSource +</para> + +<!-- ##### MACRO EXECUTIVE_SUMMARY_HTML_VIEW ##### --> +<para> + Casts a #GtkObject into an #ExecutiveSummaryHtmlView +</para> + +@obj: A #GtkObject + + +<!-- ##### MACRO EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED ##### --> +<para> +This is the event that is emitted on the BonoboEventSource when the HTML is changed. +</para> + + + +<!-- ##### FUNCTION executive_summary_html_view_new_full ##### --> +<para> + +</para> + +@event_source: +@Returns: + + +<!-- ##### FUNCTION executive_summary_html_view_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION executive_summary_html_view_set_html ##### --> +<para> + +</para> + +@view: +@html: + + +<!-- ##### FUNCTION executive_summary_html_view_get_html ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION executive_summary_html_view_get_event_source ##### --> +<para> + +</para> + +@view: +@Returns: + + |