From f8918d44539c1df3a3eacc2afe1507aa8c0b5093 Mon Sep 17 00:00:00 2001 From: Iain Holmes Date: Fri, 2 Feb 2001 00:25:59 +0000 Subject: Wheeee pretty documentation svn path=/trunk/; revision=7938 --- help/devel/executive-summary/Makefile.am | 125 +++++ .../executive-summary/evolution-services-decl.txt | 599 +++++++++++++++++++++ .../evolution-services-sections.txt | 95 ++++ .../executive-summary/evolution-services.args | 0 .../executive-summary/evolution-services.hierarchy | 15 + .../executive-summary/evolution-services.signals | 0 .../executive-summary/evolution-services.types | 10 + .../devel/executive-summary/private-reference.sgml | 20 + help/devel/executive-summary/public-reference.sgml | 22 + .../tmpl/evolution-services-unused.sgml | 0 ...executive-summary-component-factory-client.sgml | 53 ++ .../tmpl/executive-summary-component-factory.sgml | 46 ++ .../tmpl/executive-summary-component.sgml | 37 ++ .../tmpl/executive-summary-html-view.sgml | 75 +++ 14 files changed, 1097 insertions(+) create mode 100644 help/devel/executive-summary/Makefile.am create mode 100644 help/devel/executive-summary/evolution-services-decl.txt create mode 100644 help/devel/executive-summary/evolution-services-sections.txt create mode 100644 help/devel/executive-summary/evolution-services.args create mode 100644 help/devel/executive-summary/evolution-services.hierarchy create mode 100644 help/devel/executive-summary/evolution-services.signals create mode 100644 help/devel/executive-summary/evolution-services.types create mode 100644 help/devel/executive-summary/private-reference.sgml create mode 100644 help/devel/executive-summary/public-reference.sgml create mode 100644 help/devel/executive-summary/tmpl/evolution-services-unused.sgml create mode 100644 help/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml create mode 100644 help/devel/executive-summary/tmpl/executive-summary-component-factory.sgml create mode 100644 help/devel/executive-summary/tmpl/executive-summary-component.sgml create mode 100644 help/devel/executive-summary/tmpl/executive-summary-html-view.sgml (limited to 'help/devel/executive-summary') diff --git a/help/devel/executive-summary/Makefile.am b/help/devel/executive-summary/Makefile.am new file mode 100644 index 0000000000..9aa53af4ec --- /dev/null +++ b/help/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/help/devel/executive-summary/evolution-services-decl.txt b/help/devel/executive-summary/evolution-services-decl.txt new file mode 100644 index 0000000000..df84080700 --- /dev/null +++ b/help/devel/executive-summary/evolution-services-decl.txt @@ -0,0 +1,599 @@ + +EXECUTIVE_SUMMARY_CLIENT_TYPE +#define EXECUTIVE_SUMMARY_CLIENT_TYPE (executive_summary_client_get_type ()) + + +EXECUTIVE_SUMMARY_CLIENT +#define EXECUTIVE_SUMMARY_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE, ExecutiveSummaryClient)) + + +EXECUTIVE_SUMMARY_CLIENT_CLASS +#define EXECUTIVE_SUMMARY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_CLIENT_TYPE, ExecutiveSummaryClientClass)) + + +IS_EXECUTIVE_SUMMARY_CLIENT +#define IS_EXECUTIVE_SUMMARY_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE)) + + +IS_EXECUTIVE_SUMMARY_CLIENT_CLASS +#define IS_EXECUTIVE_SUMMARY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_CLIENT_TYPE)) + + +ExecutiveSummaryClientPrivate + + +ExecutiveSummaryClient + + +ExecutiveSummaryClientClass + + +ExecutiveSummaryClient +struct ExecutiveSummaryClient { + BonoboObjectClient parent; + + ExecutiveSummaryClientPrivate *private; +}; + + +ExecutiveSummaryClientClass +struct ExecutiveSummaryClientClass { + BonoboObjectClientClass parent_class; +}; + + +executive_summary_client_get_type +GtkType +void + + +executive_summary_client_construct +void +ExecutiveSummaryClient *client,CORBA_Object object + + +executive_summary_client_set_title +void +ExecutiveSummaryClient *client,int id,const char *title + + +executive_summary_client_set_icon +void +ExecutiveSummaryClient *client,int id,const char *icon + + +executive_summary_client_flash +void +ExecutiveSummaryClient *client,int id + + +executive_summary_client_update +void +ExecutiveSummaryClient *client,int id,const char *html + + +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE (executive_summary_component_factory_client_get_type ()) + + +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE, ExecutiveSummaryComponentFactoryClient)) + + +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE, ExecutiveSummaryComponentFactoryClientClass)) + + +IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT +#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE)) + + +IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS +#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT_TYPE)) + + +ExecutiveSummaryComponentFactoryClientPrivate + + +ExecutiveSummaryComponentFactoryClient + + +ExecutiveSummaryComponentFactoryClientClass + + +ExecutiveSummaryComponentFactoryClient +struct ExecutiveSummaryComponentFactoryClient { + BonoboObjectClient parent; + + ExecutiveSummaryComponentFactoryClientPrivate *private; +}; + + +ExecutiveSummaryComponentFactoryClientClass +struct ExecutiveSummaryComponentFactoryClientClass { + BonoboObjectClientClass parent_class; +}; + + +executive_summary_component_factory_client_get_type +GtkType +void + + +executive_summary_component_factory_client_construct +void +ExecutiveSummaryComponentFactoryClient *client,CORBA_Object corba_object + + +executive_summary_component_factory_client_new +ExecutiveSummaryComponentFactoryClient * +const char *id + + +executive_summary_component_factory_client_create_view +CORBA_Object +ExecutiveSummaryComponentFactoryClient *client + + +EXECUTIVE_SUMMARY_COMPONENT_TYPE +#define EXECUTIVE_SUMMARY_COMPONENT_TYPE (executive_summary_component_get_type ()) + + +EXECUTIVE_SUMMARY_COMPONENT +#define EXECUTIVE_SUMMARY_COMPONENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE, ExecutiveSummaryComponent)) + + +EXECUTIVE_SUMMARY_COMPONENT_CLASS +#define EXECUTIVE_SUMMARY_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_TYPE, ExecutiveSummaryComponentClass)) + + +IS_EXECUTIVE_SUMMARY_COMPONENT +#define IS_EXECUTIVE_SUMMARY_COMPONENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE)) + + +IS_EXECUTIVE_SUMMARY_COMPONENT_CLASS +#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_TYPE)) + + +ExecutiveSummaryComponentPrivate + + +ExecutiveSummaryComponent + + +ExecutiveSummaryComponentClass + + +ExecutiveSummaryComponent +struct ExecutiveSummaryComponent { + BonoboObject parent; + + ExecutiveSummaryComponentPrivate *private; +}; + + +ExecutiveSummaryComponentClass +struct ExecutiveSummaryComponentClass { + BonoboObjectClass parent_class; +}; + + +executive_summary_component_get_type +GtkType +void + + +executive_summary_component_new +BonoboObject * +void + + +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE (executive_summary_component_factory_get_type ()) + + +EXECUTIVE_SUMMARY_COMPONENT_FACTORY +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE, ExecutiveSummaryComponentFactory)) + + +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS +#define EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE, ExecutiveSummaryComponentFactoryClass)) + + +IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY +#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE)) + + +IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS +#define IS_EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_FACTORY_TYPE)) + + +ExecutiveSummaryComponentFactoryPrivate + + +ExecutiveSummaryComponentFactory + + +ExecutiveSummaryComponentFactoryClass + + +EvolutionServicesCreateViewFn +BonoboObject * +ExecutiveSummaryComponentFactory *factory, + void *closure + + +ExecutiveSummaryComponentFactory +struct ExecutiveSummaryComponentFactory { + BonoboObject parent; + + ExecutiveSummaryComponentFactoryPrivate *private; +}; + + +ExecutiveSummaryComponentFactoryClass +struct ExecutiveSummaryComponentFactoryClass { + BonoboObjectClass parent_class; +}; + + +executive_summary_component_factory_get_type +GtkType +void + + +executive_summary_component_factory_new +BonoboObject * +EvolutionServicesCreateViewFn create_view,void *closure + + +EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED +#define EXECUTIVE_SUMMARY_HTML_VIEW_HTML_CHANGED "GNOME:Evolution:Summary:HTMLView:html_changed" + + +EXECUTIVE_SUMMARY_HTML_VIEW_TYPE +#define EXECUTIVE_SUMMARY_HTML_VIEW_TYPE (executive_summary_html_view_get_type ()) + + +EXECUTIVE_SUMMARY_HTML_VIEW +#define EXECUTIVE_SUMMARY_HTML_VIEW(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE, ExecutiveSummaryHtmlView)) + + +EXECUTIVE_SUMMARY_HTML_VIEW_CLASS +#define EXECUTIVE_SUMMARY_HTML_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE, ExecutiveSummaryHtmlViewClass)) + + +IS_EXECUTIVE_SUMMARY_HTML_VIEW +#define IS_EXECUTIVE_SUMMARY_HTML_VIEW(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE)) + + +IS_EXECUTIVE_SUMMARY_HTML_VIEW_CLASS +#define IS_EXECUTIVE_SUMMARY_HTML_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_HTML_VIEW_TYPE)) + + +ExecutiveSummaryHtmlViewPrivate + + +ExecutiveSummaryHtmlView + + +ExecutiveSummaryHtmlViewClass + + +ExecutiveSummaryHtmlView +struct ExecutiveSummaryHtmlView { + BonoboObject parent; + + ExecutiveSummaryHtmlViewPrivate *private; +}; + + +ExecutiveSummaryHtmlViewClass +struct ExecutiveSummaryHtmlViewClass { + BonoboObjectClass parent_class; +}; + + +executive_summary_html_view_get_type +GtkType +void + + +executive_summary_html_view_new_full +BonoboObject * +BonoboEventSource *event_source + + +executive_summary_html_view_new +BonoboObject * +void + + +executive_summary_html_view_set_html +void +ExecutiveSummaryHtmlView *view,const char *html + + +executive_summary_html_view_get_html +const char * +ExecutiveSummaryHtmlView *view + + +executive_summary_html_view_get_event_source +BonoboEventSource * +ExecutiveSummaryHtmlView *view + + +EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE +#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE (executive_summary_component_client_get_type ()) + + +EXECUTIVE_SUMMARY_COMPONENT_CLIENT +#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE, ExecutiveSummaryComponentClient)) + + +EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS +#define EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE, ExecutiveSummaryComponentClientClass)) + + +IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT +#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE)) + + +IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS +#define IS_EXECUTIVE_SUMMARY_COMPONENT_CLIENT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_CLIENT_TYPE)) + + +ExecutiveSummaryComponentClientPrivate + + +ExecutiveSummaryComponentClient + + +ExecutiveSummaryComponentClientClass + + +ExecutiveSummaryComponentClient +struct ExecutiveSummaryComponentClient { + BonoboObjectClient parent; + + ExecutiveSummaryComponentClientPrivate *private; +}; + + +ExecutiveSummaryComponentClientClass +struct ExecutiveSummaryComponentClientClass { + BonoboObjectClientClass parent_class; +}; + + +executive_summary_component_client_get_type +GtkType +void + + +executive_summary_component_client_new +ExecutiveSummaryComponentClient * +const char *id + + +executive_summary_component_client_set_owner +void +ExecutiveSummaryComponentClient *client,ExecutiveSummary *summary + + +executive_summary_component_client_unset_owner +void +ExecutiveSummaryComponentClient *client + + +executive_summary_component_client_supports +void +ExecutiveSummaryComponentClient *client,gboolean *bonobo,gboolean *html + + +executive_summary_component_client_configure +void +ExecutiveSummaryComponentClient *client,ExecutiveSummaryComponentView *view + + +executive_summary_component_client_destroy_view +void +ExecutiveSummaryComponentClient *client,ExecutiveSummaryComponentView *view + + +EXECUTIVE_SUMMARY_TYPE +#define EXECUTIVE_SUMMARY_TYPE (executive_summary_get_type ()) + + +EXECUTIVE_SUMMARY +#define EXECUTIVE_SUMMARY(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_TYPE, ExecutiveSummary)) + + +EXECUTIVE_SUMMARY_CLASS +#define EXECUTIVE_SUMMARY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_TYPE, ExecutiveSummaryClass)) + + +IS_EXECUTIVE_SUMMARY +#define IS_EXECUTIVE_SUMMARY(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_TYPE)) + + +IS_EXECUTIVE_SUMMARY_CLASS +#define IS_EXECUTIVE_SUMMARY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_TYPE)) + + +ExecutiveSummaryPrivate + + +ExecutiveSummary + + +ExecutiveSummaryClass + + +ExecutiveSummary +struct ExecutiveSummary { + BonoboObject parent; + + ExecutiveSummaryPrivate *private; +}; + + +ExecutiveSummaryClass +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); +}; + + +executive_summary_get_type +GtkType +void + + +executive_summary_construct +void +ExecutiveSummary *es,GNOME_Evolution_Summary_ViewFrame corba_object + + +executive_summary_new +BonoboObject * +void + + +EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE +#define EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE (executive_summary_component_view_get_type ()) + + +EXECUTIVE_SUMMARY_COMPONENT_VIEW +#define EXECUTIVE_SUMMARY_COMPONENT_VIEW(obj) (GTK_CHECK_CAST ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE, ExecutiveSummaryComponentView)) + + +EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS +#define EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE, ExecutiveSummaryComponentClass)) + + +IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW +#define IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW(obj) (GTK_CHECK_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_TYPE)) + + +IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS +#define IS_EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), EXECUTIVE_SUMMARY_COMPONENT_VIEW_CLASS_TYPE)) + + +ExecutiveSummaryComponentViewPrivate + + +ExecutiveSummaryComponentView + + +ExecutiveSummaryComponentViewClass + + +ExecutiveSummaryComponentView +struct ExecutiveSummaryComponentView { + GtkObject object; + + ExecutiveSummaryComponentViewPrivate *private; +}; + + +ExecutiveSummaryComponentViewClass +struct ExecutiveSummaryComponentViewClass { + GtkObjectClass parent_class; + + /* Signals */ + void (* configure) (ExecutiveSummaryComponentView *view); +}; + + +executive_summary_component_view_get_type +GtkType +void + + +executive_summary_component_view_construct +void +ExecutiveSummaryComponentView *view,ExecutiveSummaryComponent *component,BonoboControl *control,const char *html,const char *title,const char *icon + + +executive_summary_component_view_new +ExecutiveSummaryComponentView * +ExecutiveSummaryComponent *component,BonoboControl *control,const char *html,const char *title,const char *icon + + +executive_summary_component_view_set_title +void +ExecutiveSummaryComponentView *view,const char *title + + +executive_summary_component_view_get_title +const char * +ExecutiveSummaryComponentView *view + + +executive_summary_component_view_set_icon +void +ExecutiveSummaryComponentView *view,const char *icon + + +executive_summary_component_view_get_icon +const char * +ExecutiveSummaryComponentView *view + + +executive_summary_component_view_flash +void +ExecutiveSummaryComponentView *view + + +executive_summary_component_view_set_html +void +ExecutiveSummaryComponentView *view,const char *html + + +executive_summary_component_view_get_html +const char * +ExecutiveSummaryComponentView *view + + +executive_summary_component_view_get_control +BonoboObject * +ExecutiveSummaryComponentView *view + + +executive_summary_component_view_get_id +int +ExecutiveSummaryComponentView *view + + +executive_summary_component_view_set_id +void +ExecutiveSummaryComponentView *view,int id + + +executive_summary_component_view_configure +void +ExecutiveSummaryComponentView *view + + +executive_summary_component_view_set_objref +void +ExecutiveSummaryComponentView *view,Bonobo_Control objref + + +executive_summary_component_view_get_widget +GtkWidget * +ExecutiveSummaryComponentView *view + diff --git a/help/devel/executive-summary/evolution-services-sections.txt b/help/devel/executive-summary/evolution-services-sections.txt new file mode 100644 index 0000000000..8ba2b42317 --- /dev/null +++ b/help/devel/executive-summary/evolution-services-sections.txt @@ -0,0 +1,95 @@ +executive-summary-component.h +
+executive-summary-component +EXECUTIVE_SUMMARY_COMPONENT +ExecutiveSummaryComponent + +executive_summary_component_new + + +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 + + +ExecutiveSummaryComponent +ExecutiveSummaryComponentPrivate + +
+ +
+executive-summary-component-factory +EXECUTIVE_SUMMARY_COMPONENT_FACTORY +ExecutiveSummaryComponentFactory + +EvolutionServicesCreateViewFn + +executive_summary_component_factory_new + + +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 + + +ExecutiveSummaryComponentFactory +ExecutiveSummaryComponentFactoryPrivate + +
+ +executive-summary-component-factory-client.h +
+executive-summary-component-factory-client +EXECUTIVE_SUMMARY_COMPONENT_FACTORY_CLIENT +ExecutiveSummaryComponentFactoryClient + +executive_summary_component_factory_client_construct +executive_summary_component_factory_client_new +executive_summary_component_factory_client_create_view + + +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 + + +ExecutiveSummaryComponentFactoryClient +ExecutiveSummaryComponentFactoryClientPrivate + +
+ +executive-summary-html-view.h +
+executive-summary-html-view +EXECUTIVE_SUMMARY_HTML_VIEW +ExecutiveSummaryHtmlView + +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 + + +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 + + +ExecutiveSummaryHtmlView +ExecutiveSummaryHtmlViewPrivate +
diff --git a/help/devel/executive-summary/evolution-services.args b/help/devel/executive-summary/evolution-services.args new file mode 100644 index 0000000000..e69de29bb2 diff --git a/help/devel/executive-summary/evolution-services.hierarchy b/help/devel/executive-summary/evolution-services.hierarchy new file mode 100644 index 0000000000..07e7aad6ff --- /dev/null +++ b/help/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/help/devel/executive-summary/evolution-services.signals b/help/devel/executive-summary/evolution-services.signals new file mode 100644 index 0000000000..e69de29bb2 diff --git a/help/devel/executive-summary/evolution-services.types b/help/devel/executive-summary/evolution-services.types new file mode 100644 index 0000000000..b7ac05b89c --- /dev/null +++ b/help/devel/executive-summary/evolution-services.types @@ -0,0 +1,10 @@ +#include +#include +#include +#include +#include + +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/help/devel/executive-summary/private-reference.sgml b/help/devel/executive-summary/private-reference.sgml new file mode 100644 index 0000000000..e06d7c1690 --- /dev/null +++ b/help/devel/executive-summary/private-reference.sgml @@ -0,0 +1,20 @@ + + Evolution Services Private API Reference + + + + This part presents the class and function reference for the + private APIs of the different components of the &Evolution; + Executive Summary Services Framework. + + + + &ExecutiveSummaryComponentFactoryClient; + + + diff --git a/help/devel/executive-summary/public-reference.sgml b/help/devel/executive-summary/public-reference.sgml new file mode 100644 index 0000000000..7758a9a5c8 --- /dev/null +++ b/help/devel/executive-summary/public-reference.sgml @@ -0,0 +1,22 @@ + + Evolution Services Public API Reference + + + + This part presents the class and function reference for the + public APIs of the different components of the &Evolution; + Executive Summary Services Framework. + + + + &ExecutiveSummaryComponent; + &ExecutiveSummaryComponentFactory; + &ExecutiveSummaryHtmlView; + + + diff --git a/help/devel/executive-summary/tmpl/evolution-services-unused.sgml b/help/devel/executive-summary/tmpl/evolution-services-unused.sgml new file mode 100644 index 0000000000..e69de29bb2 diff --git a/help/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml b/help/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml new file mode 100644 index 0000000000..ee8ef25689 --- /dev/null +++ b/help/devel/executive-summary/tmpl/executive-summary-component-factory-client.sgml @@ -0,0 +1,53 @@ + +ExecutiveSummaryComponentFactoryClient + + +GtkObject client to simplfy use of GNOME_Evolution_Summary_ComponentFactory + + + +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. + + + + + + + + + +Casts a #GtkObject into an #ExecutiveSummaryComponentFactoryClient + + +@obj: + + + + + + + +@client: +@corba_object: + + + + + + + +@id: +@Returns: + + + + + + + +@client: +@Returns: + + diff --git a/help/devel/executive-summary/tmpl/executive-summary-component-factory.sgml b/help/devel/executive-summary/tmpl/executive-summary-component-factory.sgml new file mode 100644 index 0000000000..7069eea9d0 --- /dev/null +++ b/help/devel/executive-summary/tmpl/executive-summary-component-factory.sgml @@ -0,0 +1,46 @@ + +ExecutiveSummaryComponentFactory + + +GtkObject wrapper for GNOME/Evolution/Summary/ComponentFactory. + + + +An ExecutiveSummaryComponentFactory simplifies the creation of a +GNOME_Evolution_Summary_ComponentFactory object. It also allows error checking +and all the standard #GtkObject signals. + + + + + + + + + +Casts a #GtkObject to an #ExecutiveSummaryComponentFactory. + + +@obj: A #GtkObject. + + + + +The type of function that is called when the factory has to create a new view. + + +@factory: The #ExecutiveSummaryComponent that is creating the view. +@closure: The data that was passed into executive_summary_factory_new (). +@Returns: An #ExecutiveSummaryComponent. + + + + + + + +@create_view: +@closure: +@Returns: + + diff --git a/help/devel/executive-summary/tmpl/executive-summary-component.sgml b/help/devel/executive-summary/tmpl/executive-summary-component.sgml new file mode 100644 index 0000000000..04768b1b1c --- /dev/null +++ b/help/devel/executive-summary/tmpl/executive-summary-component.sgml @@ -0,0 +1,37 @@ + +ExecutiveSummaryComponent + + +The base #BonoboObject that implements GNOME/Evolution/Summary/Component. + + + +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. + + + + +#ExecutiveSummaryHtmlView, #BonoboControl, #BonoboEventSource, #BonoboPropertyBag, +#BonoboPropertyControl, #BonoboPersistStream. + + + + +Casts a #GtkObject to an #ExecutiveSummaryComponent. + + +@obj: A #GtkObject. + + + + + + + +@Returns: + + diff --git a/help/devel/executive-summary/tmpl/executive-summary-html-view.sgml b/help/devel/executive-summary/tmpl/executive-summary-html-view.sgml new file mode 100644 index 0000000000..2fb66a2035 --- /dev/null +++ b/help/devel/executive-summary/tmpl/executive-summary-html-view.sgml @@ -0,0 +1,75 @@ + +ExecutiveSummaryHtmlView + + +A Bonobo component used to implement HTML based services. + + + +When writing HTML services, this component is aggregated onto an #ExecutiveSummaryComponent, to allow the Executive Summary to be able to find the HTML. + + + + +#ExecutiveSummaryComponent, #BonoboEventSource + + + + + Casts a #GtkObject into an #ExecutiveSummaryHtmlView + + +@obj: A #GtkObject + + + + +This is the event that is emitted on the BonoboEventSource when the HTML is changed. + + + + + + + + + +@event_source: +@Returns: + + + + + + + +@Returns: + + + + + + + +@view: +@html: + + + + + + + +@view: +@Returns: + + + + + + + +@view: +@Returns: + + -- cgit v1.2.3