blob: 7b451f32206b6743f3bb652bb6948804d1c9cfbe [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 "build/build_config.h"
#include "third_party/skia/include/core/SkColor.h"
#include "ui/base/layout.h"
#include "ui/base/ui_base_export.h"
#if defined(OS_MACOSX)
#ifdef __OBJC__
@class NSColor;
@class NSGradient;
@class NSImage;
class NSColor;
class NSGradient;
class NSImage;
#endif // __OBJC__
#endif // OS_*
namespace base {
class RefCountedMemory;
namespace color_utils {
struct HSL;
namespace gfx {
class ImageSkia;
namespace ui {
// ThemeProvider
// ThemeProvider is an abstract class that defines the API that should be
// implemented to provide bitmaps and color information for a given theme.
class UI_BASE_EXPORT ThemeProvider {
virtual ~ThemeProvider();
// Get the image specified by |id|. An implementation of ThemeProvider should
// have its own source of ids (e.g. an enum, or external resource bundle).
virtual gfx::ImageSkia* GetImageSkiaNamed(int id) const = 0;
// Get the color specified by |id|.
virtual SkColor GetColor(int id) const = 0;
// Get the HSL shift specified by |id|.
virtual color_utils::HSL GetTint(int id) const = 0;
// Get the property (e.g. an alignment expressed in an enum, or a width or
// height) specified by |id|.
virtual int GetDisplayProperty(int id) const = 0;
// Whether we should use the native system frame (typically Aero glass) or
// a custom frame.
virtual bool ShouldUseNativeFrame() const = 0;
// Whether or not we have a certain image. Used for when the default theme
// doesn't provide a certain image, but custom themes might (badges, etc).
virtual bool HasCustomImage(int id) const = 0;
// Reads the image data from the theme file into the specified vector. Only
// valid for un-themed resources and the themed IDR_THEME_NTP_* in most
// implementations of ThemeProvider. Returns NULL on error.
virtual base::RefCountedMemory* GetRawData(
int id,
ui::ScaleFactor scale_factor) const = 0;
#if defined(OS_MACOSX)
// Whether we're using the system theme (which may or may not be the
// same as the default theme).
// TODO(estade): this should probably just be part of ThemeService and not
// ThemeProvider, but it's used in many places on OSX.
virtual bool UsingSystemTheme() const = 0;
// Returns whether or not theme is in Incognito mode.
virtual bool InIncognitoMode() const = 0;
// Gets the NSImage with the specified |id|.
virtual NSImage* GetNSImageNamed(int id) const = 0;
// Returns true if the theme has defined a custom color for color |id|.
virtual bool HasCustomColor(int id) const = 0;
// Gets the NSImage that GetNSImageNamed (above) would return, but returns it
// as a pattern color.
virtual NSColor* GetNSImageColorNamed(int id) const = 0;
// Gets the NSColor with the specified |id|.
virtual NSColor* GetNSColor(int id) const = 0;
// Gets the NSColor for tinting with the specified |id|.
virtual NSColor* GetNSColorTint(int id) const = 0;
// Gets the NSGradient with the specified |id|.
virtual NSGradient* GetNSGradient(int id) const = 0;
// Whether the "increase contrast" accessibility setting is enabled.
virtual bool ShouldIncreaseContrast() const = 0;
} // namespace ui