#include <juce_SplashScreen.h>
Protected Member Functions | |
| SplashScreen (const String &title, int width, int height, bool useDropShadow) | |
| void | paint (Graphics &) override |
| Protected Member Functions inherited from juce::Component | |
| virtual ComponentPeer * | createNewPeer (int styleFlags, void *nativeWindowToAttachTo) |
Private Member Functions | |
| void | timerCallback () override |
| void | makeVisible (int w, int h, bool shadow, bool fullscreen) |
| Private Member Functions inherited from juce::Timer | |
| virtual | ~Timer () |
| void | startTimer (int intervalInMilliseconds) noexcept |
| void | startTimerHz (int timerFrequencyHz) noexcept |
| void | stopTimer () noexcept |
| bool | isTimerRunning () const noexcept |
| int | getTimerInterval () const noexcept |
| Timer () noexcept | |
| Timer (const Timer &) noexcept | |
| Private Member Functions inherited from juce::DeletedAtShutdown | |
| DeletedAtShutdown () | |
| virtual | ~DeletedAtShutdown () |
Private Attributes | |
| Image | backgroundImage |
| Time | creationTime |
| RelativeTime | minimumVisibleTime |
| int | clickCountToDelete |
Detailed Description
A component for showing a splash screen while your app starts up.
This will automatically position itself, and can be told to delete itself after being on-screen for a minimum length of time.
To use it, just create one of these in your JUCEApplicationBase::initialise() method, and when your initialisation tasks have finished running, call its deleteAfterDelay() method to make it automatically get rid of itself.
Note that although you could call deleteAfterDelay() as soon as you create the SplashScreen object, if you've got a long initialisation procedure, you probably don't want the splash to time-out and disappear before the initialisation has finished, which is why it makes sense to not call this method until the end of your init tasks.
E.g.
@tags{GUI}
Constructor & Destructor Documentation
◆ SplashScreen() [1/2]
| juce::SplashScreen::SplashScreen | ( | const String & | title, |
| const Image & | backgroundImage, | ||
| bool | useDropShadow ) |
Creates a SplashScreen object.
When called, the constructor will position the SplashScreen in the centre of the display, and after the time specified, it will automatically delete itself.
Bear in mind that if you call this during your JUCEApplicationBase::initialise() method and then block the message thread by performing some kind of task, then obviously neither your splash screen nor any other GUI will appear until you allow the message thread to resume and do its work. So if you have time-consuming tasks to do during startup, use a background thread for them.
After creating one of these (or your subclass of it), you should do your app's initialisation work, and then call the deleteAfterDelay() method to tell this object to delete itself after the user has had chance to get a good look at it.
If you're writing a custom splash screen class, there's another protected constructor that your subclass can call, which doesn't take an image.
- Parameters
-
title the name to give the component backgroundImage an image to draw on the component. The component's size will be set to the size of this image, and if the image is semi-transparent, the component will be made non-opaque useDropShadow if true, the window will have a drop shadow
◆ ~SplashScreen()
|
override |
Destructor.
◆ SplashScreen() [2/2]
|
protected |
This constructor is for use by custom sub-classes that don't want to provide an image.
Member Function Documentation
◆ deleteAfterDelay()
| void juce::SplashScreen::deleteAfterDelay | ( | RelativeTime | minimumTotalTimeToDisplayFor, |
| bool | removeOnMouseClick ) |
Tells the component to auto-delete itself after a timeout period, or when the mouse is clicked.
You should call this after finishing your app's initialisation work.
Note that although you could call deleteAfterDelay() as soon as you create the SplashScreen object, if you've got a long initialisation procedure, you probably don't want the splash to time-out and disappear before your initialisation has finished, which is why it makes sense to not call this method and start the self-delete timer until you're ready.
It's safe to call this method from a non-GUI thread as long as there's no danger that the object may be being deleted at the same time.
- Parameters
-
minimumTotalTimeToDisplayFor how long the splash screen should stay visible for. Note that this time is measured from the construction-time of this object, not from the time that the deleteAfterDelay() method is called, so if you call this method after a long initialisation period, it may be deleted without any further delay. removeOnMouseClick if true, the window will be deleted as soon as the user clicks the mouse (anywhere)
◆ makeVisible()
◆ paint()
Components can override this method to draw their content.
The paint() method gets called when a region of a component needs redrawing, either because the component's repaint() method has been called, or because something has happened on the screen that means a section of a window needs to be redrawn.
Any child components will draw themselves over whatever this method draws. If you need to paint over the top of your child components, you can also implement the paintOverChildren() method to do this.
If you want to cause a component to redraw itself, this is done asynchronously - calling the repaint() method marks a region of the component as "dirty", and the paint() method will automatically be called sometime later, by the message thread, to paint any bits that need refreshing. In JUCE (and almost all modern UI frameworks), you never redraw something synchronously.
You should never need to call this method directly - to take a snapshot of the component you could use createComponentSnapshot() or paintEntireComponent().
- Parameters
-
g the graphics context that must be used to do the drawing operations.
- See also
- repaint, paintOverChildren, Graphics
Reimplemented from juce::Component.
◆ timerCallback()
|
overrideprivatevirtual |
The user-defined callback routine that actually gets called periodically.
It's perfectly ok to call startTimer() or stopTimer() from within this callback to change the subsequent intervals.
Implements juce::Timer.
Member Data Documentation
◆ backgroundImage
|
private |
◆ clickCountToDelete
|
private |
◆ creationTime
|
private |
◆ minimumVisibleTime
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_extra/misc/juce_SplashScreen.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_extra/misc/juce_SplashScreen.cpp
Generated on for LMMS by
1.16.1