diff options
Diffstat (limited to 'ui/views/controls/image_view.h')
-rw-r--r-- | ui/views/controls/image_view.h | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/ui/views/controls/image_view.h b/ui/views/controls/image_view.h new file mode 100644 index 0000000..1149c8d --- /dev/null +++ b/ui/views/controls/image_view.h @@ -0,0 +1,112 @@ +// Copyright (c) 2011 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. + +#ifndef UI_VIEWS_CONTROLS_IMAGE_VIEW_H_ +#define UI_VIEWS_CONTROLS_IMAGE_VIEW_H_ +#pragma once + +#include "third_party/skia/include/core/SkBitmap.h" +#include "views/view.h" + +namespace gfx { +class Canvas; +} + +namespace views { + +///////////////////////////////////////////////////////////////////////////// +// +// ImageView class. +// +// An ImageView can display an image from an SkBitmap. If a size is provided, +// the ImageView will resize the provided image to fit if it is too big or will +// center the image if smaller. Otherwise, the preferred size matches the +// provided image size. +// +///////////////////////////////////////////////////////////////////////////// +class VIEWS_EXPORT ImageView : public View { + public: + enum Alignment { + LEADING = 0, + CENTER, + TRAILING + }; + + ImageView(); + virtual ~ImageView(); + + // Set the bitmap that should be displayed. + void SetImage(const SkBitmap& bm); + + // Set the bitmap that should be displayed from a pointer. Reset the image + // if the pointer is NULL. The pointer contents is copied in the receiver's + // bitmap. + void SetImage(const SkBitmap* bm); + + // Returns the bitmap currently displayed or NULL of none is currently set. + // The returned bitmap is still owned by the ImageView. + const SkBitmap& GetImage(); + + // Set the desired image size for the receiving ImageView. + void SetImageSize(const gfx::Size& image_size); + + // Return the preferred size for the receiving view. Returns false if the + // preferred size is not defined, which means that the view uses the image + // size. + bool GetImageSize(gfx::Size* image_size); + + // Returns the actual bounds of the visible image inside the view. + gfx::Rect GetImageBounds() const; + + // Reset the image size to the current image dimensions. + void ResetImageSize(); + + // Set / Get the horizontal alignment. + void SetHorizontalAlignment(Alignment ha); + Alignment GetHorizontalAlignment() const; + + // Set / Get the vertical alignment. + void SetVerticalAlignment(Alignment va); + Alignment GetVerticalAlignment() const; + + // Set / Get the tooltip text. + void SetTooltipText(const string16& tooltip); + string16 GetTooltipText() const; + + // Overriden from View + virtual gfx::Size GetPreferredSize() OVERRIDE; + virtual void OnPaint(gfx::Canvas* canvas) OVERRIDE; + virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE; + virtual bool GetTooltipText(const gfx::Point& p, + string16* tooltip) const OVERRIDE; + + private: + // Compute the image origin given the desired size and the receiver alignment + // properties. + gfx::Point ComputeImageOrigin(const gfx::Size& image_size) const; + + // Whether the image size is set. + bool image_size_set_; + + // The actual image size. + gfx::Size image_size_; + + // The underlying bitmap. + SkBitmap image_; + + // Horizontal alignment. + Alignment horiz_alignment_; + + // Vertical alignment. + Alignment vert_alignment_; + + // The current tooltip text. + string16 tooltip_text_; + + DISALLOW_COPY_AND_ASSIGN(ImageView); +}; + +} // namespace views + +#endif // UI_VIEWS_CONTROLS_IMAGE_VIEW_H_ |