blob: 2ba26fa80773d912b65a2362940823333d816ab9 [file] [log] [blame]
// 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.
#pragma once
#include "third_party/skia/include/core/SkBitmap.h"
#include "views/controls/button/custom_button.h"
namespace views {
// An image button.
// Note that this type of button is not focusable by default and will not be
// part of the focus chain. Call set_focusable(true) to make it part of the
// focus chain.
class VIEWS_EXPORT ImageButton : public CustomButton {
explicit ImageButton(ButtonListener* listener);
virtual ~ImageButton();
// Set the image the button should use for the provided state.
virtual void SetImage(ButtonState aState, const SkBitmap* anImage);
// Set the background details.
void SetBackground(SkColor color,
const SkBitmap* image,
const SkBitmap* mask);
enum HorizontalAlignment { ALIGN_LEFT = 0,
enum VerticalAlignment { ALIGN_TOP = 0,
// Sets how the image is laid out within the button's bounds.
void SetImageAlignment(HorizontalAlignment h_align,
VerticalAlignment v_align);
// Overridden from View:
virtual gfx::Size GetPreferredSize() OVERRIDE;
virtual void OnPaint(gfx::Canvas* canvas) OVERRIDE;
// Sets preferred size, so it could be correctly positioned in layout even if
// it is NULL.
void SetPreferredSize(const gfx::Size& preferred_size) {
preferred_size_ = preferred_size;
// Returns the image to paint. This is invoked from paint and returns a value
// from images.
virtual SkBitmap GetImageToPaint();
// The images used to render the different states of this button.
SkBitmap images_[BS_COUNT];
// The background image.
SkBitmap background_image_;
// Image alignment.
HorizontalAlignment h_alignment_;
VerticalAlignment v_alignment_;
gfx::Size preferred_size_;
// ToggleImageButton
// A toggle-able ImageButton. It swaps out its graphics when toggled.
class VIEWS_EXPORT ToggleImageButton : public ImageButton {
explicit ToggleImageButton(ButtonListener* listener);
virtual ~ToggleImageButton();
// Change the toggled state.
void SetToggled(bool toggled);
// Like ImageButton::SetImage(), but to set the graphics used for the
// "has been toggled" state. Must be called for each button state
// before the button is toggled.
void SetToggledImage(ButtonState state, const SkBitmap* image);
// Set the tooltip text displayed when the button is toggled.
void SetToggledTooltipText(const string16& tooltip);
// Overridden from ImageButton:
virtual void SetImage(ButtonState aState, const SkBitmap* anImage) OVERRIDE;
// Overridden from View:
virtual bool GetTooltipText(const gfx::Point& p,
string16* tooltip) const OVERRIDE;
// The parent class's images_ member is used for the current images,
// and this array is used to hold the alternative images.
// We swap between the two when toggling.
SkBitmap alternate_images_[BS_COUNT];
// True if the button is currently toggled.
bool toggled_;
// The parent class's tooltip_text_ is displayed when not toggled, and
// this one is shown when toggled.
string16 toggled_tooltip_text_;
} // namespace views