Manages the system's stack of modal components. More...
|Receives callbacks when a modal component is dismissed. More...|
|int||getNumModalComponents () const|
|Returns the number of components currently being shown modally. |
|Component *||getModalComponent (int index) const|
|Returns one of the components being shown modally. |
|bool||isModal (Component *component) const|
|Returns true if the specified component is in a modal state. |
|bool||isFrontModalComponent (Component *component) const|
|Returns true if the specified component is currently the topmost modal component. |
|void||attachCallback (Component *component, Callback *callback)|
|Adds a new callback that will be called when the specified modal component is dismissed. |
|void||bringModalComponentsToFront (bool topOneShouldGrabFocus=true)|
|Brings any modal components to the front. |
|Calls exitModalState (0) on any components that are currently modal. |
|Creates a ModalComponentManager. |
|void||handleAsyncUpdate () override|
|Private Member Functions inherited from AsyncUpdater|
|Creates an AsyncUpdater object. |
|Causes the callback to be triggered at a later time. |
|void||cancelPendingUpdate () noexcept|
|This will stop any pending updates from happening. |
|If an update has been triggered and is pending, this will invoke it synchronously. |
|bool||isUpdatePending () const noexcept|
|Returns true if there's an update callback in the pipeline. |
|Static Private Member Functions inherited from DeletedAtShutdown|
|static void||deleteAll ()|
|Deletes all extant objects. |
Manages the system's stack of modal components.
Normally you'll just use the Component methods to invoke modal states in components, and won't have to deal with this class directly, but this is the singleton object that's used internally to manage the stack.
Creates a ModalComponentManager.
You shouldn't ever call the constructor - it's a singleton, so use ModalComponentManager::getInstance()
Returns the number of components currently being shown modally.
Returns one of the components being shown modally.
An index of 0 is the most recently-shown, topmost component.
|bool ModalComponentManager::isModal||(||Component *||component||)||const|
Returns true if the specified component is in a modal state.
|bool ModalComponentManager::isFrontModalComponent||(||Component *||component||)||const|
Returns true if the specified component is currently the topmost modal component.
Adds a new callback that will be called when the specified modal component is dismissed.
Each component can have any number of callbacks associated with it, and this one is added to that list.
The object that is passed in will be deleted by the manager when it's no longer needed. If the given component is not currently modal, the callback object is deleted immediately and no action is taken.
|void ModalComponentManager::bringModalComponentsToFront||(||bool||topOneShouldGrabFocus = ||)|
Brings any modal components to the front.
Calls exitModalState (0) on any components that are currently modal.