source/modules/juce_gui_basics/widgets/juce_ImageComponent.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library.
   5    Copyright (c) 2022 - Raw Material Software Limited
   6
   7    JUCE is an open source library subject to commercial or open-source
   8    licensing.
   9
  10    By using JUCE, you agree to the terms of both the JUCE 7 End-User License
  11    Agreement and JUCE Privacy Policy.
  12
  13    End User License Agreement: www.juce.com/juce-7-licence
  14    Privacy Policy: www.juce.com/juce-privacy-policy
  15
  16    Or: You may also use this code under the terms of the GPL v3 (see
  17    www.gnu.org/licenses).
  18
  19    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
  20    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
  21    DISCLAIMED.
  22
  23   ==============================================================================
  24 */
  25
  26 namespace juce
  27 {
  28
  29 //==============================================================================
  30 /**
  31     A component that simply displays an image.
  32
  33     Use setImage to give it an image, and it'll display it - simple as that!
  34
  35     @tags{GUI}
  36 */
  37 class JUCE_API  ImageComponent  : public Component,
  38                                   public SettableTooltipClient
  39 {
  40 public:
  41     //==============================================================================
  42     /** Creates an ImageComponent. */
  43     ImageComponent (const String& componentName = String());
  44
  45     /** Destructor. */
  46     ~ImageComponent() override;
  47
  48     //==============================================================================
  49     /** Sets the image that should be displayed. */
  50     void setImage (const Image& newImage);
  51
  52     /** Sets the image that should be displayed, and its placement within the component. */
  53     void setImage (const Image& newImage,
  54                    RectanglePlacement placementToUse);
  55
  56     /** Returns the current image. */
  57     const Image& getImage() const;
  58
  59     /** Sets the method of positioning that will be used to fit the image within the component's bounds.
  60         By default the positioning is centred, and will fit the image inside the component's bounds
  61         whilst keeping its aspect ratio correct, but you can change it to whatever layout you need.
  62     */
  63     void setImagePlacement (RectanglePlacement newPlacement);
  64
  65     /** Returns the current image placement. */
  66     RectanglePlacement getImagePlacement() const;
  67
  68     //==============================================================================
  69     /** @internal */
  70     void paint (Graphics&) override;
  71
  72 private:
  73     std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
  74
  75     Image image;
  76     RectanglePlacement placement;
  77
  78     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (ImageComponent)
  79 };
  80
  81 } // namespace juce