blob: c826873ea5200d11f1877543a63ddbece298ebde [file] [log] [blame]
// Copyright (c) 2012 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.
#include <string>
#include "ash/ash_export.h"
#include "base/strings/string16.h"
#include "ui/gfx/canvas.h"
#include "ui/gfx/image/canvas_image_source.h"
#include "ui/gfx/image/image_skia.h"
namespace chromeos {
class NetworkState;
namespace ash {
namespace network_icon {
// Type of icon which dictates color theme and VPN badging
enum IconType {
ICON_TYPE_TRAY_OOBE, // dark icons with VPN badges, used during OOBE
ICON_TYPE_TRAY_REGULAR, // light icons with VPN badges, used outside of OOBE
ICON_TYPE_DEFAULT_VIEW, // dark icons with VPN badges
ICON_TYPE_LIST, // dark icons without VPN badges; in-line status
ICON_TYPE_MENU_LIST, // dark icons without VPN badges; separate status
// Strength of a wireless signal.
enum class SignalStrength { NONE, WEAK, MEDIUM, STRONG, NOT_WIRELESS };
// Gets the image for provided |network|. |network| must not be NULL.
// |icon_type| determines the color theme and whether or not to show the VPN
// badge. This caches badged icons per network per |icon_type|. |animating| is
// an optional out parameter that is set to true when the returned image can be
// animated.
ASH_EXPORT gfx::ImageSkia GetImageForNetwork(
const chromeos::NetworkState* network,
IconType icon_type,
bool* animating = nullptr);
// Gets an image for a Wi-Fi network, either full strength or strike-through
// based on |enabled|.
ASH_EXPORT gfx::ImageSkia GetImageForWiFiEnabledState(
bool enabled,
// Gets the conneting image for a shill network type.
gfx::ImageSkia GetConnectingImageForNetworkType(const std::string& network_type,
IconType icon_type);
// Gets the disconnected image for a shill network type.
gfx::ImageSkia GetDisconnectedImageForNetworkType(
const std::string& network_type);
// Gets the full strength image for a Wi-Fi network using |icon_color| for the
// main icon and |badge_color| for the badge.
ASH_EXPORT gfx::ImageSkia GetImageForNewWifiNetwork(SkColor icon_color,
SkColor badge_color);
// Returns the label for |network| based on |icon_type|. |network| cannot be
// nullptr.
ASH_EXPORT base::string16 GetLabelForNetwork(
const chromeos::NetworkState* network,
IconType icon_type);
// Updates and returns the appropriate message id if the cellular network
// is uninitialized.
ASH_EXPORT int GetCellularUninitializedMsg();
// Gets the correct icon and label for |icon_type|. Also sets |animating|
// based on whether or not the icon is animating (i.e. connecting).
ASH_EXPORT void GetDefaultNetworkImageAndLabel(IconType icon_type,
gfx::ImageSkia* image,
base::string16* label,
bool* animating);
// Called when the list of networks changes. Retreives the list of networks
// from the global NetworkStateHandler instance and removes cached entries
// that are no longer in the list.
ASH_EXPORT void PurgeNetworkIconCache();
// Called by ChromeVox to give a verbal indication of the network icon. Returns
// the signal strength of |network|, if it is a network type with a signal
// strength.
ASH_EXPORT SignalStrength
GetSignalStrengthForNetwork(const chromeos::NetworkState* network);
} // namespace network_icon
} // namespace ash