Files
evolution/doc/reference/shell/tmpl/e-activity.sgml
Matthew Barnes a98c07a569 Add a GCancellable to EActivity.
EActivity now uses a GCancellable to manage cancellations, instead of
having its own redundant cancellation API.  API changes are as follows:

  + e_activity_get_cancellable()
  + e_activity_set_cancellable()

  - e_activity_cancel()
  - e_activity_is_cancelled()
  - e_activity_get_allow_cancel()
  - e_activity_set_allow_cancel()

EActivity's "cancelled" signal remains, but only as a repeater for
GCancellable::cancelled signals.  It should not be emitted directly.

The presence of a GCancellable implies that cancellation is allowed.
EActivity does not create its own default GCancellable, it has to be
given one.

If a CamelOperation (cast as a GCancellable) is given, EActivity will
configure itself to listen for status updates from the CamelOperation
and propagate the information to its own "primary-text" and "percent"
properties.

These changes allowed me to start cleaning up some of the incredibly
convoluted logic in mail-mt.c -- in particular, mail_operation_status()
is completely gone now.  mail-mt.c is still in a transitional state --
much more significant changes coming soon.
2010-09-18 16:40:19 -04:00

190 lines
2.0 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
e-activity
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT EActivity ##### -->
<para>
</para>
<!-- ##### FUNCTION e_activity_new ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION e_activity_newv ##### -->
<para>
</para>
@format:
@Varargs:
@Returns:
<!-- ##### FUNCTION e_activity_complete ##### -->
<para>
</para>
@activity:
<!-- ##### FUNCTION e_activity_clicked ##### -->
<para>
</para>
@activity:
<!-- ##### FUNCTION e_activity_describe ##### -->
<para>
</para>
@activity:
@Returns:
<!-- ##### FUNCTION e_activity_is_completed ##### -->
<para>
</para>
@activity:
@Returns:
<!-- ##### FUNCTION e_activity_get_cancellable ##### -->
<para>
</para>
@activity:
@Returns:
<!-- ##### FUNCTION e_activity_set_cancellable ##### -->
<para>
</para>
@activity:
@cancellable:
<!-- ##### FUNCTION e_activity_get_clickable ##### -->
<para>
</para>
@activity:
@Returns:
<!-- ##### FUNCTION e_activity_set_clickable ##### -->
<para>
</para>
@activity:
@clickable:
<!-- ##### FUNCTION e_activity_get_icon_name ##### -->
<para>
</para>
@activity:
@Returns:
<!-- ##### FUNCTION e_activity_set_icon_name ##### -->
<para>
</para>
@activity:
@icon_name:
<!-- ##### FUNCTION e_activity_get_percent ##### -->
<para>
</para>
@activity:
@Returns:
<!-- ##### FUNCTION e_activity_set_percent ##### -->
<para>
</para>
@activity:
@percent:
<!-- ##### FUNCTION e_activity_get_primary_text ##### -->
<para>
</para>
@activity:
@Returns:
<!-- ##### FUNCTION e_activity_set_primary_text ##### -->
<para>
</para>
@activity:
@primary_text:
<!-- ##### FUNCTION e_activity_get_secondary_text ##### -->
<para>
</para>
@activity:
@Returns:
<!-- ##### FUNCTION e_activity_set_secondary_text ##### -->
<para>
</para>
@activity:
@secondary_text: