blob: 1218d8037663f650079d58f53e0a46b99ad20ab0 [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 <stddef.h>
#include <memory>
#include "base/macros.h"
#include "build/build_config.h"
#include "third_party/skia/include/core/SkColor.h"
#include "ui/gfx/color_palette.h"
#include "ui/native_theme/native_theme.h"
#include "ui/native_theme/themed_vector_icon.h"
#include "ui/views/views_export.h"
#if defined(OS_WIN)
#include <windows.h>
#endif // defined(OS_WIN)
namespace gfx {
class Canvas;
namespace ui {
class ThemedVectorIcon;
namespace views {
class Painter;
class View;
// Background class
// A background implements a way for views to paint a background. The
// background can be either solid or based on a gradient. Of course,
// Background can be subclassed to implement various effects.
// Any View can have a background. See View::SetBackground() and
// View::OnPaintBackground()
class VIEWS_EXPORT Background {
virtual ~Background();
// Render the background for the provided view
virtual void Paint(gfx::Canvas* canvas, View* view) const = 0;
// Set a solid, opaque color to be used when drawing backgrounds of native
// controls. Unfortunately alpha=0 is not an option.
void SetNativeControlColor(SkColor color);
// Returns the "background color". This is equivalent to the color set in
// SetNativeControlColor(). For solid backgrounds, this is the color; for
// gradient backgrounds, it's the midpoint of the gradient; for painter
// backgrounds, this is not useful (returns a default color).
SkColor get_color() const { return color_; }
SkColor color_ = gfx::kPlaceholderColor;
// Creates a background that fills the canvas in the specified color.
VIEWS_EXPORT std::unique_ptr<Background> CreateSolidBackground(SkColor color);
// Creates a background that fills the canvas with rounded corners.
VIEWS_EXPORT std::unique_ptr<Background> CreateRoundedRectBackground(
SkColor color,
float radius);
// Creates a background that fills the canvas in the color specified by the
// view's NativeTheme and the given color identifier.
VIEWS_EXPORT std::unique_ptr<Background> CreateThemedSolidBackground(
View* view,
ui::NativeTheme::ColorId color_id);
// Creates a background from the specified Painter.
VIEWS_EXPORT std::unique_ptr<Background> CreateBackgroundFromPainter(
std::unique_ptr<Painter> painter);
// Creates a background from the specified ThemedVectorIcon.
VIEWS_EXPORT std::unique_ptr<Background> CreateThemedVectorIconBackground(
View* view,
const ui::ThemedVectorIcon& icon);
} // namespace views