tooltip_manager.cc revision 5821806d5e7f356e8fa4b058a389a808ea183019
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 The Chromium Authors. All rights reserved.
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file.
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/widget/tooltip_manager.h"
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector>
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/string_split.h"
105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/utf_string_conversions.h"
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/base/text/text_elider.h"
125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace {
145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Maximum number of characters we allow in a tooltip.
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const size_t kMaxTooltipLength = 1024;
175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Maximum number of lines we allow in the tooltip.
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const size_t kMaxLines = 6;
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace
225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace views {
245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static
265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void TooltipManager::TrimTooltipToFit(string16* text,
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                      int* max_width,
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                      int* line_count,
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                      int x,
305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                      int y,
315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                      gfx::NativeView context) {
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *max_width = 0;
335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *line_count = 0;
345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Clamp the tooltip length to kMaxTooltipLength so that we don't
365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // accidentally DOS the user with a mega tooltip.
375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (text->length() > kMaxTooltipLength)
385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    *text = text->substr(0, kMaxTooltipLength);
395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Determine the available width for the tooltip.
415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  int available_width = GetMaxWidth(x, y, context);
425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Split the string into at most kMaxLines lines.
445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  std::vector<string16> lines;
455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  base::SplitString(*text, '\n', &lines);
465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (lines.size() > kMaxLines)
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    lines.resize(kMaxLines);
485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *line_count = static_cast<int>(lines.size());
495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Format each line to fit.
515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  gfx::Font font = GetDefaultFont();
525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  string16 result;
535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  for (std::vector<string16>::iterator i = lines.begin(); i != lines.end();
545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)       ++i) {
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    string16 elided_text =
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)        ui::ElideText(*i, font, available_width, ui::ELIDE_AT_END);
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    *max_width = std::max(*max_width, font.GetStringWidth(elided_text));
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    if (!result.empty())
595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      result.push_back('\n');
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    result.append(elided_text);
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  *text = result;
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace views
66