163 lines
8.2 KiB
C++
163 lines
8.2 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library.
|
|
Copyright (c) 2017 - ROLI Ltd.
|
|
|
|
JUCE is an open source library subject to commercial or open-source
|
|
licensing.
|
|
|
|
By using JUCE, you agree to the terms of both the JUCE 5 End-User License
|
|
Agreement and JUCE 5 Privacy Policy (both updated and effective as of the
|
|
27th April 2017).
|
|
|
|
End User License Agreement: www.juce.com/juce-5-licence
|
|
Privacy Policy: www.juce.com/juce-5-privacy-policy
|
|
|
|
Or: You may also use this code under the terms of the GPL v3 (see
|
|
www.gnu.org/licenses).
|
|
|
|
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
|
|
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
|
|
DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
//==============================================================================
|
|
/**
|
|
As the title suggests, this is a button containing an image.
|
|
|
|
The colour and transparency of the image can be set to vary when the
|
|
button state changes.
|
|
|
|
@see Button, ShapeButton, TextButton
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API ImageButton : public Button
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates an ImageButton.
|
|
|
|
Use setImage() to specify the image to use. The colours and opacities that
|
|
are specified here can be changed later using setImages().
|
|
|
|
@param name the name to give the component
|
|
*/
|
|
explicit ImageButton (const String& name = String());
|
|
|
|
/** Destructor. */
|
|
~ImageButton();
|
|
|
|
//==============================================================================
|
|
/** Sets up the images to draw in various states.
|
|
|
|
@param resizeButtonNowToFitThisImage if true, the button will be immediately
|
|
resized to the same dimensions as the normal image
|
|
@param rescaleImagesWhenButtonSizeChanges if true, the image will be rescaled to fit the
|
|
button when the button's size changes
|
|
@param preserveImageProportions if true then any rescaling of the image to fit
|
|
the button will keep the image's x and y proportions
|
|
correct - i.e. it won't distort its shape, although
|
|
this might create gaps around the edges
|
|
@param normalImage the image to use when the button is in its normal state.
|
|
button no longer needs it.
|
|
@param imageOpacityWhenNormal the opacity to use when drawing the normal image.
|
|
@param overlayColourWhenNormal an overlay colour to use to fill the alpha channel of the
|
|
normal image - if this colour is transparent, no overlay
|
|
will be drawn. The overlay will be drawn over the top of the
|
|
image, so you can basically add a solid or semi-transparent
|
|
colour to the image to brighten or darken it
|
|
@param overImage the image to use when the mouse is over the button. If
|
|
you want to use the same image as was set in the normalImage
|
|
parameter, this value can be a null image.
|
|
@param imageOpacityWhenOver the opacity to use when drawing the image when the mouse
|
|
is over the button
|
|
@param overlayColourWhenOver an overlay colour to use to fill the alpha channel of the
|
|
image when the mouse is over - if this colour is transparent,
|
|
no overlay will be drawn
|
|
@param downImage an image to use when the button is pressed down. If set
|
|
to a null image, the 'over' image will be drawn instead (or the
|
|
normal image if there isn't an 'over' image either).
|
|
@param imageOpacityWhenDown the opacity to use when drawing the image when the button
|
|
is pressed
|
|
@param overlayColourWhenDown an overlay colour to use to fill the alpha channel of the
|
|
image when the button is pressed down - if this colour is
|
|
transparent, no overlay will be drawn
|
|
@param hitTestAlphaThreshold if set to zero, the mouse is considered to be over the button
|
|
whenever it's inside the button's bounding rectangle. If
|
|
set to values higher than 0, the mouse will only be
|
|
considered to be over the image when the value of the
|
|
image's alpha channel at that position is greater than
|
|
this level.
|
|
*/
|
|
void setImages (bool resizeButtonNowToFitThisImage,
|
|
bool rescaleImagesWhenButtonSizeChanges,
|
|
bool preserveImageProportions,
|
|
const Image& normalImage,
|
|
float imageOpacityWhenNormal,
|
|
Colour overlayColourWhenNormal,
|
|
const Image& overImage,
|
|
float imageOpacityWhenOver,
|
|
Colour overlayColourWhenOver,
|
|
const Image& downImage,
|
|
float imageOpacityWhenDown,
|
|
Colour overlayColourWhenDown,
|
|
float hitTestAlphaThreshold = 0.0f);
|
|
|
|
/** Returns the currently set 'normal' image. */
|
|
Image getNormalImage() const;
|
|
|
|
/** Returns the image that's drawn when the mouse is over the button.
|
|
|
|
If a valid 'over' image has been set, this will return it; otherwise it'll
|
|
just return the normal image.
|
|
*/
|
|
Image getOverImage() const;
|
|
|
|
/** Returns the image that's drawn when the button is held down.
|
|
|
|
If a valid 'down' image has been set, this will return it; otherwise it'll
|
|
return the 'over' image or normal image, depending on what's available.
|
|
*/
|
|
Image getDownImage() const;
|
|
|
|
//==============================================================================
|
|
/** This abstract base class is implemented by LookAndFeel classes. */
|
|
struct JUCE_API LookAndFeelMethods
|
|
{
|
|
virtual ~LookAndFeelMethods() {}
|
|
|
|
virtual void drawImageButton (Graphics&, Image*,
|
|
int imageX, int imageY, int imageW, int imageH,
|
|
const Colour& overlayColour, float imageOpacity, ImageButton&) = 0;
|
|
};
|
|
|
|
protected:
|
|
//==============================================================================
|
|
/** @internal */
|
|
bool hitTest (int x, int y) override;
|
|
/** @internal */
|
|
void paintButton (Graphics&, bool isMouseOver, bool isButtonDown) override;
|
|
|
|
private:
|
|
//==============================================================================
|
|
bool scaleImageToFit, preserveProportions;
|
|
uint8 alphaThreshold;
|
|
Rectangle<int> imageBounds;
|
|
Image normalImage, overImage, downImage;
|
|
float normalOpacity, overOpacity, downOpacity;
|
|
Colour normalOverlay, overOverlay, downOverlay;
|
|
|
|
Image getCurrentImage() const;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ImageButton)
|
|
};
|
|
|
|
} // namespace juce
|