allanger/paulxstretch
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases 2 Activity
c6ffc776ea
paulxstretch/deps/juce/modules/juce_gui_basics/components/juce_Component.h
essej 25bd5d8adb git subrepo clone --branch=sono6good https://github.com/essej/JUCE.git deps/juce 
subrepo:
  subdir:   "deps/juce"
  merged:   "b13f9084e"
upstream:
  origin:   "https://github.com/essej/JUCE.git"
  branch:   "sono6good"
  commit:   "b13f9084e"
git-subrepo:
  version:  "0.4.3"
  origin:   "https://github.com/ingydotnet/git-subrepo.git"
  commit:   "2f68596"
2022-04-18 17:51:22 -04:00

2599 lines
120 KiB
C++
Raw Blame History

/*
==============================================================================
This file is part of the JUCE library.
Copyright (c) 2020 - Raw Material Software Limited
JUCE is an open source library subject to commercial or open-source
licensing.
By using JUCE, you agree to the terms of both the JUCE 6 End-User License
Agreement and JUCE Privacy Policy (both effective as of the 16th June 2020).
End User License Agreement: www.juce.com/juce-6-licence
Privacy Policy: www.juce.com/juce-privacy-policy
Or: You may also use this code under the terms of the GPL v3 (see
www.gnu.org/licenses).
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
DISCLAIMED.
==============================================================================
*/
namespace juce
{
//==============================================================================
/**
The base class for all JUCE user-interface objects.
@tags{GUI}
*/
class JUCE_API Component : public MouseListener
{
public:
//==============================================================================
/** Creates a component.
To get it to actually appear, you'll also need to:
- Either add it to a parent component or use the addToDesktop() method to
make it a desktop window
- Set its size and position to something sensible
- Use setVisible() to make it visible
And for it to serve any useful purpose, you'll need to write a
subclass of Component or use one of the other types of component from
the library.
*/
Component() noexcept;
/** Destructor.
Note that when a component is deleted, any child components it contains are NOT
automatically deleted. It's your responsibility to manage their lifespan - you
may want to use helper methods like deleteAllChildren(), or less haphazard
approaches like using std::unique_ptrs or normal object aggregation to manage them.
If the component being deleted is currently the child of another one, then during
deletion, it will be removed from its parent, and the parent will receive a childrenChanged()
callback. Any ComponentListener objects that have registered with it will also have their
ComponentListener::componentBeingDeleted() methods called.
*/
~Component() override;
//==============================================================================
/** Creates a component, setting its name at the same time.
@see getName, setName
*/
explicit Component (const String& componentName) noexcept;
/** Returns the name of this component.
@see setName
*/
String getName() const noexcept { return componentName; }
/** Sets the name of this component.
When the name changes, all registered ComponentListeners will receive a
ComponentListener::componentNameChanged() callback.
@see getName
*/
virtual void setName (const String& newName);
/** Returns the ID string that was set by setComponentID().
@see setComponentID, findChildWithID
*/
String getComponentID() const noexcept { return componentID; }
/** Sets the component's ID string.
You can retrieve the ID using getComponentID().
@see getComponentID, findChildWithID
*/
void setComponentID (const String& newID);
//==============================================================================
/** Makes the component visible or invisible.
This method will show or hide the component.
Note that components default to being non-visible when first created.
Also note that visible components won't be seen unless all their parent components
are also visible.
This method will call visibilityChanged() and also componentVisibilityChanged()
for any component listeners that are interested in this component.
@param shouldBeVisible whether to show or hide the component
@see isVisible, isShowing, visibilityChanged, ComponentListener::componentVisibilityChanged
*/
virtual void setVisible (bool shouldBeVisible);
/** Tests whether the component is visible or not.
this doesn't necessarily tell you whether this comp is actually on the screen
because this depends on whether all the parent components are also visible - use
isShowing() to find this out.
@see isShowing, setVisible
*/
bool isVisible() const noexcept { return flags.visibleFlag; }
/** Called when this component's visibility changes.
@see setVisible, isVisible
*/
virtual void visibilityChanged();
/** Tests whether this component and all its parents are visible.
@returns true only if this component and all its parents are visible.
@see isVisible
*/
bool isShowing() const;
//==============================================================================
/** 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.
@param windowStyleFlags a combination of the flags specified in the
ComponentPeer::StyleFlags enum, which define the
window's characteristics.
@param nativeWindowToAttachTo this 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 removeFromDesktop, isOnDesktop, userTriedToCloseWindow,
getPeer, ComponentPeer::setMinimised, ComponentPeer::StyleFlags,
ComponentPeer::getStyleFlags, ComponentPeer::setFullScreen
*/
virtual void addToDesktop (int windowStyleFlags,
void* nativeWindowToAttachTo = nullptr);
/** If the component is currently showing on the desktop, this will hide it.
You can also use setVisible() to hide a desktop window temporarily, but
removeFromDesktop() will free any system resources that are being used up.
@see addToDesktop, isOnDesktop
*/
void removeFromDesktop();
/** Returns true if this component is currently showing on the desktop.
@see addToDesktop, removeFromDesktop
*/
bool isOnDesktop() const noexcept;
/** Returns the heavyweight window that contains this component.
If this component is itself on the desktop, this will return the window
object that it is using. Otherwise, it will return the window of
its top-level parent component.
This may return nullptr if there isn't a desktop component.
@see addToDesktop, isOnDesktop
*/
ComponentPeer* getPeer() const;
/** For components on the desktop, this is called if the system wants to close the window.
This is a signal that either the user or the system wants the window to close. The
default implementation of this method will trigger an assertion to warn you that your
component should do something about it, but you can override this to ignore the event
if you want.
*/
virtual void userTriedToCloseWindow();
/** Called for a desktop component which has just been minimised or un-minimised.
This will only be called for components on the desktop.
@see getPeer, ComponentPeer::setMinimised, ComponentPeer::isMinimised
*/
virtual void minimisationStateChanged (bool isNowMinimised);
/** Returns the default scale factor to use for this component when it is placed
on the desktop.
The default implementation of this method just returns the value from
Desktop::getGlobalScaleFactor(), but it can be overridden if a particular component
has different requirements. The method only used if this component is added
to the desktop - it has no effect for child components.
*/
virtual float getDesktopScaleFactor() const;
//==============================================================================
/** Brings the component to the front of its siblings.
If some of the component's siblings have had their 'always-on-top' flag set,
then they will still be kept in front of this one (unless of course this
one is also 'always-on-top').
@param shouldAlsoGainKeyboardFocus if true, this will also try to assign
keyboard focus to the component (see
grabKeyboardFocus() for more details)
@see toBack, toBehind, setAlwaysOnTop
*/
void toFront (bool shouldAlsoGainKeyboardFocus);
/** Changes this component's z-order to be at the back of all its siblings.
If the component is set to be 'always-on-top', it will only be moved to the
back of the other other 'always-on-top' components.
@see toFront, toBehind, setAlwaysOnTop
*/
void toBack();
/** Changes this component's z-order so that it's just behind another component.
@see toFront, toBack
*/
void toBehind (Component* other);
/** Sets whether the component should always be kept at the front of its siblings.
@see isAlwaysOnTop
*/
void setAlwaysOnTop (bool shouldStayOnTop);
/** Returns true if this component is set to always stay in front of its siblings.
@see setAlwaysOnTop
*/
bool isAlwaysOnTop() const noexcept;
//==============================================================================
/** Returns the x coordinate of the component's left edge.
This is a distance in pixels from the left edge of the component's parent.
Note that if you've used setTransform() to apply a transform, then the component's
bounds will no longer be a direct reflection of the position at which it appears within
its parent, as the transform will be applied to its bounding box.
*/
int getX() const noexcept { return boundsRelativeToParent.getX(); }
/** Returns the y coordinate of the top of this component.
This is a distance in pixels from the top edge of the component's parent.
Note that if you've used setTransform() to apply a transform, then the component's
bounds will no longer be a direct reflection of the position at which it appears within
its parent, as the transform will be applied to its bounding box.
*/
int getY() const noexcept { return boundsRelativeToParent.getY(); }
/** Returns the component's width in pixels. */
int getWidth() const noexcept { return boundsRelativeToParent.getWidth(); }
/** Returns the component's height in pixels. */
int getHeight() const noexcept { return boundsRelativeToParent.getHeight(); }
/** Returns the x coordinate of the component's right-hand edge.
This is a distance in pixels from the left edge of the component's parent.
Note that if you've used setTransform() to apply a transform, then the component's
bounds will no longer be a direct reflection of the position at which it appears within
its parent, as the transform will be applied to its bounding box.
*/
int getRight() const noexcept { return boundsRelativeToParent.getRight(); }
/** Returns the component's top-left position as a Point. */
Point<int> getPosition() const noexcept { return boundsRelativeToParent.getPosition(); }
/** Returns the y coordinate of the bottom edge of this component.
This is a distance in pixels from the top edge of the component's parent.
Note that if you've used setTransform() to apply a transform, then the component's
bounds will no longer be a direct reflection of the position at which it appears within
its parent, as the transform will be applied to its bounding box.
*/
int getBottom() const noexcept { return boundsRelativeToParent.getBottom(); }
/** Returns this component's bounding box.
The rectangle returned is relative to the top-left of the component's parent.
Note that if you've used setTransform() to apply a transform, then the component's
bounds will no longer be a direct reflection of the position at which it appears within
its parent, as the transform will be applied to its bounding box.
*/
Rectangle<int> getBounds() const noexcept { return boundsRelativeToParent; }
/** Returns the component's bounds, relative to its own origin.
This is like getBounds(), but returns the rectangle in local coordinates, In practice, it'll
return a rectangle with position (0, 0), and the same size as this component.
*/
Rectangle<int> getLocalBounds() const noexcept;
/** Returns the area of this component's parent which this component covers.
The returned area is relative to the parent's coordinate space.
If the component has an affine transform specified, then the resulting area will be
the smallest rectangle that fully covers the component's transformed bounding box.
If this component has no parent, the return value will simply be the same as getBounds().
*/
Rectangle<int> getBoundsInParent() const noexcept;
//==============================================================================
/** Returns this component's x coordinate relative the screen's top-left origin.
@see getX, localPointToGlobal
*/
int getScreenX() const;
/** Returns this component's y coordinate relative the screen's top-left origin.
@see getY, localPointToGlobal
*/
int getScreenY() const;
/** Returns the position of this component's top-left corner relative to the screen's top-left.
@see getScreenBounds
*/
Point<int> getScreenPosition() const;
/** Returns the bounds of this component, relative to the screen's top-left.
@see getScreenPosition
*/
Rectangle<int> getScreenBounds() const;
/** Converts a point to be relative to this component's coordinate space.
This takes a point relative to a different component, and returns its position relative to this
component. If the sourceComponent parameter is null, the source point is assumed to be a global
screen coordinate.
*/
Point<int> getLocalPoint (const Component* sourceComponent,
Point<int> pointRelativeToSourceComponent) const;
/** Converts a point to be relative to this component's coordinate space.
This takes a point relative to a different component, and returns its position relative to this
component. If the sourceComponent parameter is null, the source point is assumed to be a global
screen coordinate.
*/
Point<float> getLocalPoint (const Component* sourceComponent,
Point<float> pointRelativeToSourceComponent) const;
/** Converts a rectangle to be relative to this component's coordinate space.
This takes a rectangle that is relative to a different component, and returns its position relative
to this component. If the sourceComponent parameter is null, the source rectangle is assumed to be
a screen coordinate.
If you've used setTransform() to apply one or more transforms to components, then the source rectangle
may not actually be rectangular when converted to the target space, so in that situation this will return
the smallest rectangle that fully contains the transformed area.
*/
Rectangle<int> getLocalArea (const Component* sourceComponent,
Rectangle<int> areaRelativeToSourceComponent) const;
/** Converts a rectangle to be relative to this component's coordinate space.
This takes a rectangle that is relative to a different component, and returns its position relative
to this component. If the sourceComponent parameter is null, the source rectangle is assumed to be
a screen coordinate.
If you've used setTransform() to apply one or more transforms to components, then the source rectangle
may not actually be rectangular when converted to the target space, so in that situation this will return
the smallest rectangle that fully contains the transformed area.
*/
Rectangle<float> getLocalArea (const Component* sourceComponent,
Rectangle<float> areaRelativeToSourceComponent) const;
/** Converts a point relative to this component's top-left into a screen coordinate.
@see getLocalPoint, localAreaToGlobal
*/
Point<int> localPointToGlobal (Point<int> localPoint) const;
/** Converts a point relative to this component's top-left into a screen coordinate.
@see getLocalPoint, localAreaToGlobal
*/
Point<float> localPointToGlobal (Point<float> localPoint) const;
/** Converts a rectangle from this component's coordinate space to a screen coordinate.
If you've used setTransform() to apply one or more transforms to components, then the source rectangle
may not actually be rectangular when converted to the target space, so in that situation this will return
the smallest rectangle that fully contains the transformed area.
@see getLocalPoint, localPointToGlobal
*/
Rectangle<int> localAreaToGlobal (Rectangle<int> localArea) const;
/** Converts a rectangle from this component's coordinate space to a screen coordinate.
If you've used setTransform() to apply one or more transforms to components, then the source rectangle
may not actually be rectangular when converted to the target space, so in that situation this will return
the smallest rectangle that fully contains the transformed area.
@see getLocalPoint, localPointToGlobal
*/
Rectangle<float> localAreaToGlobal (Rectangle<float> localArea) const;
//==============================================================================
/** Moves the component to a new position.
Changes the component's top-left position (without changing its size).
The position is relative to the top-left of the component's parent.
If the component actually moves, this method will make a synchronous call to moved().
Note that if you've used setTransform() to apply a transform, then the component's
bounds will no longer be a direct reflection of the position at which it appears within
its parent, as the transform will be applied to whatever bounds you set for it.
@see setBounds, ComponentListener::componentMovedOrResized
*/
void setTopLeftPosition (int x, int y);
/** Moves the component to a new position.
Changes the component's top-left position (without changing its size).
The position is relative to the top-left of the component's parent.
If the component actually moves, this method will make a synchronous call to moved().
Note that if you've used setTransform() to apply a transform, then the component's
bounds will no longer be a direct reflection of the position at which it appears within
its parent, as the transform will be applied to whatever bounds you set for it.
@see setBounds, ComponentListener::componentMovedOrResized
*/
void setTopLeftPosition (Point<int> newTopLeftPosition);
/** Moves the component to a new position.
Changes the position of the component's top-right corner (keeping it the same size).
The position is relative to the top-left of the component's parent.
If the component actually moves, this method will make a synchronous call to moved().
Note that if you've used setTransform() to apply a transform, then the component's
bounds will no longer be a direct reflection of the position at which it appears within
its parent, as the transform will be applied to whatever bounds you set for it.
*/
void setTopRightPosition (int x, int y);
/** Changes the size of the component.
A synchronous call to resized() will occur if the size actually changes.
Note that if you've used setTransform() to apply a transform, then the component's
bounds will no longer be a direct reflection of the position at which it appears within
its parent, as the transform will be applied to whatever bounds you set for it.
*/
void setSize (int newWidth, int newHeight);
/** Changes the component's position and size.
The coordinates are relative to the top-left of the component's parent, or relative
to the origin of the screen if the component is on the desktop.
If this method changes the component's top-left position, it will make a synchronous
call to moved(). If it changes the size, it will also make a call to resized().
Note that if you've used setTransform() to apply a transform, then the component's
bounds will no longer be a direct reflection of the position at which it appears within
its parent, as the transform will be applied to whatever bounds you set for it.
@see setTopLeftPosition, setSize, ComponentListener::componentMovedOrResized
*/
void setBounds (int x, int y, int width, int height);
/** Changes the component's position and size.
The coordinates are relative to the top-left of the component's parent, or relative
to the origin of the screen if the component is on the desktop.
If this method changes the component's top-left position, it will make a synchronous
call to moved(). If it changes the size, it will also make a call to resized().
Note that if you've used setTransform() to apply a transform, then the component's
bounds will no longer be a direct reflection of the position at which it appears within
its parent, as the transform will be applied to whatever bounds you set for it.
@see setBounds
*/
void setBounds (Rectangle<int> newBounds);
/** Changes the component's position and size in terms of fractions of its parent's size.
The values are factors of the parent's size, so for example
setBoundsRelative (0.2f, 0.2f, 0.5f, 0.5f) would give it half the
width and height of the parent, with its top-left position 20% of
the way across and down the parent.
@see setBounds
*/
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.
The values are factors of the parent's size, so for example
setBoundsRelative ({ 0.2f, 0.2f, 0.5f, 0.5f }) would give it half the
width and height of the parent, with its top-left position 20% of
the way across and down the parent.
@see setBounds
*/
void setBoundsRelative (Rectangle<float> proportionalArea);
/** Changes the component's position and size based on the amount of space to leave around it.
This will position the component within its parent, leaving the specified number of
pixels around each edge.
@see setBounds
*/
void setBoundsInset (BorderSize<int> borders);
/** Positions the component within a given rectangle, keeping its proportions
unchanged.
If onlyReduceInSize is false, the component will be resized to fill as much of the
rectangle as possible without changing its aspect ratio (the component's
current size is used to determine its aspect ratio, so a zero-size component
won't work here). If onlyReduceInSize is true, it will only be resized if it's
too big to fit inside the rectangle.
It will then be positioned within the rectangle according to the justification flags
specified.
@see setBounds
*/
void setBoundsToFit (Rectangle<int> targetArea,
Justification justification,
bool onlyReduceInSize);
/** Changes the position of the component's centre.
Leaves the component's size unchanged, but sets the position of its centre
relative to its parent's top-left.
@see setBounds
*/
void setCentrePosition (int x, int y);
/** Changes the position of the component's centre.
Leaves the component's size unchanged, but sets the position of its centre
relative to its parent's top-left.
@see setBounds
*/
void setCentrePosition (Point<int> newCentrePosition);
/** Changes the position of the component's centre.
Leaves the size unchanged, but positions its centre relative to its parent's size.
E.g. setCentreRelative (0.5f, 0.5f) would place it centrally in its parent.
*/
void setCentreRelative (float x, float y);
/** Changes the component's size and centres it within its parent.
After changing the size, the component will be moved so that it's
centred within its parent. If the component is on the desktop (or has no
parent component), then it'll be centred within the main monitor area.
*/
void centreWithSize (int width, int height);
//==============================================================================
/** Sets a transform matrix to be applied to this component.
If you set a transform for a component, the component's position will be warped by it, relative to
the component's parent's top-left origin. This means that the values you pass into setBounds() will no
longer reflect the actual area within the parent that the component covers, as the bounds will be
transformed and the component will probably end up actually appearing somewhere else within its parent.
When using transforms you need to be extremely careful when converting coordinates between the
coordinate spaces of different components or the screen - you should always use getLocalPoint(),
getLocalArea(), etc to do this, and never just manually add a component's position to a point in order to
convert it between different components (but I'm sure you would never have done that anyway...).
Currently, transforms are not supported for desktop windows, so the transform will be ignored if you
put a component on the desktop.
To remove a component's transform, simply pass AffineTransform() as the parameter to this method.
*/
void setTransform (const AffineTransform& transform);
/** Returns the transform that is currently being applied to this component.
For more details about transforms, see setTransform().
@see setTransform
*/
AffineTransform getTransform() const;
/** Returns true if a non-identity transform is being applied to this component.
For more details about transforms, see setTransform().
@see setTransform
*/
bool isTransformed() const noexcept;
/** 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 float JUCE_CALLTYPE getApproximateScaleFactorForComponent (Component* targetComponent);
//==============================================================================
/** Returns a proportion of the component's width.
This is a handy equivalent of (getWidth() * proportion).
*/
int proportionOfWidth (float proportion) const noexcept;
/** Returns a proportion of the component's height.
This is a handy equivalent of (getHeight() * proportion).
*/
int proportionOfHeight (float proportion) const noexcept;
/** Returns the width of the component's parent.
If the component has no parent (i.e. if it's on the desktop), this will return
the width of the screen.
*/
int getParentWidth() const noexcept;
/** Returns the height of the component's parent.
If the component has no parent (i.e. if it's on the desktop), this will return
the height of the screen.
*/
int getParentHeight() const noexcept;
/** Returns the screen coordinates of the monitor that contains this component.
If there's only one monitor, this will return its size - if there are multiple
monitors, it will return the area of the monitor that contains the component's
centre.
*/
Rectangle<int> getParentMonitorArea() const;
//==============================================================================
/** Returns the number of child components that this component contains.
@see getChildren, getChildComponent, getIndexOfChildComponent
*/
int getNumChildComponents() const noexcept;
/** Returns one of this component's child components, by it index.
The component with index 0 is at the back of the z-order, the one at the
front will have index (getNumChildComponents() - 1).
If the index is out-of-range, this will return a null pointer.
@see getChildren, getNumChildComponents, getIndexOfChildComponent
*/
Component* getChildComponent (int index) const noexcept;
/** Returns the index of this component in the list of child components.
A value of 0 means it is first in the list (i.e. behind all other components). Higher
values are further towards the front.
Returns -1 if the component passed-in is not a child of this component.
@see getChildren, getNumChildComponents, getChildComponent, addChildComponent, toFront, toBack, toBehind
*/
int getIndexOfChildComponent (const Component* child) const noexcept;
/** Provides access to the underlying array of child components.
The most likely reason you may want to use this is for iteration in a range-based for loop.
*/
const Array<Component*>& getChildren() const noexcept { return childComponentList; }
/** Looks for a child component with the specified ID.
@see setComponentID, getComponentID
*/
Component* findChildWithID (StringRef componentID) const noexcept;
/** Adds a child component to this one.
Adding a child component does not mean that the component will own or delete the child - it's
your responsibility to delete the component. Note that it's safe to delete a component
without first removing it from its parent - doing so will automatically remove it and
send out the appropriate notifications before the deletion completes.
If the child is already a child of this component, then no action will be taken, and its
z-order will be left unchanged.
@param child the new component to add. If the component passed-in is already
the child of another component, it'll first be removed from its current parent.
@param zOrder The index in the child-list at which this component should be inserted.
A value of -1 will insert it in front of the others, 0 is the back.
@see removeChildComponent, addAndMakeVisible, addChildAndSetID, getChild, ComponentListener::componentChildrenChanged
*/
void addChildComponent (Component* child, int zOrder = -1);
/** Adds a child component to this one.
Adding a child component does not mean that the component will own or delete the child - it's
your responsibility to delete the component. Note that it's safe to delete a component
without first removing it from its parent - doing so will automatically remove it and
send out the appropriate notifications before the deletion completes.
If the child is already a child of this component, then no action will be taken, and its
z-order will be left unchanged.
@param child the new component to add. If the component passed-in is already
the child of another component, it'll first be removed from its current parent.
@param zOrder The index in the child-list at which this component should be inserted.
A value of -1 will insert it in front of the others, 0 is the back.
@see removeChildComponent, addAndMakeVisible, addChildAndSetID, getChild, ComponentListener::componentChildrenChanged
*/
void addChildComponent (Component& child, int zOrder = -1);
/** Adds a child component to this one, and also makes the child visible if it isn't already.
This is the same as calling setVisible (true) on the child and then addChildComponent().
See addChildComponent() for more details.
@param child the new component to add. If the component passed-in is already
the child of another component, it'll first be removed from its current parent.
@param zOrder The index in the child-list at which this component should be inserted.
A value of -1 will insert it in front of the others, 0 is the back.
*/
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.
This is the same as calling setVisible (true) on the child and then addChildComponent().
See addChildComponent() for more details.
@param child the new component to add. If the component passed-in is already
the child of another component, it'll first be removed from its current parent.
@param zOrder The index in the child-list at which this component should be inserted.
A value of -1 will insert it in front of the others, 0 is the back.
*/
void addAndMakeVisible (Component& child, int zOrder = -1);
/** Adds a child component to this one, makes it visible, and sets its component ID.
@see addAndMakeVisible, addChildComponent
*/
void addChildAndSetID (Component* child, const String& componentID);
/** Removes one of this component's child-components.
If the child passed-in isn't actually a child of this component (either because
it's invalid or is the child of a different parent), then no action is taken.
Note that removing a child will not delete it! But it's ok to delete a component
without first removing it - doing so will automatically remove it and send out the
appropriate notifications before the deletion completes.
@see addChildComponent, ComponentListener::componentChildrenChanged
*/
void removeChildComponent (Component* childToRemove);
/** Removes one of this component's child-components by index.
This will return a pointer to the component that was removed, or null if
the index was out-of-range.
Note that removing a child will not delete it! But it's ok to delete a component
without first removing it - doing so will automatically remove it and send out the
appropriate notifications before the deletion completes.
@see addChildComponent, ComponentListener::componentChildrenChanged
*/
Component* removeChildComponent (int childIndexToRemove);
/** Removes all this component's children.
Note that this won't delete them! To do that, use deleteAllChildren() instead.
*/
void removeAllChildren();
/** Removes and deletes all of this component's children.
My advice is to avoid this method! It's an old function that is only kept here for
backwards-compatibility with legacy code, and should be viewed with extreme
suspicion by anyone attempting to write modern C++. In almost all cases, it's much
smarter to manage the lifetimes of your child components via modern RAII techniques
such as simply making them member variables, or using std::unique_ptr, OwnedArray,
etc to manage their lifetimes appropriately.
@see removeAllChildren
*/
void deleteAllChildren();
/** Returns the component which this component is inside.
If this is the highest-level component or hasn't yet been added to
a parent, this will return null.
*/
Component* getParentComponent() const noexcept { return parentComponent; }
/** Searches the parent components for a component of a specified class.
For example findParentComponentOfClass \<MyComp\>() would return the first parent
component that can be dynamically cast to a MyComp, or will return nullptr if none
of the parents are suitable.
*/
template <class TargetClass>
TargetClass* findParentComponentOfClass() const
{
for (auto* p = parentComponent; p != nullptr; p = p->parentComponent)
if (auto* target = dynamic_cast<TargetClass*> (p))
return target;
return nullptr;
}
/** Returns the highest-level component which contains this one or its parents.
This will search upwards in the parent-hierarchy from this component, until it
finds the highest one that doesn't have a parent (i.e. is on the desktop or
not yet added to a parent), and will return that.
*/
Component* getTopLevelComponent() const noexcept;
/** Checks whether a component is anywhere inside this component or its children.
This will recursively check through this component's children to see if the
given component is anywhere inside.
*/
bool isParentOf (const Component* possibleChild) const noexcept;
//==============================================================================
/** 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 getParentComponent, isShowing, ComponentListener::componentParentHierarchyChanged
*/
virtual void parentHierarchyChanged();
/** Subclasses can use this callback to be told when children are added or removed, or
when their z-order changes.
@see parentHierarchyChanged, ComponentListener::componentChildrenChanged
*/
virtual void childrenChanged();
//==============================================================================
/** Tests whether a given point is inside the component.
Overriding this method allows you to create components which only intercept
mouse-clicks within a user-defined area.
This is called to find out whether a particular x, y coordinate is
considered to be inside the component or not, and is used by methods such
as contains() and getComponentAt() to work out which component
the mouse is clicked on.
Components with custom shapes will probably want to override it to perform
some more complex hit-testing.
The default implementation of this method returns either true or false,
depending on the value that was set by calling setInterceptsMouseClicks() (true
is the default return value).
Note that the hit-test region is not related to the opacity with which
areas of a component are painted.
Applications should never call hitTest() directly - instead use the
contains() method, because this will also test for occlusion by the
component's parent.
Note that for components on the desktop, this method will be ignored, because it's
not always possible to implement this behaviour on all platforms.
@param x the x coordinate to test, relative to the left hand edge of this
component. This value is guaranteed to be greater than or equal to
zero, and less than the component's width
@param y the y coordinate to test, relative to the top edge of this
component. This value is guaranteed to be greater than or equal to
zero, and less than the component's height
@returns true if the click is considered to be inside the component
@see setInterceptsMouseClicks, contains
*/
virtual bool hitTest (int x, int y);
/** Changes the default return value for the hitTest() method.
Setting this to false is an easy way to make a component pass all its mouse events
(not just clicks) through to the components behind it.
When a component is created, the default setting for this is true.
@param allowClicksOnThisComponent if true, hitTest() will always return true; if false, it will
return false (or true for child components if allowClicksOnChildComponents
is true)
@param allowClicksOnChildComponents if this is true and allowClicksOnThisComponent is false, then child
components can be clicked on as normal but clicks on this component pass
straight through; if this is false and allowClicksOnThisComponent
is false, then neither this component nor any child components can
be clicked on
@see hitTest, getInterceptsMouseClicks
*/
void setInterceptsMouseClicks (bool allowClicksOnThisComponent,
bool allowClicksOnChildComponents) noexcept;
/** Retrieves the current state of the mouse-click interception flags.
On return, the two parameters are set to the state used in the last call to
setInterceptsMouseClicks().
@see setInterceptsMouseClicks
*/
void getInterceptsMouseClicks (bool& allowsClicksOnThisComponent,
bool& allowsClicksOnChildComponents) const noexcept;
/** Returns true if a given point lies within this component or one of its children.
Never override this method! Use hitTest to create custom hit regions.
@param localPoint the coordinate to test, relative to this component's top-left.
@returns true if the point is within the component's hit-test area, but only if
that part of the component isn't clipped by its parent component. Note
that this won't take into account any overlapping sibling components
which might be in the way - for that, see reallyContains()
@see hitTest, reallyContains, getComponentAt
*/
bool contains (Point<int> localPoint);
/** Returns true if a given point lies in this component, taking any overlapping
siblings into account.
@param localPoint the coordinate to test, relative to this component's top-left.
@param returnTrueIfWithinAChild if the point actually lies within a child of this component,
this determines whether that is counted as a hit.
@see contains, getComponentAt
*/
bool reallyContains (Point<int> localPoint, bool returnTrueIfWithinAChild);
/** Returns the component at a certain point within this one.
@param x the x coordinate to test, relative to this component's left edge.
@param y the y coordinate to test, relative to this component's top edge.
@returns the component that is at this position - which may be 0, this component,
or one of its children. Note that overlapping siblings that might actually
be in the way are not taken into account by this method - to account for these,
instead call getComponentAt on the top-level parent of this component.
@see hitTest, contains, reallyContains
*/
Component* getComponentAt (int x, int y);
/** Returns the component at a certain point within this one.
@param position the coordinate to test, relative to this component's top-left.
@returns the component that is at this position - which may be 0, this component,
or one of its children. Note that overlapping siblings that might actually
be in the way are not taken into account by this method - to account for these,
instead call getComponentAt on the top-level parent of this component.
@see hitTest, contains, reallyContains
*/
Component* getComponentAt (Point<int> position);
//==============================================================================
/** Marks the whole component as needing to be redrawn.
Calling this will not do any repainting immediately, but will mark the component
as 'dirty'. At some point in the near future the operating system will send a paint
message, which will redraw all the dirty regions of all components.
There's no guarantee about how soon after calling repaint() the redraw will actually
happen, and other queued events may be delivered before a redraw is done.
If the setBufferedToImage() method has been used to cause this component to use a
buffer, the repaint() call will invalidate the cached buffer. If setCachedComponentImage()
has been used to provide a custom image cache, that cache will be invalidated appropriately.
To redraw just a subsection of the component rather than the whole thing,
use the repaint (int, int, int, int) method.
@see paint
*/
void repaint();
/** Marks a subsection of this component as needing to be redrawn.
Calling this will not do any repainting immediately, but will mark the given region
of the component as 'dirty'. At some point in the near future the operating system
will send a paint message, which will redraw all the dirty regions of all components.
There's no guarantee about how soon after calling repaint() the redraw will actually
happen, and other queued events may be delivered before a redraw is done.
The region that is passed in will be clipped to keep it within the bounds of this
component.
@see repaint()
*/
void repaint (int x, int y, int width, int height);
/** Marks a subsection of this component as needing to be redrawn.
Calling this will not do any repainting immediately, but will mark the given region
of the component as 'dirty'. At some point in the near future the operating system
will send a paint message, which will redraw all the dirty regions of all components.
There's no guarantee about how soon after calling repaint() the redraw will actually
happen, and other queued events may be delivered before a redraw is done.
The region that is passed in will be clipped to keep it within the bounds of this
component.
@see repaint()
*/
void repaint (Rectangle<int> area);
//==============================================================================
/** Makes the component use an internal buffer to optimise its redrawing.
Setting this flag to true will cause the component to allocate an
internal buffer into which it paints itself and all its child components, so that
when asked to redraw itself, it can use this buffer rather than actually calling
the paint() method.
Parts of the buffer are invalidated when repaint() is called on this component
or its children. The buffer is then repainted at the next paint() callback.
@see repaint, paint, createComponentSnapshot
*/
void setBufferedToImage (bool shouldBeBuffered);
/** Generates a snapshot of part of this component.
This will return a new Image, the size of the rectangle specified,
containing a snapshot of the specified area of the component and all
its children.
The image may or may not have an alpha-channel, depending on whether the
image is opaque or not.
If the clipImageToComponentBounds parameter is true and the area is greater than
the size of the component, it'll be clipped. If clipImageToComponentBounds is false
then parts of the component beyond its bounds can be drawn.
@see paintEntireComponent
*/
Image createComponentSnapshot (Rectangle<int> areaToGrab,
bool clipImageToComponentBounds = true,
float scaleFactor = 1.0f);
/** Draws this component and all its subcomponents onto the specified graphics
context.
You should very rarely have to use this method, it's simply there in case you need
to draw a component with a custom graphics context for some reason, e.g. for
creating a snapshot of the component.
It calls paint(), paintOverChildren() and recursively calls paintEntireComponent()
on its children in order to render the entire tree.
The graphics context may be left in an undefined state after this method returns,
so you may need to reset it if you're going to use it again.
If ignoreAlphaLevel is false, then the component will be drawn with the opacity level
specified by getAlpha(); if ignoreAlphaLevel is true, then this will be ignored and
an alpha of 1.0 will be used.
*/
void paintEntireComponent (Graphics& context, bool ignoreAlphaLevel);
/** This allows you to indicate that this component doesn't require its graphics
context to be clipped when it is being painted.
Most people will never need to use this setting, but in situations where you have a very large
number of simple components being rendered, and where they are guaranteed never to do any drawing
beyond their own boundaries, setting this to true will reduce the overhead involved in clipping
the graphics context that gets passed to the component's paint() callback.
If you enable this mode, you'll need to make sure your paint method doesn't call anything like
Graphics::fillAll(), and doesn't draw beyond the component's bounds, because that'll produce
artifacts. Your component also can't have any child components that may be placed beyond its
bounds.
*/
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept;
/** Returns true if this component doesn't require its graphics context to be clipped
when it is being painted.
*/
bool isPaintingUnclipped() const noexcept;
//==============================================================================
/** Adds an effect filter to alter the component's appearance.
When a component has an effect filter set, then this is applied to the
results of its paint() method. There are a few preset effects, such as
a drop-shadow or glow, but they can be user-defined as well.
The effect that is passed in will not be deleted by the component - the
caller must take care of deleting it.
To remove an effect from a component, pass a null pointer in as the parameter.
@see ImageEffectFilter, DropShadowEffect, GlowEffect
*/
void setComponentEffect (ImageEffectFilter* newEffect);
/** Returns the current component effect.
@see setComponentEffect
*/
ImageEffectFilter* getComponentEffect() const noexcept { return effect; }
//==============================================================================
/** Finds the appropriate look-and-feel to use for this component.
If the component hasn't had a look-and-feel explicitly set, this will
return the parent's look-and-feel, or just the default one if there's no
parent.
@see setLookAndFeel, lookAndFeelChanged
*/
LookAndFeel& getLookAndFeel() const noexcept;
/** Sets the look and feel to use for this component.
This will also change the look and feel for any child components that haven't
had their look set explicitly.
The object passed in will not be deleted by the component, so it's the caller's
responsibility to manage it. It may be used at any time until this component
has been deleted.
Calling this method will also invoke the sendLookAndFeelChange() method.
@see getLookAndFeel, lookAndFeelChanged
*/
void setLookAndFeel (LookAndFeel* newLookAndFeel);
/** Called to let the component react to a change in the look-and-feel setting.
When the look-and-feel is changed for a component, this will be called in
all its child components, recursively.
It can also be triggered manually by the sendLookAndFeelChange() method, in case
an application uses a LookAndFeel class that might have changed internally.
@see sendLookAndFeelChange, getLookAndFeel
*/
virtual void lookAndFeelChanged();
/** Calls the lookAndFeelChanged() method in this component and all its children.
This will recurse through the children and their children, calling lookAndFeelChanged()
on them all.
@see lookAndFeelChanged
*/
void sendLookAndFeelChange();
//==============================================================================
/** Indicates whether any parts of the component might be transparent.
Components that always paint all of their contents with solid colour and
thus completely cover any components behind them should use this method
to tell the repaint system that they are opaque.
This information is used to optimise drawing, because it means that
objects underneath opaque windows don't need to be painted.
By default, components are considered transparent, unless this is used to
make it otherwise.
@see isOpaque
*/
void setOpaque (bool shouldBeOpaque);
/** Returns true if no parts of this component are transparent.
@returns the value that was set by setOpaque, (the default being false)
@see setOpaque
*/
bool isOpaque() const noexcept;
//==============================================================================
/** Indicates whether the component should be brought to the front when clicked.
Setting this flag to true will cause the component to be brought to the front
when the mouse is clicked somewhere inside it or its child components.
Note that a top-level desktop window might still be brought to the front by the
operating system when it's clicked, depending on how the OS works.
By default this is set to false.
@see setMouseClickGrabsKeyboardFocus
*/
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept;
/** Indicates whether the component should be brought to the front when clicked-on.
@see setBroughtToFrontOnMouseClick
*/
bool isBroughtToFrontOnMouseClick() const noexcept;
//==============================================================================
// Focus methods
/** Sets the focus order of this component.
The focus order is used by the default traverser implementation returned by
createFocusTraverser() as part of its algorithm for deciding the order in
which components should be traversed. A value of 0 or less is taken to mean
that no explicit order is wanted, and that traversal should use other
factors, like the component's position.
@see getExplicitFocusOrder, FocusTraverser, createFocusTraverser
*/
void setExplicitFocusOrder (int newFocusOrderIndex);
/** Returns the focus order of this component, if one has been specified.
By default components don't have a focus order - in that case, this will
return 0.
@see setExplicitFocusOrder
*/
int getExplicitFocusOrder() const;
/** A focus container type that can be passed to setFocusContainer().
If a component is marked as a focus container or keyboard focus container then
it will act as the top-level component within which focus or keyboard focus is
passed around. By default components are considered "focusable" if they are visible
and enabled and "keyboard focusable" if `getWantsKeyboardFocus() == true`.
The order of traversal within a focus container is determined by the objects
returned by createFocusTraverser() and createKeyboardFocusTraverser(),
respectively - see the documentation of the default FocusContainer and
KeyboardFocusContainer implementations for more information.
*/
enum class FocusContainerType
{
/** The component will not act as a focus container.
This is the default setting for non top-level components and means that it and any
sub-components are navigable within their containing focus container.
*/
none,
/** The component will act as a top-level component within which focus is passed around.
The default traverser implementation returned by createFocusTraverser() will use this
flag to find the first parent component (of the currently focused one) that wants to
be a focus container.
This is currently used when determining the hierarchy of accessible UI elements presented
to screen reader clients on supported platforms. See the AccessibilityHandler class for
more information.
*/
focusContainer,
/** The component will act as a top-level component within which keyboard focus is passed around.
The default traverser implementation returned by createKeyboardFocusTraverser() will
use this flag to find the first parent component (of the currently focused one) that
wants to be a keyboard focus container.
This is currently used when determining how keyboard focus is passed between components
that have been marked as keyboard focusable with setWantsKeyboardFocus() when clicking
on components and navigating with the tab key.
*/
keyboardFocusContainer
};
/** Sets whether this component is a container for components that can have
their focus traversed, and the type of focus traversal that it supports.
@see FocusContainerType, isFocusContainer, isKeyboardFocusContainer,
FocusTraverser, createFocusTraverser,
KeyboardFocusTraverser, createKeyboardFocusTraverser
*/
void setFocusContainerType (FocusContainerType containerType) noexcept;
/** Returns true if this component has been marked as a focus container.
@see setFocusContainer
*/
bool isFocusContainer() const noexcept;
/** Returns true if this component has been marked as a keyboard focus container.
@see setFocusContainer
*/
bool isKeyboardFocusContainer() const noexcept;
/** Returns the focus container for this component.
@see isFocusContainer, setFocusContainer
*/
Component* findFocusContainer() const;
/** Returns the keyboard focus container for this component.
@see isFocusContainer, setFocusContainer
*/
Component* findKeyboardFocusContainer() const;
//==============================================================================
/** Sets a flag to indicate whether this component wants keyboard focus or not.
By default components aren't actually interested in gaining the keyboard
focus, but this method can be used to turn this on.
See the grabKeyboardFocus() method for details about the way a component
is chosen to receive the focus.
@see grabKeyboardFocus, giveAwayKeyboardFocus, getWantsKeyboardFocus
*/
void setWantsKeyboardFocus (bool wantsFocus) noexcept;
/** Returns true if the component is interested in getting keyboard focus.
This returns the flag set by setWantsKeyboardFocus(). The default setting
is false.
@see setWantsKeyboardFocus
*/
bool getWantsKeyboardFocus() const noexcept;
/** Chooses whether a click on this component automatically grabs the focus.
By default this is set to true, but you might want a component which can
be focused, but where you don't want the user to be able to affect it
directly by clicking.
*/
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus);
/** Returns the last value set with setMouseClickGrabsKeyboardFocus().
@see setMouseClickGrabsKeyboardFocus
*/
bool getMouseClickGrabsKeyboardFocus() const noexcept;
/** Tries to give keyboard focus to this component.
When the user clicks on a component or its grabKeyboardFocus() method is
called, the following procedure is used to work out which component should
get it:
- if the component that was clicked on actually wants focus (as indicated
by calling getWantsKeyboardFocus), it gets it.
- if the component itself doesn't want focus, it will try to pass it
on to whichever of its children is the default component, as determined by
the getDefaultComponent() implemetation of the ComponentTraverser returned
by createKeyboardFocusTraverser().
- if none of its children want focus at all, it will pass it up to its
parent instead, unless it's a top-level component without a parent,
in which case it just takes the focus itself.
Important note! It's obviously not possible for a component to be focused
unless it's actually visible, on-screen, and inside a window that is also
visible. So there's no point trying to call this in the component's own
constructor or before all of its parent hierarchy has been fully instantiated.
@see giveAwayKeyboardFocus, setWantsKeyboardFocus, getWantsKeyboardFocus,
hasKeyboardFocus, getCurrentlyFocusedComponent, focusGained, focusLost,
keyPressed, keyStateChanged
*/
void grabKeyboardFocus();
/** 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.
@see grabKeyboardFocus, setWantsKeyboardFocus, getCurrentlyFocusedComponent,
focusGained, focusLost
*/
void giveAwayKeyboardFocus();
/** Returns true if this component currently has the keyboard focus.
@param trueIfChildIsFocused if this is true, then the method returns true if
either this component or any of its children (recursively)
have the focus. If false, the method only returns true if
this component has the focus.
@see grabKeyboardFocus, giveAwayKeyboardFocus, setWantsKeyboardFocus,
getCurrentlyFocusedComponent, focusGained, focusLost
*/
bool hasKeyboardFocus (bool trueIfChildIsFocused) const;
/** Tries to move the keyboard focus to one of this component's siblings.
This will try to move focus to either the next or previous component, as
determined by the getNextComponent() and getPreviousComponent() implemetations
of the ComponentTraverser returned by createKeyboardFocusTraverser().
This is the method that is used when shifting focus by pressing the tab key.
@param moveToNext if true, the focus will move forwards; if false, it will
move backwards
@see grabKeyboardFocus, giveAwayKeyboardFocus, setFocusContainer, setWantsKeyboardFocus
*/
void moveKeyboardFocusToSibling (bool moveToNext);
/** Returns the component that currently has the keyboard focus.
@returns the focused component, or nullptr if nothing is focused.
*/
static Component* JUCE_CALLTYPE getCurrentlyFocusedComponent() noexcept;
/** If any component has keyboard focus, this will defocus it. */
static void JUCE_CALLTYPE unfocusAllComponents();
//==============================================================================
/** Creates a ComponentTraverser object to determine the logic by which focus should be
passed from this component.
The default implementation of this method will return an instance of FocusTraverser
if this component is a focus container (as determined by the setFocusContainer() method).
If the component isn't a focus container, then it will recursively call
createFocusTraverser() on its parents.
If you override this to return a custom traverser object, then this component and
all its sub-components will use the new object to make their focusing decisions.
*/
virtual std::unique_ptr<ComponentTraverser> createFocusTraverser();
/** Creates a ComponentTraverser object to use to determine the logic by which keyboard
focus should be passed from this component.
The default implementation of this method will return an instance of
KeyboardFocusTraverser if this component is a keyboard focus container (as determined by
the setFocusContainer() method). If the component isn't a keyboard focus container, then
it will recursively call createKeyboardFocusTraverser() on its parents.
If you override this to return a custom traverser object, then this component and
all its sub-components will use the new object to make their keyboard focusing
decisions.
*/
virtual std::unique_ptr<ComponentTraverser> createKeyboardFocusTraverser();
//==============================================================================
/** Returns true if the component (and all its parents) are enabled.
Components are enabled by default, and can be disabled with setEnabled(). Exactly
what difference this makes to the component depends on the type. E.g. buttons
and sliders will choose to draw themselves differently, etc.
Note that if one of this component's parents is disabled, this will always
return false, even if this component itself is enabled.
@see setEnabled, enablementChanged
*/
bool isEnabled() const noexcept;
/** Enables or disables this component.
Disabling a component will also cause all of its child components to become
disabled.
Similarly, enabling a component which is inside a disabled parent
component won't make any difference until the parent is re-enabled.
@see isEnabled, enablementChanged
*/
void setEnabled (bool shouldBeEnabled);
/** Callback to indicate that this component has been enabled or disabled.
This can be triggered by one of the component's parent components
being enabled or disabled, as well as changes to the component itself.
The default implementation of this method does nothing; your class may
wish to repaint itself or something when this happens.
@see setEnabled, isEnabled
*/
virtual void enablementChanged();
//==============================================================================
/** Returns the component's current transparency level.
See setAlpha() for more details.
*/
float getAlpha() const noexcept;
/** Changes the transparency of this component.
When painted, the entire component and all its children will be rendered
with this as the overall opacity level, where 0 is completely invisible, and
1.0 is fully opaque (i.e. normal).
@see getAlpha, alphaChanged
*/
void setAlpha (float newAlpha);
/** Called when setAlpha() is used to change the alpha value of this component.
If you override this, you should also invoke the base class's implementation
during your overridden function, as it performs some repainting behaviour.
*/
virtual void alphaChanged();
//==============================================================================
/** Changes the mouse cursor shape to use when the mouse is over this component.
Note that the cursor set by this method can be overridden by the getMouseCursor
method.
@see MouseCursor
*/
void setMouseCursor (const MouseCursor& cursorType);
/** Returns the mouse cursor shape to use when the mouse is over this component.
The default implementation will return the cursor that was set by setCursor()
but can be overridden for more specialised purposes, e.g. returning different
cursors depending on the mouse position.
@see MouseCursor
*/
virtual MouseCursor getMouseCursor();
/** Forces the current mouse cursor to be updated.
If you're overriding the getMouseCursor() method to control which cursor is
displayed, then this will only be checked each time the user moves the mouse. So
if you want to force the system to check that the cursor being displayed is
up-to-date (even if the mouse is just sitting there), call this method.
(If you're changing the cursor using setMouseCursor(), you don't need to bother
calling this).
*/
void updateMouseCursor() const;
//==============================================================================
/** 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().
@param g the graphics context that must be used to do the drawing operations.
@see repaint, paintOverChildren, Graphics
*/
virtual void paint (Graphics& g);
/** Components can override this method to draw over the top of their children.
For most drawing operations, it's better to use the normal paint() method,
but if you need to overlay something on top of the children, this can be
used.
@see paint, Graphics
*/
virtual void paintOverChildren (Graphics& g);
//==============================================================================
/** Called when the mouse moves inside a component.
If the mouse button isn't pressed and the mouse moves over a component,
this will be called to let the component react to this.
A component will always get a mouseEnter callback before a mouseMove.
@param event details about the position and status of the mouse event, including
the source component in which it occurred
@see mouseEnter, mouseExit, mouseDrag, contains
*/
void mouseMove (const MouseEvent& event) override;
/** Called when the mouse first enters a component.
If the mouse button isn't pressed and the mouse moves into a component,
this will be called to let the component react to this.
When the mouse button is pressed and held down while being moved in
or out of a component, no mouseEnter or mouseExit callbacks are made - only
mouseDrag messages are sent to the component that the mouse was originally
clicked on, until the button is released.
@param event details about the position and status of the mouse event, including
the source component in which it occurred
@see mouseExit, mouseDrag, mouseMove, contains
*/
void mouseEnter (const MouseEvent& event) override;
/** Called when the mouse moves out of a component.
This will be called when the mouse moves off the edge of this
component.
If the mouse button was pressed, and it was then dragged off the
edge of the component and released, then this callback will happen
when the button is released, after the mouseUp callback.
@param event details about the position and status of the mouse event, including
the source component in which it occurred
@see mouseEnter, mouseDrag, mouseMove, contains
*/
void mouseExit (const MouseEvent& event) override;
/** Called when a mouse button is pressed.
The MouseEvent object passed in contains lots of methods for finding out
which button was pressed, as well as which modifier keys (e.g. shift, ctrl)
were held down at the time.
Once a button is held down, the mouseDrag method will be called when the
mouse moves, until the button is released.
@param event details about the position and status of the mouse event, including
the source component in which it occurred
@see mouseUp, mouseDrag, mouseDoubleClick, contains
*/
void mouseDown (const MouseEvent& event) override;
/** Called when the mouse is moved while a button is held down.
When a mouse button is pressed inside a component, that component
receives mouseDrag callbacks each time the mouse moves, even if the
mouse strays outside the component's bounds.
@param event details about the position and status of the mouse event, including
the source component in which it occurred
@see mouseDown, mouseUp, mouseMove, contains, setDragRepeatInterval
*/
void mouseDrag (const MouseEvent& event) override;
/** Called when a mouse button is released.
A mouseUp callback is sent to the component in which a button was pressed
even if the mouse is actually over a different component when the
button is released.
The MouseEvent object passed in contains lots of methods for finding out
which buttons were down just before they were released.
@param event details about the position and status of the mouse event, including
the source component in which it occurred
@see mouseDown, mouseDrag, mouseDoubleClick, contains
*/
void mouseUp (const MouseEvent& event) override;
/** Called when a mouse button has been double-clicked on a component.
The MouseEvent object passed in contains lots of methods for finding out
which button was pressed, as well as which modifier keys (e.g. shift, ctrl)
were held down at the time.
@param event details about the position and status of the mouse event, including
the source component in which it occurred
@see mouseDown, mouseUp
*/
void mouseDoubleClick (const MouseEvent& event) override;
/** Called when the mouse-wheel is moved.
This callback is sent to the component that the mouse is over when the
wheel is moved.
If not overridden, a component will forward this message to its parent, so
that parent components can collect mouse-wheel messages that happen to
child components which aren't interested in them. (Bear in mind that if
you attach a component as a mouse-listener to other components, then
those wheel moves will also end up calling this method and being passed up
to the parents, which may not be what you intended to happen).
@param event details about the mouse event
@param wheel details about the mouse wheel movement
*/
void mouseWheelMove (const MouseEvent& event,
const MouseWheelDetails& wheel) override;
/** Called when a pinch-to-zoom mouse-gesture is used.
If not overridden, a component will forward this message to its parent, so
that parent components can collect gesture messages that are unused by child
components.
@param event details about the mouse event
@param scaleFactor a multiplier to indicate by how much the size of the target
should be changed. A value of 1.0 would indicate no change,
values greater than 1.0 mean it should be enlarged.
*/
void mouseMagnify (const MouseEvent& event, float scaleFactor) override;
//==============================================================================
/** Ensures that a non-stop stream of mouse-drag events will be sent during the
current mouse-drag operation.
This allows you to make sure that mouseDrag() events are sent continuously, even
when the mouse isn't moving. This can be useful for things like auto-scrolling
components when the mouse is near an edge.
Call this method during a mouseDown() or mouseDrag() callback, specifying the
minimum interval between consecutive mouse drag callbacks. The callbacks
will continue until the mouse is released, and then the interval will be reset,
so you need to make sure it's called every time you begin a drag event.
Passing an interval of 0 or less will cancel the auto-repeat.
@see mouseDrag, Desktop::beginDragAutoRepeat
*/
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks);
/** Causes automatic repaints when the mouse enters or exits this component.
If turned on, then when the mouse enters/exits, or when the button is pressed/released
on the component, it will trigger a repaint.
This is handy for things like buttons that need to draw themselves differently when
the mouse moves over them, and it avoids having to override all the different mouse
callbacks and call repaint().
@see mouseEnter, mouseExit, mouseDown, mouseUp
*/
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept;
/** Registers a listener to be told when mouse events occur in this component.
If you need to get informed about mouse events in a component but can't or
don't want to override its methods, you can attach any number of listeners
to the component, and these will get told about the events in addition to
the component's own callbacks being called.
Note that a MouseListener can also be attached to more than one component.
@param newListener the listener to register
@param wantsEventsForAllNestedChildComponents if true, the listener will receive callbacks
for events that happen to any child component
within this component, including deeply-nested
child components. If false, it will only be
told about events that this component handles.
@see MouseListener, removeMouseListener
*/
void addMouseListener (MouseListener* newListener,
bool wantsEventsForAllNestedChildComponents);
/** Deregisters a mouse listener.
@see addMouseListener, MouseListener
*/
void removeMouseListener (MouseListener* listenerToRemove);
//==============================================================================
/** Adds a listener that wants to hear about keypresses that this component receives.
The listeners that are registered with a component are called by its keyPressed() or
keyStateChanged() methods (assuming these haven't been overridden to do something else).
If you add an object as a key listener, be careful to remove it when the object
is deleted, or the component will be left with a dangling pointer.
@see keyPressed, keyStateChanged, removeKeyListener
*/
void addKeyListener (KeyListener* newListener);
/** Removes a previously-registered key listener.
@see addKeyListener
*/
void removeKeyListener (KeyListener* listenerToRemove);
/** Called when a key is pressed.
When a key is pressed, the component that has the keyboard focus will have this
method called. Remember that a component will only be given the focus if its
setWantsKeyboardFocus() method has been used to enable this.
If your implementation returns true, the event will be consumed and not passed
on to any other listeners. If it returns false, the key will be passed to any
KeyListeners that have been registered with this component. As soon as one of these
returns true, the process will stop, but if they all return false, the event will
be passed upwards to this component's parent, and so on.
The default implementation of this method does nothing and returns false.
@see keyStateChanged, getCurrentlyFocusedComponent, addKeyListener
*/
virtual bool keyPressed (const KeyPress& key);
/** Called when a key is pressed or released.
Whenever a key on the keyboard is pressed or released (including modifier keys
like shift and ctrl), this method will be called on the component that currently
has the keyboard focus. Remember that a component will only be given the focus if
its setWantsKeyboardFocus() method has been used to enable this.
If your implementation returns true, the event will be consumed and not passed
on to any other listeners. If it returns false, then any KeyListeners that have
been registered with this component will have their keyStateChanged methods called.
As soon as one of these returns true, the process will stop, but if they all return
false, the event will be passed upwards to this component's parent, and so on.
The default implementation of this method does nothing and returns false.
To find out which keys are up or down at any time, see the KeyPress::isKeyCurrentlyDown()
method.
@param isKeyDown true if a key has been pressed; false if it has been released
@see keyPressed, KeyPress, getCurrentlyFocusedComponent, addKeyListener
*/
virtual bool keyStateChanged (bool isKeyDown);
/** Called when a modifier key is pressed or released.
Whenever the shift, control, alt or command keys are pressed or released,
this method will be called.
The component that is currently under the main mouse pointer will be tried first and,
if there is no component currently under the pointer, the component that currently
has the keyboard focus will have this method called. Remember that a component will
only be given the focus if its setWantsKeyboardFocus() method has been used to enable this.
The default implementation of this method actually calls its parent's modifierKeysChanged
method, so that focused components which aren't interested in this will give their
parents a chance to act on the event instead.
@see keyStateChanged, ModifierKeys
*/
virtual void modifierKeysChanged (const ModifierKeys& modifiers);
//==============================================================================
/** Enumeration used by the focusGained() and focusLost() methods. */
enum FocusChangeType
{
focusChangedByMouseClick, /**< Means that the user clicked the mouse to change focus. */
focusChangedByTabKey, /**< Means that the user pressed the tab key to move the focus. */
focusChangedDirectly /**< Means that the focus was changed by a call to grabKeyboardFocus(). */
};
/** Called to indicate that this component has just acquired the keyboard focus.
@see focusLost, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus
*/
virtual void focusGained (FocusChangeType cause);
/** Called to indicate that this component has just lost the keyboard focus.
@see focusGained, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus
*/
virtual void focusLost (FocusChangeType cause);
/** 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 focusGained, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus
*/
virtual void focusOfChildComponentChanged (FocusChangeType cause);
//==============================================================================
/** Returns true if the mouse is currently over this component.
If the mouse isn't over the component, this will return false, even if the
mouse is currently being dragged - so you can use this in your mouseDrag
method to find out whether it's really over the component or not.
Note that when the mouse button is being held down, then the only component
for which this method will return true is the one that was originally
clicked on.
Also note that on a touch-screen device, this will only return true when a finger
is actually down - as soon as all touch is released, isMouseOver will always
return false.
If includeChildren is true, then this will also return true if the mouse is over
any of the component's children (recursively) as well as the component itself.
@see isMouseButtonDown. isMouseOverOrDragging, mouseDrag
*/
bool isMouseOver (bool includeChildren = false) const;
/** Returns true if the mouse button is currently held down in this component.
Note that this is a test to see whether the mouse is being pressed in this
component, so it'll return false if called on component A when the mouse
is actually being dragged in component B.
@see isMouseButtonDownAnywhere, isMouseOver, isMouseOverOrDragging
*/
bool isMouseButtonDown (bool includeChildren = false) const;
/** True if the mouse is over this component, or if it's being dragged in this component.
This is a handy equivalent to (isMouseOver() || isMouseButtonDown()).
@see isMouseOver, isMouseButtonDown, isMouseButtonDownAnywhere
*/
bool isMouseOverOrDragging (bool includeChildren = false) const;
/** Returns true if a mouse button is currently down.
Unlike isMouseButtonDown, this will test the current state of the
buttons without regard to which component (if any) it has been
pressed in.
@see isMouseButtonDown, ModifierKeys
*/
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere() noexcept;
/** Returns the mouse's current position, relative to this component.
The return value is relative to the component's top-left corner.
*/
Point<int> getMouseXYRelative() const;
//==============================================================================
/** Called when this component's size has been changed.
A component can implement this method to do things such as laying out its
child components when its width or height changes.
The method is called synchronously as a result of the setBounds or setSize
methods, so repeatedly changing a components size will repeatedly call its
resized method (unlike things like repainting, where multiple calls to repaint
are coalesced together).
If the component is a top-level window on the desktop, its size could also
be changed by operating-system factors beyond the application's control.
@see moved, setSize
*/
virtual void resized();
/** Called when this component's position has been changed.
This is called when the position relative to its parent changes, not when
its absolute position on the screen changes (so it won't be called for
all child components when a parent component is moved).
The method is called synchronously as a result of the setBounds, setTopLeftPosition
or any of the other repositioning methods, and like resized(), it will be
called each time those methods are called.
If the component is a top-level window on the desktop, its position could also
be changed by operating-system factors beyond the application's control.
@see resized, setBounds
*/
virtual void moved();
/** Called when one of this component's children is moved or resized.
If the parent wants to know about changes to its immediate children (not
to children of its children), this is the method to override.
@see moved, resized, parentSizeChanged
*/
virtual void childBoundsChanged (Component* child);
/** Called when this component's immediate parent has been resized.
If the component is a top-level window, this indicates that the screen size
has changed.
@see childBoundsChanged, moved, resized
*/
virtual void parentSizeChanged();
/** Called when this component has been moved to the front of its siblings.
The component may have been brought to the front by the toFront() method, or
by the operating system if it's a top-level window.
@see toFront
*/
virtual void broughtToFront();
/** Adds a listener to be told about changes to the component hierarchy or position.
Component listeners get called when this component's size, position or children
change - see the ComponentListener class for more details.
@param newListener the listener to register - if this is already registered, it
will be ignored.
@see ComponentListener, removeComponentListener
*/
void addComponentListener (ComponentListener* newListener);
/** Removes a component listener.
@see addComponentListener
*/
void removeComponentListener (ComponentListener* listenerToRemove);
//==============================================================================
/** Dispatches a numbered message to this component.
This is a quick and cheap way of allowing simple asynchronous messages to
be sent to components. It's also safe, because if the component that you
send the message to is a null or dangling pointer, this won't cause an error.
The command ID is later delivered to the component's handleCommandMessage() method by
the application's message queue.
@see handleCommandMessage
*/
void postCommandMessage (int commandId);
/** Called to handle a command that was sent by postCommandMessage().
This is called by the message thread when a command message arrives, and
the component can override this method to process it in any way it needs to.
@see postCommandMessage
*/
virtual void handleCommandMessage (int commandId);
//==============================================================================
#if JUCE_MODAL_LOOPS_PERMITTED
/** Runs a component modally, waiting until the loop terminates.
This method first makes the component visible, brings it to the front and
gives it the keyboard focus.
It then runs a loop, dispatching messages from the system message queue, but
blocking all mouse or keyboard messages from reaching any components other
than this one and its children.
This loop continues until the component's exitModalState() method is called (or
the component is deleted), and then this method returns, returning the value
passed into exitModalState().
Note that you SHOULD NEVER USE THIS METHOD! Modal loops are a dangerous construct
because things that happen during the events that they dispatch could affect the
state of objects which are currently in use somewhere on the stack, so when the
loop finishes and the stack unwinds, horrible problems can occur. This is especially
bad in plugins, where the host may choose to delete the plugin during runModalLoop(),
so that when it returns, the entire DLL could have been unloaded from memory!
Also, some OSes deliberately make it impossible to run modal loops (e.g. Android),
so this method won't even exist on some platforms.
@see enterModalState, exitModalState, isCurrentlyModal, getCurrentlyModalComponent,
isCurrentlyBlockedByAnotherModalComponent, ModalComponentManager
*/
int runModalLoop();
#endif
/** Puts the component into a modal state.
This makes the component modal, so that messages are blocked from reaching
any components other than this one and its children, but unlike runModalLoop(),
this method returns immediately.
If takeKeyboardFocus is true, the component will use grabKeyboardFocus() to
get the focus, which is usually what you'll want it to do. If not, it will leave
the focus unchanged.
The callback is an optional object which will receive a callback when the modal
component loses its modal status, either by being hidden or when exitModalState()
is called. If you pass an object in here, the system will take care of deleting it
later, after making the callback
If deleteWhenDismissed is true, then when it is dismissed, the component will be
deleted and then the callback will be called. (This will safely handle the situation
where the component is deleted before its exitModalState() method is called).
@see exitModalState, runModalLoop, ModalComponentManager::attachCallback
*/
void enterModalState (bool takeKeyboardFocus = true,
ModalComponentManager::Callback* callback = nullptr,
bool deleteWhenDismissed = false);
/** Ends a component's modal state.
If this component is currently modal, this will turn off its modalness, and return
a value to the runModalLoop() method that might have be running its modal loop.
@see runModalLoop, enterModalState, isCurrentlyModal
*/
void exitModalState (int returnValue);
/** Returns true if this component is the modal one.
It's possible to have nested modal components, e.g. a pop-up dialog box
that launches another pop-up. If onlyConsiderForemostModalComponent is
true then isCurrentlyModal will only return true for the one at the top
of the stack. If onlyConsiderForemostModalComponent is false then
isCurrentlyModal will return true for any modal component in the stack.
@see getCurrentlyModalComponent
*/
bool isCurrentlyModal (bool onlyConsiderForemostModalComponent = true) const noexcept;
/** Returns the number of components that are currently in a modal state.
@see getCurrentlyModalComponent
*/
static int JUCE_CALLTYPE getNumCurrentlyModalComponents() noexcept;
/** Returns one of the components that are currently modal.
The index specifies which of the possible modal components to return. The order
of the components in this list is the reverse of the order in which they became
modal - so the component at index 0 is always the active component, and the others
are progressively earlier ones that are themselves now blocked by later ones.
@returns the modal component, or null if no components are modal (or if the
index is out of range)
@see getNumCurrentlyModalComponents, runModalLoop, isCurrentlyModal
*/
static Component* JUCE_CALLTYPE getCurrentlyModalComponent (int index = 0) noexcept;
/** Checks whether there's a modal component somewhere that's stopping this one
from receiving messages.
If there is a modal component, its canModalEventBeSentToComponent() method
will be called to see if it will still allow this component to receive events.
@see runModalLoop, getCurrentlyModalComponent
*/
bool isCurrentlyBlockedByAnotherModalComponent() const;
/** When a component is modal, this callback allows it to choose which other
components can still receive events.
When a modal component is active and the user clicks on a non-modal component,
this method is called on the modal component, and if it returns true, the
event is allowed to reach its target. If it returns false, the event is blocked
and the inputAttemptWhenModal() callback is made.
It called by the isCurrentlyBlockedByAnotherModalComponent() method. The default
implementation just returns false in all cases.
*/
virtual bool canModalEventBeSentToComponent (const Component* targetComponent);
/** Called when the user tries to click on a component that is blocked by another
modal component.
When a component is modal and the user clicks on one of the other components,
the modal component will receive this callback.
The default implementation of this method will play a beep, and bring the currently
modal component to the front, but it can be overridden to do other tasks.
@see isCurrentlyBlockedByAnotherModalComponent, canModalEventBeSentToComponent
*/
virtual void inputAttemptWhenModal();
//==============================================================================
/** Returns the set of properties that belong to this component.
Each component has a NamedValueSet object which you can use to attach arbitrary
items of data to it.
*/
NamedValueSet& getProperties() noexcept { return properties; }
/** Returns the set of properties that belong to this component.
Each component has a NamedValueSet object which you can use to attach arbitrary
items of data to it.
*/
const NamedValueSet& getProperties() const noexcept { return properties; }
//==============================================================================
/** Looks for a colour that has been registered with the given colour ID number.
If a colour has been set for this ID number using setColour(), then it is
returned. If none has been set, the method will try calling the component's
LookAndFeel class's findColour() method. If none has been registered with the
look-and-feel either, it will just return black.
The colour IDs for various purposes are stored as enums in the components that
they are relevant to - for an example, see Slider::ColourIds,
Label::ColourIds, TextEditor::ColourIds, TreeView::ColourIds, etc.
@see setColour, isColourSpecified, colourChanged, LookAndFeel::findColour, LookAndFeel::setColour
*/
Colour findColour (int colourID, bool inheritFromParent = false) const;
/** Registers a colour to be used for a particular purpose.
Changing a colour will cause a synchronous callback to the colourChanged()
method, which your component can override if it needs to do something when
colours are altered.
For more details about colour IDs, see the comments for findColour().
@see findColour, isColourSpecified, colourChanged, LookAndFeel::findColour, LookAndFeel::setColour
*/
void setColour (int colourID, Colour newColour);
/** If a colour has been set with setColour(), this will remove it.
This allows you to make a colour revert to its default state.
*/
void removeColour (int colourID);
/** Returns true if the specified colour ID has been explicitly set for this
component using the setColour() method.
*/
bool isColourSpecified (int colourID) const;
/** This looks for any colours that have been specified for this component,
and copies them to the specified target component.
*/
void copyAllExplicitColoursTo (Component& target) const;
/** This method is called when a colour is changed by the setColour() method.
@see setColour, findColour
*/
virtual void colourChanged();
//==============================================================================
/** Returns the underlying native window handle for this component.
This is platform-dependent and strictly for power-users only!
*/
void* getWindowHandle() const;
//==============================================================================
/** Holds a pointer to some type of Component, which automatically becomes null if
the component is deleted.
If you're using a component which may be deleted by another event that's outside
of your control, use a SafePointer instead of a normal pointer to refer to it,
and you can test whether it's null before using it to see if something has deleted
it.
The ComponentType template parameter must be Component, or some subclass of Component.
You may also want to use a WeakReference<Component> object for the same purpose.
*/
template <class ComponentType>
class SafePointer
{
public:
/** Creates a null SafePointer. */
SafePointer() = default;
/** Creates a SafePointer that points at the given component. */
SafePointer (ComponentType* component) : weakRef (component) {}
/** Creates a copy of another SafePointer. */
SafePointer (const SafePointer& other) noexcept : weakRef (other.weakRef) {}
/** Copies another pointer to this one. */
SafePointer& operator= (const SafePointer& other) { weakRef = other.weakRef; return *this; }
/** Copies another pointer to this one. */
SafePointer& operator= (ComponentType* newComponent) { weakRef = newComponent; return *this; }
/** Returns the component that this pointer refers to, or null if the component no longer exists. */
ComponentType* getComponent() const noexcept { return dynamic_cast<ComponentType*> (weakRef.get()); }
/** Returns the component that this pointer refers to, or null if the component no longer exists. */
operator ComponentType*() const noexcept { return getComponent(); }
/** Returns the component that this pointer refers to, or null if the component no longer exists. */
ComponentType* operator->() const noexcept { return getComponent(); }
/** If the component is valid, this deletes it and sets this pointer to null. */
void deleteAndZero() { delete getComponent(); }
bool operator== (ComponentType* component) const noexcept { return weakRef == component; }
bool operator!= (ComponentType* component) const noexcept { return weakRef != component; }
private:
WeakReference<Component> weakRef;
};
//==============================================================================
/** A class to keep an eye on a component and check for it being deleted.
This is designed for use with the ListenerList::callChecked() methods, to allow
the list iterator to stop cleanly if the component is deleted by a listener callback
while the list is still being iterated.
*/
class JUCE_API BailOutChecker
{
public:
/** Creates a checker that watches one component. */
BailOutChecker (Component* component);
/** Returns true if either of the two components have been deleted since this object was created. */
bool shouldBailOut() const noexcept;
private:
const WeakReference<Component> safePointer;
JUCE_DECLARE_NON_COPYABLE (BailOutChecker)
};
//==============================================================================
/**
Base class for objects that can be used to automatically position a component according to
some kind of algorithm.
The component class simply holds onto a reference to a Positioner, but doesn't actually do
anything with it - all the functionality must be implemented by the positioner itself (e.g.
it might choose to watch some kind of value and move the component when the value changes).
*/
class JUCE_API Positioner
{
public:
/** Creates a Positioner which can control the specified component. */
explicit Positioner (Component& component) noexcept;
/** Destructor. */
virtual ~Positioner() = default;
/** Returns the component that this positioner controls. */
Component& getComponent() const noexcept { return component; }
/** Attempts to set the component's position to the given rectangle.
Unlike simply calling Component::setBounds(), this may involve the positioner
being smart enough to adjust itself to fit the new bounds.
*/
virtual void applyNewBounds (const Rectangle<int>& newBounds) = 0;
private:
Component& component;
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Positioner)
};
/** Returns the Positioner object that has been set for this component.
@see setPositioner()
*/
Positioner* getPositioner() const noexcept;
/** Sets a new Positioner object for this component.
If there's currently another positioner set, it will be deleted. The object that is passed in
will be deleted automatically by this component when it's no longer required. Pass a null pointer
to clear the current positioner.
@see getPositioner()
*/
void setPositioner (Positioner* newPositioner);
/** Gives the component a CachedComponentImage that should be used to buffer its painting.
The object that is passed-in will be owned by this component, and will be deleted automatically
later on.
@see setBufferedToImage
*/
void setCachedComponentImage (CachedComponentImage* newCachedImage);
/** Returns the object that was set by setCachedComponentImage().
@see setCachedComponentImage
*/
CachedComponentImage* getCachedComponentImage() const noexcept { return cachedImage.get(); }
/** 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. This is useful for Components such as sliders that
should not move when their parent Viewport when dragged.
*/
void setViewportIgnoreDragFlag (bool ignoreDrag) noexcept { flags.viewportIgnoreDragFlag = ignoreDrag; }
/** Retrieves the current state of the Viewport drag-to-scroll functionality flag.
@see setViewportIgnoreDragFlag
*/
bool getViewportIgnoreDragFlag() const noexcept { return flags.viewportIgnoreDragFlag; }
//==============================================================================
/** Returns the title text for this component.
@see setTitle
*/
String getTitle() const noexcept { return componentTitle; }
/** Sets the title for this component.
If this component supports accessibility using the default AccessibilityHandler
implementation, this string will be passed to accessibility clients requesting a
title and may be read out by a screen reader.
@see getTitle, getAccessibilityHandler
*/
void setTitle (const String& newTitle);
/** Returns the description for this component.
@see setDescription
*/
String getDescription() const noexcept { return componentDescription; }
/** Sets the description for this component.
If this component supports accessibility using the default AccessibilityHandler
implementation, this string will be passed to accessibility clients requesting a
description and may be read out by a screen reader.
@see getDescription, getAccessibilityHandler
*/
void setDescription (const String& newDescription);
/** Returns the help text for this component.
@see setHelpText
*/
String getHelpText() const noexcept { return componentHelpText; }
/** Sets the help text for this component.
If this component supports accessibility using the default AccessibilityHandler
implementation, this string will be passed to accessibility clients requesting help text
and may be read out by a screen reader.
@see getHelpText, getAccessibilityHandler
*/
void setHelpText (const String& newHelpText);
/** Sets whether this component and its children are visible to accessibility clients.
If this flag is set to false then the getAccessibilityHandler() method will return nullptr
and this component and its children will not be visible to any accessibility clients.
By default this is set to true.
@see isAccessible, getAccessibilityHandler
*/
void setAccessible (bool shouldBeAccessible);
/** Returns true if this component and its children are visible to accessibility clients.
@see setAccessible
*/
bool isAccessible() const noexcept;
/** Returns the accessibility handler for this component, or nullptr if this component is not
accessible.
@see setAccessible
*/
AccessibilityHandler* getAccessibilityHandler();
/** Invalidates the AccessibilityHandler that is currently being used for this component.
Use this to indicate that something in the accessible component has changed
and its handler needs to be updated. This will trigger a call to
createAccessibilityHandler().
*/
void invalidateAccessibilityHandler();
//==============================================================================
#ifndef DOXYGEN
[[deprecated ("Use the setFocusContainerType that takes a more descriptive enum.")]]
void setFocusContainer (bool shouldBeFocusContainer) noexcept
{
setFocusContainerType (shouldBeFocusContainer ? FocusContainerType::keyboardFocusContainer
: FocusContainerType::none);
}
[[deprecated ("Use the contains that takes a Point<int>.")]]
void contains (int, int) = delete;
#endif
private:
//==============================================================================
/** 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.
@see getAccessibilityHandler
*/
virtual std::unique_ptr<AccessibilityHandler> createAccessibilityHandler();
//==============================================================================
friend class ComponentPeer;
friend class MouseInputSource;
friend class MouseInputSourceInternal;
#ifndef DOXYGEN
static Component* currentlyFocusedComponent;
//==============================================================================
String componentName, componentID, componentTitle, componentDescription, componentHelpText;
Component* parentComponent = nullptr;
Rectangle<int> boundsRelativeToParent;
std::unique_ptr<Positioner> positioner;
std::unique_ptr<AffineTransform> affineTransform;
Array<Component*> childComponentList;
WeakReference<LookAndFeel> lookAndFeel;
MouseCursor cursor;
ImageEffectFilter* effect = nullptr;
std::unique_ptr<CachedComponentImage> cachedImage;
class MouseListenerList;
std::unique_ptr<MouseListenerList> mouseListeners;
std::unique_ptr<Array<KeyListener*>> keyListeners;
ListenerList<ComponentListener> componentListeners;
NamedValueSet properties;
friend class WeakReference<Component>;
WeakReference<Component>::Master masterReference;
std::unique_ptr<AccessibilityHandler> accessibilityHandler;
struct ComponentFlags
{
bool hasHeavyweightPeerFlag : 1;
bool visibleFlag : 1;
bool opaqueFlag : 1;
bool ignoresMouseClicksFlag : 1;
bool allowChildMouseClicksFlag : 1;
bool wantsKeyboardFocusFlag : 1;
bool isFocusContainerFlag : 1;
bool isKeyboardFocusContainerFlag : 1;
bool childKeyboardFocusedFlag : 1;
bool dontFocusOnMouseClickFlag : 1;
bool alwaysOnTopFlag : 1;
bool bufferToImageFlag : 1;
bool bringToFrontOnClickFlag : 1;
bool repaintOnMouseActivityFlag : 1;
bool isDisabledFlag : 1;
bool dontClipGraphicsFlag : 1;
bool mouseDownWasBlocked : 1;
bool isMoveCallbackPending : 1;
bool isResizeCallbackPending : 1;
bool viewportIgnoreDragFlag : 1;
bool accessibilityIgnoredFlag : 1;
bool cachedMouseInsideComponent : 1;
#if JUCE_DEBUG
bool isInsidePaintCall : 1;
#endif
};
union
{
uint32 componentFlags;
ComponentFlags flags;
};
uint8 componentTransparency = 0;
//==============================================================================
void internalMouseEnter (MouseInputSource, Point<float>, Time);
void internalMouseExit (MouseInputSource, Point<float>, Time);
void internalMouseDown (MouseInputSource, Point<float>, Time, float, float, float, float, float);
void internalMouseUp (MouseInputSource, Point<float>, Time, const ModifierKeys oldModifiers, float, float, float, float, float);
void internalMouseDrag (MouseInputSource, Point<float>, Time, float, float, float, float, float);
void internalMouseMove (MouseInputSource, Point<float>, Time);
void internalMouseWheel (MouseInputSource, Point<float>, Time, const MouseWheelDetails&);
void internalMagnifyGesture (MouseInputSource, Point<float>, Time, float);
void internalBroughtToFront();
void internalKeyboardFocusGain (FocusChangeType, const WeakReference<Component>&);
void internalKeyboardFocusGain (FocusChangeType);
void internalKeyboardFocusLoss (FocusChangeType);
void internalChildKeyboardFocusChange (FocusChangeType, const WeakReference<Component>&);
void internalModalInputAttempt();
void internalModifierKeysChanged();
void internalChildrenChanged();
void internalHierarchyChanged();
void internalRepaint (Rectangle<int>);
void internalRepaintUnchecked (Rectangle<int>, bool);
Component* removeChildComponent (int index, bool sendParentEvents, bool sendChildEvents);
void reorderChildInternal (int sourceIndex, int destIndex);
void paintComponentAndChildren (Graphics&);
void paintWithinParentContext (Graphics&);
void sendMovedResizedMessages (bool wasMoved, bool wasResized);
void sendMovedResizedMessagesIfPending();
void repaintParent();
void sendFakeMouseMove() const;
void takeKeyboardFocus (FocusChangeType);
void grabKeyboardFocusInternal (FocusChangeType, bool canTryParent);
void giveAwayKeyboardFocusInternal (bool sendFocusLossEvent);
void sendEnablementChangeMessage();
void sendVisibilityChangeMessage();
bool containsInternal (Point<float>);
bool reallyContainsInternal (Point<float>, bool);
Component* getComponentAtInternal (Point<float>);
struct ComponentHelpers;
friend struct ComponentHelpers;
/* Components aren't allowed to have copy constructors, as this would mess up parent hierarchies.
You might need to give your subclasses a private dummy constructor to avoid compiler warnings.
*/
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Component)
protected:
//==============================================================================
/** @internal */
virtual ComponentPeer* createNewPeer (int styleFlags, void* nativeWindowToAttachTo);
/** @internal */
static std::unique_ptr<AccessibilityHandler> createIgnoredAccessibilityHandler (Component&);
#endif
};
} // namespace juce
Reference in New Issue View Git Blame Copy Permalink