mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
90 lines
3.4 KiB
C++
90 lines
3.4 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE framework.
|
|
Copyright (c) Raw Material Software Limited
|
|
|
|
JUCE is an open source framework subject to commercial or open source
|
|
licensing.
|
|
|
|
By downloading, installing, or using the JUCE framework, or combining the
|
|
JUCE framework with any other source code, object code, content or any other
|
|
copyrightable work, you agree to the terms of the JUCE End User Licence
|
|
Agreement, and all incorporated terms including the JUCE Privacy Policy and
|
|
the JUCE Website Terms of Service, as applicable, which will bind you. If you
|
|
do not agree to the terms of these agreements, we will not license the JUCE
|
|
framework to you, and you must discontinue the installation or download
|
|
process and cease use of the JUCE framework.
|
|
|
|
JUCE End User Licence Agreement: https://juce.com/legal/juce-8-licence/
|
|
JUCE Privacy Policy: https://juce.com/juce-privacy-policy
|
|
JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/
|
|
|
|
Or:
|
|
|
|
You may also use this code under the terms of the AGPLv3:
|
|
https://www.gnu.org/licenses/agpl-3.0.en.html
|
|
|
|
THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL
|
|
WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF
|
|
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
//==============================================================================
|
|
/**
|
|
A component that simply displays an image.
|
|
|
|
Use setImage to give it an image, and it'll display it - simple as that!
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API ImageComponent : public Component,
|
|
public SettableTooltipClient
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates an ImageComponent. */
|
|
ImageComponent (const String& componentName = String());
|
|
|
|
/** Destructor. */
|
|
~ImageComponent() override;
|
|
|
|
//==============================================================================
|
|
/** Sets the image that should be displayed. */
|
|
void setImage (const Image& newImage);
|
|
|
|
/** Sets the image that should be displayed, and its placement within the component. */
|
|
void setImage (const Image& newImage,
|
|
RectanglePlacement placementToUse);
|
|
|
|
/** Returns the current image. */
|
|
const Image& getImage() const;
|
|
|
|
/** Sets the method of positioning that will be used to fit the image within the component's bounds.
|
|
By default the positioning is centred, and will fit the image inside the component's bounds
|
|
whilst keeping its aspect ratio correct, but you can change it to whatever layout you need.
|
|
*/
|
|
void setImagePlacement (RectanglePlacement newPlacement);
|
|
|
|
/** Returns the current image placement. */
|
|
RectanglePlacement getImagePlacement() const;
|
|
|
|
//==============================================================================
|
|
/** @internal */
|
|
void paint (Graphics&) override;
|
|
/** @internal */
|
|
std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
|
|
|
|
private:
|
|
Image image;
|
|
RectanglePlacement placement;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ImageComponent)
|
|
};
|
|
|
|
} // namespace juce
|