border.h revision f2477e01787aa58f445919b809d89e252beef54f
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef UI_VIEWS_BORDER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UI_VIEWS_BORDER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "third_party/skia/include/core/SkColor.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/gfx/insets.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/view.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/views_export.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace gfx{ 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Canvas; 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace views { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Painter; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class View; 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//////////////////////////////////////////////////////////////////////////////// 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Border class. 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The border class is used to display a border around a view. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// To set a border on a view, just call SetBorder on the view, for example: 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// view->set_border(Border::CreateSolidBorder(1, SkColorSetRGB(25, 25, 112)); 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Once set on a view, the border is owned by the view. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// IMPORTANT NOTE: not all views support borders at this point. In order to 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// support the border, views should make sure to use bounds excluding the 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// border (by calling View::GetLocalBoundsExcludingBorder) when doing layout and 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// painting. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//////////////////////////////////////////////////////////////////////////////// 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 392a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class TextButtonBorder; 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class VIEWS_EXPORT Border { 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Border(); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~Border(); 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a border that is a simple line of the specified thickness and 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // color. 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Border* CreateSolidBorder(int thickness, SkColor color); 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a border for reserving space. The returned border does not 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // paint anything. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Border* CreateEmptyBorder(int top, int left, int bottom, int right); 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a border of the specified color, and specified thickness on each 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // side. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Border* CreateSolidSidedBorder(int top, 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int left, 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int bottom, 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int right, 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SkColor color); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a Border from the specified Painter. The border owns the painter, 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // thus the painter is deleted when the Border is deleted. 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // |insets| define size of an area allocated for a Border. 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) static Border* CreateBorderPainter(Painter* painter, 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const gfx::Insets& insets); 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Renders the border for the specified view. 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Paint(const View& view, gfx::Canvas* canvas) = 0; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 71f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Returns the border insets. 722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual gfx::Insets GetInsets() const = 0; 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 74f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Returns the minimum size this border requires. Note that this may not be 75f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // the same as the insets. For example, a Border may paint images to draw 76f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // some graphical border around a view, and this would return the minimum size 77f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // such that these images would not be clipped or overlapping -- but the 78f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // insets may be larger or smaller, depending on how the view wanted its 79f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // content laid out relative to these images. 80f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) virtual gfx::Size GetMinimumSize() const = 0; 81f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 822a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Manual RTTI for text buttons. 832a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual TextButtonBorder* AsTextButtonBorder(); 842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual const TextButtonBorder* AsTextButtonBorder() const; 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(Border); 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace views 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // UI_VIEWS_BORDER_H_ 93