src/chrome/browser/ui/tabs/tab_utils.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_UI_TABS_TAB_UTILS_H_
   6 #define CHROME_BROWSER_UI_TABS_TAB_UTILS_H_
   7
   8 #include "base/memory/scoped_ptr.h"
   9 #include "base/strings/string16.h"
  10
  11 namespace content {
  12 class WebContents;
  13 }  // namespace content
  14
  15 namespace gfx {
  16 class Animation;
  17 class Image;
  18 }  // namespace gfx
  19
  20 // Media state for a tab.  In reality, more than one of these may apply.  See
  21 // comments for GetTabMediaStateForContents() below.
  22 enum TabMediaState {
  23   TAB_MEDIA_STATE_NONE,
  24   TAB_MEDIA_STATE_RECORDING,  // Audio/Video being recorded, consumed by tab.
  25   TAB_MEDIA_STATE_CAPTURING,  // Tab contents being captured.
  26   TAB_MEDIA_STATE_AUDIO_PLAYING  // Audible audio is playing from the tab.
  27 };
  28
  29 namespace chrome {
  30
  31 // Logic to determine which components (i.e., close button, favicon, and media
  32 // indicator) of a tab should be shown, given current state.  |capacity|
  33 // specifies how many components can be shown, given available tab width.
  34 //
  35 // Precedence rules for deciding what to show when capacity is insufficient to
  36 // show everything:
  37 //
  38 //   Active tab: Always show the close button, then the media indicator, then
  39 //               the favicon.
  40 //   Inactive tab: Media indicator, then the favicon, then the close button.
  41 //   Pinned tab: Show only the media indicator, or only the favicon
  42 //               (TAB_MEDIA_STATE_NONE).  Never show the close button.
  43 bool ShouldTabShowFavicon(int capacity,
  44                           bool is_pinned_tab,
  45                           bool is_active_tab,
  46                           bool has_favicon,
  47                           TabMediaState media_state);
  48 bool ShouldTabShowMediaIndicator(int capacity,
  49                                  bool is_pinned_tab,
  50                                  bool is_active_tab,
  51                                  bool has_favicon,
  52                                  TabMediaState media_state);
  53 bool ShouldTabShowCloseButton(int capacity,
  54                               bool is_pinned_tab,
  55                               bool is_active_tab);
  56
  57 // Returns whether the given |contents| is playing audio. We might choose to
  58 // show an audio favicon indicator for this tab.
  59 bool IsPlayingAudio(content::WebContents* contents);
  60
  61 // Returns the media state to be shown by the tab's media indicator.  When
  62 // multiple states apply (e.g., tab capture with audio playback), the one most
  63 // relevant to user privacy concerns is selected.
  64 TabMediaState GetTabMediaStateForContents(content::WebContents* contents);
  65
  66 // Returns a cached image, to be shown by the media indicator for the given
  67 // |media_state|.  Uses the global ui::ResourceBundle shared instance.
  68 const gfx::Image& GetTabMediaIndicatorImage(TabMediaState media_state);
  69
  70 // Returns a non-continuous Animation that performs a fade-in or fade-out
  71 // appropriate for the given |next_media_state|.  This is used by the tab media
  72 // indicator to alert the user that recording, tab capture, or audio playback
  73 // has started/stopped.
  74 scoped_ptr<gfx::Animation> CreateTabMediaIndicatorFadeAnimation(
  75     TabMediaState next_media_state);
  76
  77 // Returns the text to show in a tab's tooltip: The contents |title|, followed
  78 // by a break, followed by a localized string describing the |media_state|.
  79 base::string16 AssembleTabTooltipText(const base::string16& title,
  80                                       TabMediaState media_state);
  81
  82 }  // namespace chrome
  83
  84 #endif  // CHROME_BROWSER_UI_TABS_TAB_UTILS_H_