From c881b5bc5e61d04b18d4ab46ad70533e7340d15b Mon Sep 17 00:00:00 2001
From: Matthew Barnes <mbarnes@redhat.com>
Date: Thu, 21 Oct 2010 16:21:19 -0400
Subject: Simplify EActivity.

With unintrusive error dialogs gone, we can cut some unnecessary bits
out of EActivity.

I'm also adding a new enum property called "state", which is one of:

    E_ACTIVITY_RUNNING
    E_ACTIVITY_WAITING
    E_ACTIVITY_CANCELLED
    E_ACTIVITY_COMPLETED

The state of an activity must be explicitly changed.  In particular,
when the user cancels an activity the state should be set only after
confirming the operation has been cancelled and not when cancellation
is requested (e.g. after receiving a G_IO_ERROR_CANCELLED, not when
the GCancellable emits "cancelled").  EActivityBar and EActivityProxy
widgets have been updated to make this distinction clearer in the UI.

E_ACTIVITY_WAITING will be used when activities have to be queued and
dispatched in sequence, which I haven't written yet.
---
 doc/reference/shell/eshell-sections.txt     |  9 +---
 doc/reference/shell/tmpl/e-activity.sgml    | 67 ++-------------------------
 doc/reference/shell/tmpl/eshell-unused.sgml | 70 +++++++++++++++++++++++++++++
 3 files changed, 75 insertions(+), 71 deletions(-)

(limited to 'doc/reference')

diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt
index 07ee9b495d..63a8578145 100644
--- a/doc/reference/shell/eshell-sections.txt
+++ b/doc/reference/shell/eshell-sections.txt
@@ -471,21 +471,16 @@ EActivity
 e_activity_new
 e_activity_newv
 e_activity_complete
-e_activity_clicked
 e_activity_describe
 e_activity_is_completed
 e_activity_get_cancellable
 e_activity_set_cancellable
-e_activity_get_clickable
-e_activity_set_clickable
 e_activity_get_icon_name
 e_activity_set_icon_name
 e_activity_get_percent
 e_activity_set_percent
-e_activity_get_primary_text
-e_activity_set_primary_text
-e_activity_get_secondary_text
-e_activity_set_secondary_text
+e_activity_get_text
+e_activity_set_text
 <SUBSECTION Standard>
 E_ACTIVITY
 E_IS_ACTIVITY
diff --git a/doc/reference/shell/tmpl/e-activity.sgml b/doc/reference/shell/tmpl/e-activity.sgml
index 871758fb5e..1d4d1b3f3c 100644
--- a/doc/reference/shell/tmpl/e-activity.sgml
+++ b/doc/reference/shell/tmpl/e-activity.sgml
@@ -45,22 +45,6 @@ e-activity
 @Returns: 
 
 
-<!-- ##### FUNCTION e_activity_complete ##### -->
-<para>
-
-</para>
-
-@activity: 
-
-
-<!-- ##### FUNCTION e_activity_clicked ##### -->
-<para>
-
-</para>
-
-@activity: 
-
-
 <!-- ##### FUNCTION e_activity_describe ##### -->
 <para>
 
@@ -70,15 +54,6 @@ e-activity
 @Returns: 
 
 
-<!-- ##### FUNCTION e_activity_is_completed ##### -->
-<para>
-
-</para>
-
-@activity: 
-@Returns: 
-
-
 <!-- ##### FUNCTION e_activity_get_cancellable ##### -->
 <para>
 
@@ -97,24 +72,6 @@ e-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>
 
@@ -151,25 +108,7 @@ e-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 ##### -->
+<!-- ##### FUNCTION e_activity_get_text ##### -->
 <para>
 
 </para>
@@ -178,12 +117,12 @@ e-activity
 @Returns: 
 
 
-<!-- ##### FUNCTION e_activity_set_secondary_text ##### -->
+<!-- ##### FUNCTION e_activity_set_text ##### -->
 <para>
 
 </para>
 
 @activity: 
-@secondary_text: 
+@text: 
 
 
diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml
index e60ce1256a..4c9b60d43d 100644
--- a/doc/reference/shell/tmpl/eshell-unused.sgml
+++ b/doc/reference/shell/tmpl/eshell-unused.sgml
@@ -245,6 +245,20 @@ e-shell-window.sgml
 
 @activity: 
 
+<!-- ##### FUNCTION e_activity_clicked ##### -->
+<para>
+
+</para>
+
+@activity: 
+
+<!-- ##### FUNCTION e_activity_complete ##### -->
+<para>
+
+</para>
+
+@activity: 
+
 <!-- ##### FUNCTION e_activity_get_allow_cancel ##### -->
 <para>
 
@@ -253,6 +267,30 @@ e-shell-window.sgml
 @activity: 
 @Returns: 
 
+<!-- ##### FUNCTION e_activity_get_clickable ##### -->
+<para>
+
+</para>
+
+@activity: 
+@Returns: 
+
+<!-- ##### FUNCTION e_activity_get_primary_text ##### -->
+<para>
+
+</para>
+
+@activity: 
+@Returns: 
+
+<!-- ##### FUNCTION e_activity_get_secondary_text ##### -->
+<para>
+
+</para>
+
+@activity: 
+@Returns: 
+
 <!-- ##### FUNCTION e_activity_is_cancelled ##### -->
 <para>
 
@@ -261,6 +299,14 @@ e-shell-window.sgml
 @activity: 
 @Returns: 
 
+<!-- ##### FUNCTION e_activity_is_completed ##### -->
+<para>
+
+</para>
+
+@activity: 
+@Returns: 
+
 <!-- ##### FUNCTION e_activity_set_allow_cancel ##### -->
 <para>
 
@@ -269,6 +315,30 @@ e-shell-window.sgml
 @activity: 
 @allow_cancel: 
 
+<!-- ##### FUNCTION e_activity_set_clickable ##### -->
+<para>
+
+</para>
+
+@activity: 
+@clickable: 
+
+<!-- ##### FUNCTION e_activity_set_primary_text ##### -->
+<para>
+
+</para>
+
+@activity: 
+@primary_text: 
+
+<!-- ##### FUNCTION e_activity_set_secondary_text ##### -->
+<para>
+
+</para>
+
+@activity: 
+@secondary_text: 
+
 <!-- ##### FUNCTION e_alert_dialog_count_buttons ##### -->
 <para>
 
-- 
cgit v1.2.3