Added download error descriptions to tooltips for Mac & Linux.

chrome/browser/ui/gtk/download/download_item_gtk.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/ui/gtk/download/download_item_gtk.h"
 
 #include "base/basictypes.h"
 #include "base/callback.h"
 #include "base/debug/trace_event.h"
 #include "base/metrics/histogram.h"
@@ skipping 40 matching lines @@
 // wrapping.
 const int kDangerousTextWidth = 200;
 
 // Amount of space we allot to showing the filename. If the filename is too wide
 // it will be elided.
 const int kTextWidth = 140;
 
 // We only cap the size of the tooltip so we don't crash.
 const int kTooltipMaxWidth = 1000;
 
+// Used for wrapping the download error description, if necessary.
+const int kToolTipErrorMessageMaxHeight = kTooltipMaxWidth / 4;
+
 // The minimum width we will ever draw the download item. Used as a lower bound
 // during animation. This number comes from the width of the images used to
 // make the download item.
 const int kMinDownloadItemWidth = download_util::kSmallProgressIconSize;
 
 // New download item animation speed in milliseconds.
 const int kNewItemAnimationDurationMs = 800;
 
 // How long the 'download complete/interrupted' animation should last for.
 const int kCompleteAnimationDurationMs = 2500;
@@ skipping 257 matching lines @@
   switch (download->GetState()) {
     case DownloadItem::REMOVING:
       parent_shelf_->RemoveDownloadItem(this);  // This will delete us!
       return;
     case DownloadItem::CANCELLED:
       StopDownloadProgress();
       gtk_widget_queue_draw(progress_area_.get());
       break;
     case DownloadItem::INTERRUPTED:
       StopDownloadProgress();
+      UpdateTooltip();
 
       complete_animation_.Show();
       break;
     case DownloadItem::COMPLETE:
       // GetAutoOpened() may change after the download's initial transition to
       // COMPLETE, so we check it before the idemopotency shield below.
       if (download->GetAutoOpened()) {
         parent_shelf_->RemoveDownloadItem(this);  // This will delete us!
         return;
       }
@@ skipping 121 matching lines @@
                IconLoader::SMALL, &icon_consumer_,
                base::Bind(&DownloadItemGtk::OnLoadSmallIconComplete,
                           base::Unretained(this)));
   im->LoadIcon(icon_filepath_,
                IconLoader::LARGE, &icon_consumer_,
                base::Bind(&DownloadItemGtk::OnLoadLargeIconComplete,
                           base::Unretained(this)));
 }
 
 void DownloadItemGtk::UpdateTooltip() {
-  string16 elided_filename = ui::ElideFilename(
-      get_download()->GetFileNameToReportUser(),
-      gfx::Font(), kTooltipMaxWidth);
-  gtk_widget_set_tooltip_text(body_.get(),
-                              UTF16ToUTF8(elided_filename).c_str());
+  string16 tooltip_text = ui::ElideFilename(
+      get_download()->GetFileNameToReportUser(), gfx::Font(), kTooltipMaxWidth);

[asanka, 2012/04/04 17:27:04]

Can we move the tooltip generation logic into the model?

[ahendrickson, 2012/04/04 17:49:32]

The logic is different on Windows vs Posix.

+
+  if (get_download()->GetState() == content::DownloadItem::INTERRUPTED) {
+    content::DownloadInterruptReason reason = get_download()->GetLastReason();
+    DCHECK(reason != 0);
+
+      // Split up the error description string as necessary.
+    std::vector<string16> elidedMessages;
+    ui::ElideRectangleText(
+        DownloadItemModel::InterruptReasonMessage(reason),
+        gfx::Font(),
+        kTooltipMaxWidth,
+        kToolTipErrorMessageMaxHeight,
+        ui::IGNORE_LONG_WORDS,
+        &elidedMessages);

[Nico, 2012/04/04 17:50:06]

Hm, maybe that should be on the downloads page instead?

From
http://developer.apple.com/library/mac/#documentation/UserExperience/Conceptu...
:

"""
The text of a help tag should briefly describe what an interface element does.
If you find that you need more than a few words to describe the function of a
control, you might want to reconsider the design of your application’s user
interface.

You can define help tags in Interface Builder, where they are called tooltips.
Here are some guidelines to help you create effective help tag messages.

In general, don’t name the interface element in the tag. Because a help tag is
specific to a UI element, it should not be necessary to refer to by name, unless
the name helps the user and isn’t available onscreen. If you do need to refer to
an element by name, make sure you use the same name throughout all of your
documentation.

Describe only the element that the pointer is resting on. Users expect a help
tag to describe what they can do with the control; they do not expect to read
about other controls or about how to perform a larger task.

Describe controls that are unique to your application. Don’t provide help tags
that describe window resize controls, scrollers, or other standard Aqua
controls.

Focus on the action users can perform using the control. A good way to stay
focused on the action is to begin the tag with a verb, for example, “Restores
default settings” or “Add or remove a language from the list”.

Use the fewest words possible. Try to keep your tags to a maximum of 60 to 75
characters. Because help tags are always on, it is important to keep your tag
text unobtrusive—that is, short—and useful. A tag should present only one
concept and that concept should be directly related to the interface element.
You can also omit articles to limit the length of the tag. Note that
localization can lengthen the text by 20 to 30 percent, which is another good
reason to keep the tag short.
"""

[asanka, 2012/04/05 19:08:34]

This has changed in the latest patch set. Part of the problem was that the
status message was too large to be contained within the confines of the download
item. So an interrupted download might show up on the download shelf as:

  | [ icon ] possibly long f...exe
  |          Insufficient disk sp...

And with this CL, the tooltip looks like:

  | possibly long filename.exe
  | Insufficient disk space

While not consistent with the guidelines for a help tag on Mac, wouldn't this
use still be consistent with the use of tooltips to disclose otherwise truncated
text?

+
+    string16 new_line = ASCIIToUTF16("\n");
+    tooltip_text += new_line;
+
+    for (size_t i = 0; i < elidedMessages.size(); ++i) {
+      tooltip_text += elidedMessages[i];
+      tooltip_text += new_line;
+    }
+
+    tooltip_text += download_model_->GetProgressText();
+  }
+
+  gtk_widget_set_tooltip_text(body_.get(), UTF16ToUTF8(tooltip_text).c_str());
 }
 
 void DownloadItemGtk::UpdateNameLabel() {
   // TODO(estade): This is at best an educated guess, since we don't actually
   // use gfx::Font() to draw the text. This is why we need to add so
   // much padding when we set the size request. We need to either use gfx::Font
   // or somehow extend TextElider.
   gfx::Font font = gfx::Font();
   string16 filename;
   if (!disabled_while_opening_) {
@@ skipping 424 matching lines @@
   get_download()->DangerousDownloadValidated();
 }
 
 void DownloadItemGtk::OnDangerousDecline(GtkWidget* button) {
   UMA_HISTOGRAM_LONG_TIMES("clickjacking.discard_download",
                            base::Time::Now() - creation_time_);
   if (get_download()->IsPartialDownload())
     get_download()->Cancel(true);
   get_download()->Delete(DownloadItem::DELETE_DUE_TO_USER_DISCARD);
 }