Show media router toolbar icon ephemerally for active local routes and issues

chrome/browser/ui/toolbar/media_router_action.h

 // Copyright 2015 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.
 
 #ifndef CHROME_BROWSER_UI_TOOLBAR_MEDIA_ROUTER_ACTION_H_
 #define CHROME_BROWSER_UI_TOOLBAR_MEDIA_ROUTER_ACTION_H_
 
+#include <memory>
+#include <string>
+
 #include "base/macros.h"
 #include "base/scoped_observer.h"
 #include "chrome/browser/media/router/issues_observer.h"
 #include "chrome/browser/media/router/media_routes_observer.h"
 #include "chrome/browser/ui/tabs/tab_strip_model_observer.h"
 #include "chrome/browser/ui/toolbar/media_router_contextual_menu.h"
 #include "chrome/browser/ui/toolbar/toolbar_action_view_controller.h"
 #include "chrome/browser/ui/toolbar/toolbar_actions_bar.h"
+#include "chrome/browser/ui/toolbar/toolbar_actions_bar_observer.h"
 #include "ui/gfx/vector_icons_public.h"
 
 class Browser;
 class MediaRouterActionPlatformDelegate;
 class TabStripModel;
 
 namespace media_router {
 class MediaRouterDialogControllerImpl;
 }  // namespace media_router
 
 // The class for the Media Router component action that will be shown in
 // the toolbar.
 class MediaRouterAction : public ToolbarActionViewController,
                           public media_router::IssuesObserver,
                           public media_router::MediaRoutesObserver,
-                          public TabStripModelObserver {
+                          public TabStripModelObserver,
+                          public ToolbarActionsBarObserver {
  public:
   MediaRouterAction(Browser* browser, ToolbarActionsBar* toolbar_actions_bar);
   ~MediaRouterAction() override;
 
   // ToolbarActionViewController implementation.
   std::string GetId() const override;
   void SetDelegate(ToolbarActionViewDelegate* delegate) override;
   gfx::Image GetIcon(content::WebContents* web_contents,
                      const gfx::Size& size) override;
   base::string16 GetActionName() const override;
@@ skipping 18 matching lines @@
   void OnRoutesUpdated(const std::vector<media_router::MediaRoute>& routes,
                        const std::vector<media_router::MediaRoute::Id>&
                            joinable_route_ids) override;
 
   // ToolbarStripModelObserver:
   void ActiveTabChanged(content::WebContents* old_contents,
                         content::WebContents* new_contents,
                         int index,
                         int reason) override;
 
-  void OnPopupHidden();
-  void OnPopupShown();
+  // ToolbarActionsBarObserver:
+  void OnToolbarActionsBarAnimationEnded() override;
+
+  void OnDialogHidden();
+  void OnDialogShown();
+
+  // Gets or sets the "Always show icon" option.
+  bool GetAlwaysShowActionPref() const;
+  void SetAlwaysShowActionPref(bool always_show);

[Devlin, 2016/09/15 21:19:17]

Is this used?

[takumif, 2016/09/16 21:19:22]

Yes, by the ContextualMenu.

+
+ protected:
+  // For accessing from tests.
+  base::WeakPtr<MediaRouterAction> GetWeakPtr();
 
  private:
-  // Called when a new browser window is opened, the user switches tabs in the
-  // browser window, or when |delegate_| is swapped out to be non-null and has
-  // a valid WebContents.
+  // Registers |this| with the MediaRouterDialogControllerImpl associated with
+  // |delegate_|'s current WebContents if |this| is not shown in overflow mode.
+  void RegisterWithDialogController();
+
+  // Called when a new browser window is opened or when |delegate_| is swapped
+  // out to be non-null and has a valid WebContents.
   // This updates the pressed/unpressed state of the icon, which is different
   // on a per-tab basis.
-  void UpdatePopupState();
+  void UpdateDialogState();
 
   // Returns a reference to the MediaRouterDialogControllerImpl associated with
   // |delegate_|'s current WebContents. Guaranteed to be non-null.
   // |delegate_| and its current WebContents must not be null.
   // Marked virtual for tests.
   virtual media_router::MediaRouterDialogControllerImpl*
       GetMediaRouterDialogController();
 
   // Overridden by tests.
   virtual MediaRouterActionPlatformDelegate* GetPlatformDelegate();
 
   // Checks if the current icon of MediaRouterAction has changed. If so,
   // updates |current_icon_|.
   void MaybeUpdateIcon();
 
   gfx::VectorIconId GetCurrentIcon() const;
 
   // The current icon to show. This is updated based on the current issues and
   // routes since |this| is an IssueObserver and MediaRoutesObserver.
   gfx::VectorIconId current_icon_;
 
   // The current issue shown in the Media Router WebUI. Can be null. It is set
   // in OnIssueUpdated(), which is called by the IssueManager.
   std::unique_ptr<media_router::Issue> issue_;
 
   // Whether a local displayable active route exists.
   bool has_local_display_route_;
 
+  // Whether the Media Router dialog is shown in the current tab.
+  // This should only be updated in OnDialogShown() and OnDialogHidden().
+  bool has_dialog_;
+
   ToolbarActionViewDelegate* delegate_;
 
   Browser* const browser_;
   ToolbarActionsBar* const toolbar_actions_bar_;
 
   // The delegate to handle platform-specific implementations.
   std::unique_ptr<MediaRouterActionPlatformDelegate> platform_delegate_;
 
   MediaRouterContextualMenu contextual_menu_;
 
   ScopedObserver<TabStripModel, TabStripModelObserver>
       tab_strip_model_observer_;
+  ScopedObserver<ToolbarActionsBar, ToolbarActionsBarObserver>
+      toolbar_actions_bar_observer_;
 
   base::WeakPtrFactory<MediaRouterAction> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(MediaRouterAction);
 };
 
 #endif  // CHROME_BROWSER_UI_TOOLBAR_MEDIA_ROUTER_ACTION_H_