blob: 2936caee635d50fa0982f4b8675baf670b4ef0e9 [file] [log] [blame]
// Copyright 2016 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 ASH_COMMON_SYSTEM_TRAY_TRAY_POPUP_UTILS_H_
#define ASH_COMMON_SYSTEM_TRAY_TRAY_POPUP_UTILS_H_
#include "ash/common/login_status.h"
#include "ash/common/system/tray/tri_view.h"
#include "base/strings/string16.h"
namespace views {
class Border;
class ButtonListener;
class ImageView;
class Label;
class LabelButton;
class LayoutManager;
class Separator;
class Slider;
class SliderListener;
} // namespace views
namespace ash {
// Factory/utility functions used by the system menu.
class TrayPopupUtils {
public:
// Creates a default container view to be used by system menu rows that are
// either a single targetable area or not targetable at all. The caller takes
// over ownership of the created view.
//
// The returned view consists of 3 regions: START, CENTER, and END. Any child
// Views added to the START and END containers will be added horizontally and
// any Views added to the CENTER container will be added vertically.
//
// The START and END containers have a fixed minimum width but can grow into
// the CENTER container if space is required and available.
//
// The CENTER container has a flexible width.
static TriView* CreateDefaultRowView();
// Creates a container view to be used by system menu rows that want to embed
// a targetable area within one (or more) of the containers OR by any row
// that requires a non-default layout within the container views. The returned
// view will have the following configurations:
// - default minimum row height
// - default minimum width for the START and END containers
// - default left and right insets
// - default container flex values
// - Each container view will have a FillLayout installed on it
//
// The caller takes over ownership of the created view.
//
// The START and END containers have a fixed minimum width but can grow into
// the CENTER container if space is required and available. The CENTER
// container has a flexible width.
//
// Clients can use ConfigureContainer() to configure their own container views
// before adding them to the returned TriView.
static TriView* CreateMultiTargetRowView();
// Returns a label that has been configured for system menu layout. This
// should be used by all rows that require a label, i.e. both default and
// detailed rows should use this.
//
// TODO(bruthig): Update all system menu rows to use this.
static views::Label* CreateDefaultLabel();
// Returns an image view to be used in the main image region of a system menu
// row. This should be used by all rows that have a main image, i.e. both
// default and detailed rows should use this.
//
// TODO(bruthig): Update all system menu rows to use this.
static views::ImageView* CreateMainImageView();
// Returns an image view to be used in the 'more' region of default rows. This
// is used for all 'more' images as well as other images that appear in this
// region, e.g. audio output icon.
//
// TODO(bruthig): Update all default rows to use this.
static views::ImageView* CreateMoreImageView();
// Returns a slider configured for proper layout within a TriView container
// with a FillLayout.
static views::Slider* CreateSlider(views::SliderListener* listener);
// Sets up |view| to be a sticky header in a tray detail scroll view.
static void ConfigureAsStickyHeader(views::View* view);
// Configures |container_view| just like CreateDefaultRowView() would
// configure |container| on its returned TriView. To be used when mutliple
// targetable areas are required within a single row.
static void ConfigureContainer(TriView::Container container,
views::View* container_view);
// Creates a button for use in the system menu that only has a visible border
// when being hovered/clicked. Caller assumes ownership.
static views::LabelButton* CreateTrayPopupBorderlessButton(
views::ButtonListener* listener,
const base::string16& text);
// Creates a button for use in the system menu. For MD, this is a prominent
// text
// button. For non-MD, this does the same thing as the above. Caller assumes
// ownership.
static views::LabelButton* CreateTrayPopupButton(
views::ButtonListener* listener,
const base::string16& text);
// Creates and returns a vertical separator to be used between two items in a
// material design system menu row. The caller assumes ownership of the
// returned separator.
static views::Separator* CreateVerticalSeparator();
// Returns true if it is possible to open WebUI settings in a browser window,
// i.e., the user is logged in, not on the lock screen, and not in a secondary
// account flow.
static bool CanOpenWebUISettings(LoginStatus status);
private:
DISALLOW_IMPLICIT_CONSTRUCTORS(TrayPopupUtils);
};
} // namespace ash
#endif // ASH_COMMON_SYSTEM_TRAY_TRAY_POPUP_UTILS_H_