chrome/common/extensions/api/launcher_page.idl

   1 // Copyright 2014 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 // The <code>chrome.launcherPage</code> API provides launcher pages in the
   6 // Chrome Launcher with the capabilities and events they need.
   7 namespace launcherPage {
   8   callback PushSubpageCallback = void();
   9   callback ShowCallback = void();
  10   callback HideCallback = void();
  11   callback SetEnabledCallback = void();
  12
  13   interface Functions {
  14     // Pushes a subpage state onto a state stack for the launcher page. This
  15     // state will be popped when the launcher's back button is pressed,
  16     // preventing the launcher from hiding the launcher page and sending an
  17     // onPopSubpage event to the launcher page. Once all states are popped, the
  18     // next press of the back button will cause the launcher to be hidden.
  19     //
  20     // Note: All subpages are immediately popped when the launcher is closed or
  21     // the launcher page is otherwise hidden.
  22     static void pushSubpage(optional PushSubpageCallback callback);
  23
  24     // Opens the launcher if it isn't currently open and shows the launcher
  25     // page.
  26     static void show(optional ShowCallback callback);
  27
  28     // Returns the launcher to the start page if the launcher page is showing.
  29     static void hide(optional HideCallback callback);
  30
  31     // Sets whether the launcher page is enabled in the launcher. If disabled,
  32     // the launcher page will not be shown when the area at the bottom of the
  33     // launcher is pressed.
  34     //
  35     // Note: The launcher page will still be displayed at the bottom of the
  36     // launcher's start page and launcherPage.show() will still show the
  37     // launcher page.
  38     static void setEnabled(boolean enabled,
  39                            optional SetEnabledCallback callback);
  40   };
  41
  42   interface Events {
  43     // Fired when the launcher page is transitioning between hidden and shown.
  44     // It's possible for this to be called with a pushed subpage so this
  45     // event handler should account for transitioning from any subpage to a
  46     // collapsed view.
  47     static void onTransitionChanged(double progress);
  48
  49     // Fired when the launcher's back button is pressed if there are remaining
  50     // subpages on the state stack pushed by pushSubpage().
  51     static void onPopSubpage();
  52   };
  53 };