blob: 003fb79ac82d6d3d00660d7e85f441c9a0661c97 [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 <memory>
#include "base/macros.h"
#include "third_party/skia/include/core/SkColor.h"
#include "ui/gfx/color_palette.h"
#include "ui/gfx/geometry/insets.h"
#include "ui/views/views_export.h"
namespace gfx {
class Canvas;
class Size;
} // namespace gfx
namespace views {
class Painter;
class View;
// Border class.
// The border class is used to display a border around a view.
// To set a border on a view, just call SetBorder on the view, for example:
// view->SetBorder(CreateSolidBorder(1, SkColorSetRGB(25, 25, 112));
// Once set on a view, the border is owned by the view.
// IMPORTANT NOTE: not all views support borders at this point. In order to
// support the border, views should make sure to use bounds excluding the
// border (by calling View::GetLocalBoundsExcludingBorder) when doing layout and
// painting.
class VIEWS_EXPORT Border {
explicit Border(SkColor color);
virtual ~Border();
// Renders the border for the specified view.
virtual void Paint(const View& view, gfx::Canvas* canvas) = 0;
// Returns the border insets.
virtual gfx::Insets GetInsets() const = 0;
// Returns the minimum size this border requires. Note that this may not be
// the same as the insets. For example, a Border may paint images to draw
// some graphical border around a view, and this would return the minimum size
// such that these images would not be clipped or overlapping -- but the
// insets may be larger or smaller, depending on how the view wanted its
// content laid out relative to these images.
virtual gfx::Size GetMinimumSize() const = 0;
SkColor color() const { return color_; }
// Sets the border color.
void set_color(SkColor color) { color_ = color; }
SkColor color_ = gfx::kPlaceholderColor;
// Convenience for creating a scoped_ptr with no Border.
VIEWS_EXPORT std::unique_ptr<Border> NullBorder();
// Creates a border that is a simple line of the specified thickness and color.
VIEWS_EXPORT std::unique_ptr<Border> CreateSolidBorder(int thickness,
SkColor color);
// Creates a border that is a rounded rectangle of the specified thickness and
// color.
VIEWS_EXPORT std::unique_ptr<Border> CreateRoundedRectBorder(int thickness,
int corner_radius,
SkColor color);
VIEWS_EXPORT std::unique_ptr<Border> CreateRoundedRectBorder(
int thickness,
int corner_radius,
const gfx::Insets& paint_insets,
SkColor color);
// Creates a border for reserving space. The returned border does not paint
// anything.
VIEWS_EXPORT std::unique_ptr<Border> CreateEmptyBorder(
const gfx::Insets& insets);
VIEWS_EXPORT std::unique_ptr<Border> CreateEmptyBorder(int top,
int left,
int bottom,
int right);
// Creates a border of the specified color, and specified thickness on each
// side.
VIEWS_EXPORT std::unique_ptr<Border> CreateSolidSidedBorder(int top,
int left,
int bottom,
int right,
SkColor color);
// Creates a new border that draws |border| and adds additional padding. This is
// equivalent to changing the insets of |border| without changing how or what it
// paints. Example:
// view->SetBorder(CreatePaddedBorder(CreateSolidBorder(1, SK_ColorRED),
// gfx::Insets(2, 0, 0, 0)));
// yields a single dip red border and an additional 2dip of unpainted padding
// above the view content (below the border).
VIEWS_EXPORT std::unique_ptr<Border> CreatePaddedBorder(
std::unique_ptr<Border> border,
const gfx::Insets& insets);
// Creates a Border from the specified Painter. |insets| define size of an area
// allocated for a Border.
VIEWS_EXPORT std::unique_ptr<Border> CreateBorderPainter(
std::unique_ptr<Painter> painter,
const gfx::Insets& insets);
} // namespace views
#endif // UI_VIEWS_BORDER_H_