source/modules/juce_gui_extra/misc/juce_BubbleMessageComponent.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 speech-bubble component that displays a short message.
  32
  33     This can be used to show a message with the tail of the speech bubble
  34     pointing to a particular component or location on the screen.
  35
  36     @see BubbleComponent
  37
  38     @tags{GUI}
  39 */
  40 class JUCE_API  BubbleMessageComponent  : public BubbleComponent,
  41                                           private Timer
  42 {
  43 public:
  44     //==============================================================================
  45     /** Creates a bubble component.
  46
  47         After creating one a BubbleComponent, do the following:
  48         - add it to an appropriate parent component, or put it on the
  49           desktop with Component::addToDesktop (0).
  50         - use the showAt() method to show a message.
  51         - it will make itself invisible after it times-out (and can optionally
  52           also delete itself), or you can reuse it somewhere else by calling
  53           showAt() again.
  54     */
  55     BubbleMessageComponent (int fadeOutLengthMs = 150);
  56
  57     /** Destructor. */
  58     ~BubbleMessageComponent() override;
  59
  60     //==============================================================================
  61     /** Shows a message bubble at a particular position.
  62
  63         This shows the bubble with its stem pointing to the given location
  64         (coordinates being relative to its parent component).
  65
  66         @param position                         the coords of the object to point to
  67         @param message                          the text to display
  68         @param numMillisecondsBeforeRemoving    how long to leave it on the screen before removing itself
  69                                                 from its parent component. If this is 0 or less, it
  70                                                 will stay there until manually removed.
  71         @param removeWhenMouseClicked           if this is true, the bubble will disappear as soon as a
  72                                                 mouse button is pressed (anywhere on the screen)
  73         @param deleteSelfAfterUse               if true, then the component will delete itself after
  74                                                 it becomes invisible
  75     */
  76     void showAt (const Rectangle<int>& position,
  77                  const AttributedString& message,
  78                  int numMillisecondsBeforeRemoving,
  79                  bool removeWhenMouseClicked = true,
  80                  bool deleteSelfAfterUse = false);
  81
  82     /** Shows a message bubble next to a particular component.
  83
  84         This shows the bubble with its stem pointing at the given component.
  85
  86         @param component                        the component that you want to point at
  87         @param message                          the text to display
  88         @param numMillisecondsBeforeRemoving    how long to leave it on the screen before removing itself
  89                                                 from its parent component. If this is 0 or less, it
  90                                                 will stay there until manually removed.
  91         @param removeWhenMouseClicked           if this is true, the bubble will disappear as soon as a
  92                                                 mouse button is pressed (anywhere on the screen)
  93         @param deleteSelfAfterUse               if true, then the component will delete itself after
  94                                                 it becomes invisible
  95     */
  96     void showAt (Component* component,
  97                  const AttributedString& message,
  98                  int numMillisecondsBeforeRemoving,
  99                  bool removeWhenMouseClicked = true,
 100                  bool deleteSelfAfterUse = false);
 101
 102
 103     //==============================================================================
 104     /** @internal */
 105     void getContentSize (int& w, int& h) override;
 106     /** @internal */
 107     void paintContent (Graphics& g, int w, int h) override;
 108     /** @internal */
 109     void timerCallback() override;
 110
 111 private:
 112     //==============================================================================
 113     int fadeOutLength, mouseClickCounter;
 114     TextLayout textLayout;
 115     int64 expiryTime;
 116     bool deleteAfterUse;
 117
 118     void createLayout (const AttributedString&);
 119     void init (int, bool, bool);
 120     void hide (bool fadeOut);
 121
 122     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (BubbleMessageComponent)
 123 };
 124
 125 } // namespace juce