diff options
author | Iain Holmes <iain@src.gnome.org> | 2001-02-02 08:25:59 +0800 |
---|---|---|
committer | Iain Holmes <iain@src.gnome.org> | 2001-02-02 08:25:59 +0800 |
commit | f8918d44539c1df3a3eacc2afe1507aa8c0b5093 (patch) | |
tree | 463212e0c6d0969f415e3eeb7d7e1a7040238456 /help/devel/executive-summary/tmpl | |
parent | c7a98d8e4a70ee70fc40e12365f7ff789a9d732a (diff) | |
download | gsoc2013-evolution-f8918d44539c1df3a3eacc2afe1507aa8c0b5093.tar gsoc2013-evolution-f8918d44539c1df3a3eacc2afe1507aa8c0b5093.tar.gz gsoc2013-evolution-f8918d44539c1df3a3eacc2afe1507aa8c0b5093.tar.bz2 gsoc2013-evolution-f8918d44539c1df3a3eacc2afe1507aa8c0b5093.tar.lz gsoc2013-evolution-f8918d44539c1df3a3eacc2afe1507aa8c0b5093.tar.xz gsoc2013-evolution-f8918d44539c1df3a3eacc2afe1507aa8c0b5093.tar.zst gsoc2013-evolution-f8918d44539c1df3a3eacc2afe1507aa8c0b5093.zip |
Wheeee pretty documentation
svn path=/trunk/; revision=7938
Diffstat (limited to 'help/devel/executive-summary/tmpl')
5 files changed, 211 insertions, 0 deletions
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 --- /dev/null +++ b/help/devel/executive-summary/tmpl/evolution-services-unused.sgml 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 @@ +<!-- ##### 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/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 @@ +<!-- ##### 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/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 @@ +<!-- ##### 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/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 @@ +<!-- ##### 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: + + |