blob: d2657c60c13c927348b373311c9ef03268dbac90 [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 "base/basictypes.h"
#include "base/memory/scoped_ptr.h"
#include "third_party/skia/include/core/SkColor.h"
#include "ui/gfx/insets.h"
#include "ui/views/views_export.h"
namespace gfx{
class Canvas;
class Size;
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(Border::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 {
virtual ~Border();
// Convenience for creating a scoped_ptr with no Border.
static scoped_ptr<Border> NullBorder();
// Creates a border that is a simple line of the specified thickness and
// color.
static scoped_ptr<Border> CreateSolidBorder(int thickness, SkColor color);
// Creates a border for reserving space. The returned border does not
// paint anything.
static scoped_ptr<Border> CreateEmptyBorder(int top,
int left,
int bottom,
int right);
// Creates a border of the specified color, and specified thickness on each
// side.
static scoped_ptr<Border> CreateSolidSidedBorder(int top,
int left,
int bottom,
int right,
SkColor color);
// Creates a Border from the specified Painter. The border owns the painter,
// thus the painter is deleted when the Border is deleted.
// |insets| define size of an area allocated for a Border.
static scoped_ptr<Border> CreateBorderPainter(Painter* painter,
const gfx::Insets& insets);
// 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;
} // namespace views
#endif // UI_VIEWS_BORDER_H_