Loading...
Searching...
No Matches
TopLevelWindow Class Reference

A base class for top-level windows. More...

#include <juce_TopLevelWindow.h>

Inheritance diagram for TopLevelWindow:

Public Member Functions

 TopLevelWindow (const String &name, bool addToDesktop)
 Creates a TopLevelWindow.
 
 ~TopLevelWindow () override
 Destructor.
 
bool isActiveWindow () const noexcept
 True if this is currently the TopLevelWindow that is actively being used.
 
void centreAroundComponent (Component *componentToCentreAround, int width, int height)
 This will set the bounds of the window so that it's centred in front of another window.
 
void setDropShadowEnabled (bool useShadow)
 Turns the drop-shadow on and off.
 
bool isDropShadowEnabled () const noexcept
 True if drop-shadowing is enabled.
 
void setUsingNativeTitleBar (bool useNativeTitleBar)
 Sets whether an OS-native title bar will be used, or a JUCE one.
 
bool isUsingNativeTitleBar () const noexcept
 Returns true if the window is currently using an OS-native title bar.
 
void addToDesktop ()
 Adds the window to the desktop using the default flags.
 
void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr) override
 Makes this component appear as a window on the desktop.
 
std::unique_ptr< AccessibilityHandlercreateAccessibilityHandler () override
 Override this method to return a custom AccessibilityHandler for this component.
 
- Public Member Functions inherited from Component
 Component () noexcept
 Creates a component.
 
 ~Component () override
 Destructor.
 
 Component (const String &componentName) noexcept
 Creates a component, setting its name at the same time.
 
String getName () const noexcept
 Returns the name of this component.
 
virtual void setName (const String &newName)
 Sets the name of this component.
 
String getComponentID () const noexcept
 Returns the ID string that was set by setComponentID().
 
void setComponentID (const String &newID)
 Sets the component's ID string.
 
virtual void setVisible (bool shouldBeVisible)
 Makes the component visible or invisible.
 
bool isVisible () const noexcept
 Tests whether the component is visible or not.
 
bool isShowing () const
 Tests whether this component and all its parents are visible.
 
void removeFromDesktop ()
 If the component is currently showing on the desktop, this will hide it.
 
bool isOnDesktop () const noexcept
 Returns true if this component is currently showing on the desktop.
 
ComponentPeergetPeer () const
 Returns the heavyweight window that contains this component.
 
virtual void userTriedToCloseWindow ()
 For components on the desktop, this is called if the system wants to close the window.
 
virtual void minimisationStateChanged (bool isNowMinimised)
 Called for a desktop component which has just been minimised or un-minimised.
 
virtual float getDesktopScaleFactor () const
 Returns the default scale factor to use for this component when it is placed on the desktop.
 
void toFront (bool shouldAlsoGainKeyboardFocus)
 Brings the component to the front of its siblings.
 
void toBack ()
 Changes this component's z-order to be at the back of all its siblings.
 
void toBehind (Component *other)
 Changes this component's z-order so that it's just behind another component.
 
void setAlwaysOnTop (bool shouldStayOnTop)
 Sets whether the component should always be kept at the front of its siblings.
 
bool isAlwaysOnTop () const noexcept
 Returns true if this component is set to always stay in front of its siblings.
 
int getX () const noexcept
 Returns the x coordinate of the component's left edge.
 
int getY () const noexcept
 Returns the y coordinate of the top of this component.
 
int getWidth () const noexcept
 Returns the component's width in pixels.
 
int getHeight () const noexcept
 Returns the component's height in pixels.
 
int getRight () const noexcept
 Returns the x coordinate of the component's right-hand edge.
 
Point< int > getPosition () const noexcept
 Returns the component's top-left position as a Point.
 
int getBottom () const noexcept
 Returns the y coordinate of the bottom edge of this component.
 
Rectangle< int > getBounds () const noexcept
 Returns this component's bounding box.
 
Rectangle< int > getLocalBounds () const noexcept
 Returns the component's bounds, relative to its own origin.
 
Rectangle< int > getBoundsInParent () const noexcept
 Returns the area of this component's parent which this component covers.
 
int getScreenX () const
 Returns this component's x coordinate relative the screen's top-left origin.
 
int getScreenY () const
 Returns this component's y coordinate relative the screen's top-left origin.
 
Point< int > getScreenPosition () const
 Returns the position of this component's top-left corner relative to the screen's top-left.
 
Rectangle< int > getScreenBounds () const
 Returns the bounds of this component, relative to the screen's top-left.
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Rectangle< int > getLocalArea (const Component *sourceComponent, Rectangle< int > areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space.
 
Rectangle< float > getLocalArea (const Component *sourceComponent, Rectangle< float > areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space.
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Rectangle< int > localAreaToGlobal (Rectangle< int > localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate.
 
Rectangle< float > localAreaToGlobal (Rectangle< float > localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate.
 
void setTopLeftPosition (int x, int y)
 Moves the component to a new position.
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 Moves the component to a new position.
 
void setTopRightPosition (int x, int y)
 Moves the component to a new position.
 
void setSize (int newWidth, int newHeight)
 Changes the size of the component.
 
void setBounds (int x, int y, int width, int height)
 Changes the component's position and size.
 
void setBounds (Rectangle< int > newBounds)
 Changes the component's position and size.
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 Changes the component's position and size in terms of fractions of its parent's size.
 
void setBoundsRelative (Rectangle< float > proportionalArea)
 Changes the component's position and size in terms of fractions of its parent's size.
 
void setBoundsInset (BorderSize< int > borders)
 Changes the component's position and size based on the amount of space to leave around it.
 
void setBoundsToFit (Rectangle< int > targetArea, Justification justification, bool onlyReduceInSize)
 Positions the component within a given rectangle, keeping its proportions unchanged.
 
void setCentrePosition (int x, int y)
 Changes the position of the component's centre.
 
void setCentrePosition (Point< int > newCentrePosition)
 Changes the position of the component's centre.
 
void setCentreRelative (float x, float y)
 Changes the position of the component's centre.
 
void centreWithSize (int width, int height)
 Changes the component's size and centres it within its parent.
 
void setTransform (const AffineTransform &transform)
 Sets a transform matrix to be applied to this component.
 
AffineTransform getTransform () const
 Returns the transform that is currently being applied to this component.
 
bool isTransformed () const noexcept
 Returns true if a non-identity transform is being applied to this component.
 
int proportionOfWidth (float proportion) const noexcept
 Returns a proportion of the component's width.
 
int proportionOfHeight (float proportion) const noexcept
 Returns a proportion of the component's height.
 
int getParentWidth () const noexcept
 Returns the width of the component's parent.
 
int getParentHeight () const noexcept
 Returns the height of the component's parent.
 
Rectangle< int > getParentMonitorArea () const
 Returns the screen coordinates of the monitor that contains this component.
 
int getNumChildComponents () const noexcept
 Returns the number of child components that this component contains.
 
ComponentgetChildComponent (int index) const noexcept
 Returns one of this component's child components, by it index.
 
int getIndexOfChildComponent (const Component *child) const noexcept
 Returns the index of this component in the list of child components.
 
const Array< Component * > & getChildren () const noexcept
 Provides access to the underlying array of child components.
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 Looks for a child component with the specified ID.
 
void addChildComponent (Component *child, int zOrder=-1)
 Adds a child component to this one.
 
void addChildComponent (Component &child, int zOrder=-1)
 Adds a child component to this one.
 
void addAndMakeVisible (Component *child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addAndMakeVisible (Component &child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addChildAndSetID (Component *child, const String &componentID)
 Adds a child component to this one, makes it visible, and sets its component ID.
 
void removeChildComponent (Component *childToRemove)
 Removes one of this component's child-components.
 
ComponentremoveChildComponent (int childIndexToRemove)
 Removes one of this component's child-components by index.
 
void removeAllChildren ()
 Removes all this component's children.
 
void deleteAllChildren ()
 Removes and deletes all of this component's children.
 
ComponentgetParentComponent () const noexcept
 Returns the component which this component is inside.
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 Searches the parent components for a component of a specified class.
 
ComponentgetTopLevelComponent () const noexcept
 Returns the highest-level component which contains this one or its parents.
 
bool isParentOf (const Component *possibleChild) const noexcept
 Checks whether a component is anywhere inside this component or its children.
 
virtual void childrenChanged ()
 Subclasses can use this callback to be told when children are added or removed, or when their z-order changes.
 
virtual bool hitTest (int x, int y)
 Tests whether a given point is inside the component.
 
virtual WindowControlKind findControlAtPoint (Point< float >) const
 For components that are added to the desktop, this may be called to determine what kind of control is at particular locations in the window.
 
virtual void windowControlClickedClose ()
 For components that are added to the desktop, this may be called to indicate that the mouse was clicked inside the area of the "close" control.
 
virtual void windowControlClickedMinimise ()
 For components that are added to the desktop, this may be called to indicate that the mouse was clicked inside the area of the "minimise" control.
 
virtual void windowControlClickedMaximise ()
 For components that are added to the desktop, this may be called to indicate that the mouse was clicked inside the area of the "maximise" control.
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 Changes the default return value for the hitTest() method.
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 Retrieves the current state of the mouse-click interception flags.
 
bool contains (Point< int > localPoint)
 Returns true if a given point lies within this component or one of its children.
 
bool contains (Point< float > localPoint)
 Returns true if a given point lies within this component or one of its children.
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 Returns true if a given point lies in this component, taking any overlapping siblings into account.
 
bool reallyContains (Point< float > localPoint, bool returnTrueIfWithinAChild)
 Returns true if a given point lies in this component, taking any overlapping siblings into account.
 
ComponentgetComponentAt (int x, int y)
 Returns the component at a certain point within this one.
 
ComponentgetComponentAt (Point< int > position)
 Returns the component at a certain point within this one.
 
ComponentgetComponentAt (Point< float > position)
 Returns the component at a certain point within this one.
 
void repaint ()
 Marks the whole component as needing to be redrawn.
 
void repaint (int x, int y, int width, int height)
 Marks a subsection of this component as needing to be redrawn.
 
void repaint (Rectangle< int > area)
 Marks a subsection of this component as needing to be redrawn.
 
void setBufferedToImage (bool shouldBeBuffered)
 Makes the component use an internal buffer to optimise its redrawing.
 
Image createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 Generates a snapshot of part of this component.
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 Draws this component and all its subcomponents onto the specified graphics context.
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 This allows you to indicate that this component doesn't require its graphics context to be clipped when it is being painted.
 
bool isPaintingUnclipped () const noexcept
 Returns true if this component doesn't require its graphics context to be clipped when it is being painted.
 
void setComponentEffect (ImageEffectFilter *newEffect)
 Adds an effect filter to alter the component's appearance.
 
ImageEffectFiltergetComponentEffect () const noexcept
 Returns the current component effect.
 
LookAndFeelgetLookAndFeel () const noexcept
 Finds the appropriate look-and-feel to use for this component.
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 Sets the look and feel to use for this component.
 
FontOptions withDefaultMetrics (FontOptions opt) const
 Returns a copy of the FontOptions with the default metrics kind from the component's LookAndFeel.
 
virtual void lookAndFeelChanged ()
 Called to let the component react to a change in the look-and-feel setting.
 
void sendLookAndFeelChange ()
 Calls the methods repaint(), lookAndFeelChanged(), and colourChanged() in this component and all its children recursively.
 
void setOpaque (bool shouldBeOpaque)
 Indicates whether any parts of the component might be transparent.
 
bool isOpaque () const noexcept
 Returns true if no parts of this component are transparent.
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 Indicates whether the component should be brought to the front when clicked.
 
bool isBroughtToFrontOnMouseClick () const noexcept
 Indicates whether the component should be brought to the front when clicked-on.
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the focus order of this component.
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified.
 
void setFocusContainerType (FocusContainerType containerType) noexcept
 Sets whether this component is a container for components that can have their focus traversed, and the type of focus traversal that it supports.
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container.
 
bool isKeyboardFocusContainer () const noexcept
 Returns true if this component has been marked as a keyboard focus container.
 
ComponentfindFocusContainer () const
 Returns the focus container for this component.
 
ComponentfindKeyboardFocusContainer () const
 Returns the keyboard focus container for this component.
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component wants keyboard focus or not.
 
bool getWantsKeyboardFocus () const noexcept
 Returns true if the component is interested in getting keyboard focus.
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 Chooses whether a click on this component automatically grabs the focus.
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 Returns the last value set with setMouseClickGrabsKeyboardFocus().
 
void grabKeyboardFocus ()
 Tries to give keyboard focus to this component.
 
void giveAwayKeyboardFocus ()
 If this component or any of its children currently have the keyboard focus, this will defocus it, send a focus change notification, and try to pass the focus to the next component.
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 Returns true if this component currently has the keyboard focus.
 
void moveKeyboardFocusToSibling (bool moveToNext)
 Tries to move the keyboard focus to one of this component's siblings.
 
virtual std::unique_ptr< ComponentTraversercreateFocusTraverser ()
 Creates a ComponentTraverser object to determine the logic by which focus should be passed from this component.
 
virtual std::unique_ptr< ComponentTraversercreateKeyboardFocusTraverser ()
 Creates a ComponentTraverser object to use to determine the logic by which keyboard focus should be passed from this component.
 
void setHasFocusOutline (bool hasFocusOutline) noexcept
 Use this to indicate that the component should have an outline drawn around it when it has keyboard focus.
 
bool hasFocusOutline () const noexcept
 Returns true if this component should have a focus outline.
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled.
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component.
 
virtual void enablementChanged ()
 Callback to indicate that this component has been enabled or disabled.
 
float getAlpha () const noexcept
 Returns the component's current transparency level.
 
void setAlpha (float newAlpha)
 Changes the transparency of this component.
 
virtual void alphaChanged ()
 Called when setAlpha() is used to change the alpha value of this component.
 
void setMouseCursor (const MouseCursor &cursorType)
 Changes the mouse cursor shape to use when the mouse is over this component.
 
virtual MouseCursor getMouseCursor ()
 Returns the mouse cursor shape to use when the mouse is over this component.
 
void updateMouseCursor () const
 Forces the current mouse cursor to be updated.
 
virtual void paint (Graphics &g)
 Components can override this method to draw their content.
 
virtual void paintOverChildren (Graphics &g)
 Components can override this method to draw over the top of their children.
 
void mouseMove (const MouseEvent &event) override
 Called when the mouse moves inside a component.
 
void mouseEnter (const MouseEvent &event) override
 Called when the mouse first enters a component.
 
void mouseExit (const MouseEvent &event) override
 Called when the mouse moves out of a component.
 
void mouseDown (const MouseEvent &event) override
 Called when a mouse button is pressed.
 
void mouseDrag (const MouseEvent &event) override
 Called when the mouse is moved while a button is held down.
 
void mouseUp (const MouseEvent &event) override
 Called when a mouse button is released.
 
void mouseDoubleClick (const MouseEvent &event) override
 Called when a mouse button has been double-clicked on a component.
 
void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 Called when the mouse-wheel is moved.
 
void mouseMagnify (const MouseEvent &event, float scaleFactor) override
 Called when a pinch-to-zoom mouse-gesture is used.
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 Causes automatic repaints when the mouse enters or exits this component.
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 Registers a listener to be told when mouse events occur in this component.
 
void removeMouseListener (MouseListener *listenerToRemove)
 Deregisters a mouse listener.
 
void addKeyListener (KeyListener *newListener)
 Adds a listener that wants to hear about keypresses that this component receives.
 
void removeKeyListener (KeyListener *listenerToRemove)
 Removes a previously-registered key listener.
 
virtual bool keyPressed (const KeyPress &key)
 Called when a key is pressed.
 
virtual bool keyStateChanged (bool isKeyDown)
 Called when a key is pressed or released.
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 Called when a modifier key is pressed or released.
 
virtual void focusGained (FocusChangeType cause)
 Called to indicate that this component has just acquired the keyboard focus.
 
virtual void focusGainedWithDirection (FocusChangeType cause, FocusChangeDirection direction)
 Called to indicate that this component has just acquired the keyboard focus.
 
virtual void focusLost (FocusChangeType cause)
 Called to indicate that this component has just lost the keyboard focus.
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component.
 
bool isMouseButtonDown (bool includeChildren=false) const
 Returns true if the mouse button is currently held down in this component.
 
bool isMouseOverOrDragging (bool includeChildren=false) const
 True if the mouse is over this component, or if it's being dragged in this component.
 
Point< int > getMouseXYRelative () const
 Returns the mouse's current position, relative to this component.
 
virtual void resized ()
 Called when this component's size has been changed.
 
virtual void moved ()
 Called when this component's position has been changed.
 
virtual void childBoundsChanged (Component *child)
 Called when one of this component's children is moved or resized.
 
virtual void parentSizeChanged ()
 Called when this component's immediate parent has been resized.
 
virtual void broughtToFront ()
 Called when this component has been moved to the front of its siblings.
 
void addComponentListener (ComponentListener *newListener)
 Adds a listener to be told about changes to the component hierarchy or position.
 
void removeComponentListener (ComponentListener *listenerToRemove)
 Removes a component listener.
 
void postCommandMessage (int commandId)
 Dispatches a numbered message to this component.
 
virtual void handleCommandMessage (int commandId)
 Called to handle a command that was sent by postCommandMessage().
 
int runModalLoop ()
 Runs a component modally, waiting until the loop terminates.
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Puts the component into a modal state.
 
void exitModalState (int returnValue=0)
 Ends a component's modal state.
 
bool isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) const noexcept
 Returns true if this component is the modal one.
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 Checks whether there's a modal component somewhere that's stopping this one from receiving messages.
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 When a component is modal, this callback allows it to choose which other components can still receive events.
 
virtual void inputAttemptWhenModal ()
 Called when the user tries to click on a component that is blocked by another modal component.
 
NamedValueSetgetProperties () noexcept
 Returns the set of properties that belong to this component.
 
const NamedValueSetgetProperties () const noexcept
 Returns the set of properties that belong to this component.
 
Colour findColour (int colourID, bool inheritFromParent=false) const
 Looks for a colour that has been registered with the given colour ID number.
 
void setColour (int colourID, Colour newColour)
 Registers a colour to be used for a particular purpose.
 
void removeColour (int colourID)
 If a colour has been set with setColour(), this will remove it.
 
bool isColourSpecified (int colourID) const
 Returns true if the specified colour ID has been explicitly set for this component using the setColour() method.
 
void copyAllExplicitColoursTo (Component &target) const
 This looks for any colours that have been specified for this component, and copies them to the specified target component.
 
virtual void colourChanged ()
 This method is called when a colour is changed by the setColour() method, or when the look-and-feel is changed by the setLookAndFeel() or sendLookAndFeelChanged() methods.
 
void * getWindowHandle () const
 Returns the underlying native window handle for this component.
 
PositionergetPositioner () const noexcept
 Returns the Positioner object that has been set for this component.
 
void setPositioner (Positioner *newPositioner)
 Sets a new Positioner object for this component.
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 Gives the component a CachedComponentImage that should be used to buffer its painting.
 
CachedComponentImagegetCachedComponentImage () const noexcept
 Returns the object that was set by setCachedComponentImage().
 
void setViewportIgnoreDragFlag (bool ignoreDrag) noexcept
 Sets a flag to indicate whether mouse drag events on this Component should be ignored when it is inside a Viewport with drag-to-scroll functionality enabled.
 
bool getViewportIgnoreDragFlag () const noexcept
 Retrieves the current state of the Viewport drag-to-scroll functionality flag.
 
String getTitle () const noexcept
 Returns the title text for this component.
 
void setTitle (const String &newTitle)
 Sets the title for this component.
 
String getDescription () const noexcept
 Returns the description for this component.
 
void setDescription (const String &newDescription)
 Sets the description for this component.
 
String getHelpText () const noexcept
 Returns the help text for this component.
 
void setHelpText (const String &newHelpText)
 Sets the help text for this component.
 
void setAccessible (bool shouldBeAccessible)
 Sets whether this component and its children are visible to accessibility clients.
 
bool isAccessible () const noexcept
 Returns true if this component and its children are visible to accessibility clients.
 
AccessibilityHandlergetAccessibilityHandler ()
 Returns the accessibility handler for this component, or nullptr if this component is not accessible.
 
void invalidateAccessibilityHandler ()
 Invalidates the AccessibilityHandler that is currently being used for this component.
 
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()=default
 Destructor.
 

Static Public Member Functions

static int getNumTopLevelWindows () noexcept
 Returns the number of TopLevelWindow objects currently in use.
 
static TopLevelWindowgetTopLevelWindow (int index) noexcept
 Returns one of the TopLevelWindow objects currently in use.
 
static TopLevelWindowgetActiveTopLevelWindow () noexcept
 Returns the currently-active top level window.
 
- Static Public Member Functions inherited from Component
static float JUCE_CALLTYPE getApproximateScaleFactorForComponent (const Component *targetComponent)
 Returns the approximate scale factor for a given component by traversing its parent hierarchy and applying each transform and finally scaling this by the global scale factor.
 
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
 Returns the component that currently has the keyboard focus.
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 If any component has keyboard focus, this will defocus it.
 
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks)
 Ensures that a non-stop stream of mouse-drag events will be sent during the current mouse-drag operation.
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 Returns true if a mouse button is currently down.
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 Returns the number of components that are currently in a modal state.
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 Returns one of the components that are currently modal.
 

Protected Member Functions

virtual void activeWindowStatusChanged ()
 This callback happens when this window becomes active or inactive.
 
void focusOfChildComponentChanged (FocusChangeType) override
 Called to indicate a change in whether or not this component is the parent of the currently-focused component.
 
void parentHierarchyChanged () override
 Called to indicate that the component's parents have changed.
 
virtual int getDesktopWindowStyleFlags () const
 
void recreateDesktopWindow ()
 
void visibilityChanged () override
 Called when this component's visibility changes.
 

Additional Inherited Members

- Public Types inherited from Component
enum class  WindowControlKind {
  client , caption , minimise , maximise ,
  close , sizeTop , sizeLeft , sizeRight ,
  sizeBottom , sizeTopLeft , sizeTopRight , sizeBottomLeft ,
  sizeBottomRight
}
 Types of control that are commonly found in windows, especially title-bars. More...
 
enum class  FocusContainerType { none , focusContainer , keyboardFocusContainer }
 A focus container type that can be passed to setFocusContainerType(). More...
 
enum  FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly }
 Enumeration used by the focusGained() and focusLost() methods. More...
 
enum class  FocusChangeDirection { unknown , forward , backward }
 Enumeration used by the focusGainedWithDirection() method. More...
 

Detailed Description

A base class for top-level windows.

This class is used for components that are considered a major part of your application - e.g. ResizableWindow, DocumentWindow, DialogWindow, AlertWindow, etc. Things like menus that pop up briefly aren't derived from it.

A TopLevelWindow is probably on the desktop, but this isn't mandatory - it could itself be the child of another component.

The class manages a list of all instances of top-level windows that are in use, and each one is also given the concept of being "active". The active window is one that is actively being used by the user. This isn't quite the same as the component with the keyboard focus, because there may be a popup menu or other temporary window which gets keyboard focus while the active top level window is unchanged.

A top-level window also has an optional drop-shadow.

See also
ResizableWindow, DocumentWindow, DialogWindow

Constructor & Destructor Documentation

◆ TopLevelWindow()

TopLevelWindow::TopLevelWindow ( const String & name,
bool addToDesktop )

Creates a TopLevelWindow.

Parameters
namethe name to give the component
addToDesktopif true, the window will be automatically added to the desktop; if false, you can use it as a child component

◆ ~TopLevelWindow()

TopLevelWindow::~TopLevelWindow ( )
override

Destructor.

Member Function Documentation

◆ isActiveWindow()

bool TopLevelWindow::isActiveWindow ( ) const
noexcept

True if this is currently the TopLevelWindow that is actively being used.

This isn't quite the same as having keyboard focus, because the focus may be on a child component or a temporary pop-up menu, etc, while this window is still considered to be active.

See also
activeWindowStatusChanged

◆ centreAroundComponent()

void TopLevelWindow::centreAroundComponent ( Component * componentToCentreAround,
int width,
int height )

This will set the bounds of the window so that it's centred in front of another window.

If your app has a few windows open and want to pop up a dialog box for one of them, you can use this to show it in front of the relevant parent window, which is a bit neater than just having it appear in the middle of the screen.

If componentToCentreAround is nullptr, then the currently active TopLevelWindow will be used instead. If no window is focused, it'll just default to the middle of the screen.

◆ setDropShadowEnabled()

void TopLevelWindow::setDropShadowEnabled ( bool useShadow)

Turns the drop-shadow on and off.

◆ isDropShadowEnabled()

bool TopLevelWindow::isDropShadowEnabled ( ) const
noexcept

True if drop-shadowing is enabled.

◆ setUsingNativeTitleBar()

void TopLevelWindow::setUsingNativeTitleBar ( bool useNativeTitleBar)

Sets whether an OS-native title bar will be used, or a JUCE one.

See also
isUsingNativeTitleBar

◆ isUsingNativeTitleBar()

bool TopLevelWindow::isUsingNativeTitleBar ( ) const
noexcept

Returns true if the window is currently using an OS-native title bar.

See also
setUsingNativeTitleBar

◆ getNumTopLevelWindows()

static int TopLevelWindow::getNumTopLevelWindows ( )
staticnoexcept

Returns the number of TopLevelWindow objects currently in use.

See also
getTopLevelWindow

◆ getTopLevelWindow()

static TopLevelWindow * TopLevelWindow::getTopLevelWindow ( int index)
staticnoexcept

Returns one of the TopLevelWindow objects currently in use.

The index is 0 to (getNumTopLevelWindows() - 1).

◆ getActiveTopLevelWindow()

static TopLevelWindow * TopLevelWindow::getActiveTopLevelWindow ( )
staticnoexcept

Returns the currently-active top level window.

There might not be one, of course, so this can return nullptr.

◆ addToDesktop() [1/2]

void TopLevelWindow::addToDesktop ( )

Adds the window to the desktop using the default flags.

◆ addToDesktop() [2/2]

void TopLevelWindow::addToDesktop ( int windowStyleFlags,
void * nativeWindowToAttachTo = nullptr )
overridevirtual

Makes this component appear as a window on the desktop.

Note that before calling this, you should make sure that the component's opacity is set correctly using setOpaque(). If the component is non-opaque, the windowing system will try to create a special transparent window for it, which will generally take a lot more CPU to operate (and might not even be possible on some platforms).

If the component is inside a parent component at the time this method is called, it will first be removed from that parent. Likewise if a component is on the desktop and is subsequently added to another component, it'll be removed from the desktop.

Parameters
windowStyleFlagsa combination of the flags specified in the ComponentPeer::StyleFlags enum, which define the window's characteristics.
nativeWindowToAttachTothis allows an OS object to be passed-in as the window in which the juce component should place itself. On Windows, this would be a HWND, a HIViewRef on the Mac. Not necessarily supported on all platforms, and best left as 0 unless you know what you're doing.
See also
removeFromDesktop, isOnDesktop, userTriedToCloseWindow, getPeer, ComponentPeer::setMinimised, ComponentPeer::StyleFlags, ComponentPeer::getStyleFlags, ComponentPeer::setFullScreen

Reimplemented from Component.

◆ createAccessibilityHandler()

std::unique_ptr< AccessibilityHandler > TopLevelWindow::createAccessibilityHandler ( )
overridevirtual

Override this method to return a custom AccessibilityHandler for this component.

The default implementation creates and returns a AccessibilityHandler object with an unspecified role, meaning that it will be visible to accessibility clients but without a specific role, action callbacks or interfaces. To control how accessibility clients see and interact with your component subclass AccessibilityHandler, implement the desired behaviours, and return an instance of it from this method in your component subclass.

The accessibility handler you return here is guaranteed to be destroyed before its Component, so it's safe to store and use a reference back to the Component inside the AccessibilityHandler if necessary.

This function should rarely be called directly. If you need to query a component's accessibility handler, it's normally better to call getAccessibilityHandler(). The exception to this rule is derived implementations of createAccessibilityHandler(), which may find it useful to call the base class implementation, and then wrap or modify the result.

See also
getAccessibilityHandler

Reimplemented from Component.

◆ activeWindowStatusChanged()

virtual void TopLevelWindow::activeWindowStatusChanged ( )
protectedvirtual

This callback happens when this window becomes active or inactive.

See also
isActiveWindow

Reimplemented in MultiDocumentPanelWindow, and ResizableWindow.

◆ focusOfChildComponentChanged()

void TopLevelWindow::focusOfChildComponentChanged ( FocusChangeType cause)
overrideprotectedvirtual

Called to indicate a change in whether or not this component is the parent of the currently-focused component.

Essentially this is called when the return value of a call to hasKeyboardFocus (true) has changed. It happens when focus moves from one of this component's children (at any depth) to a component that isn't contained in this one, (or vice-versa). Note that this method does NOT get called to when focus simply moves from one of its child components to another.

See also
focusGained, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus

Reimplemented from Component.

◆ parentHierarchyChanged()

void TopLevelWindow::parentHierarchyChanged ( )
overrideprotectedvirtual

Called to indicate that the component's parents have changed.

When a component is added or removed from its parent, this method will be called on all of its children (recursively - so all children of its children will also be called as well).

Subclasses can override this if they need to react to this in some way.

See also
getParentComponent, isShowing, ComponentListener::componentParentHierarchyChanged

Reimplemented from Component.

◆ getDesktopWindowStyleFlags()

virtual int TopLevelWindow::getDesktopWindowStyleFlags ( ) const
protectedvirtual

Reimplemented in AlertWindow, and ResizableWindow.

◆ recreateDesktopWindow()

void TopLevelWindow::recreateDesktopWindow ( )
protected

◆ visibilityChanged()

void TopLevelWindow::visibilityChanged ( )
overrideprotectedvirtual

Called when this component's visibility changes.

See also
setVisible, isVisible

Reimplemented from Component.


The documentation for this class was generated from the following file:
linkedin facebook pinterest youtube rss twitter instagram facebook-blank rss-blank linkedin-blank pinterest youtube twitter instagram