juce::detail::ComponentHelpers Struct Reference

#include <juce_ComponentHelpers.h>

Classes
class	ModalComponentManagerChangeNotifier

Public Types
using	SH = ScalingHelpers

Static Public Member Functions
static bool	clipChildComponent (const Component &child, Graphics &g, const Rectangle< int > clipRect, Point< int > delta)
static bool	clipObscuredRegions (const Component &comp, Graphics &g, const Rectangle< int > clipRect, Point< int > delta)
template<typename PointOrRect >
static PointOrRect	convertCoordinate (const Component *target, const Component *source, PointOrRect p)
template<typename PointOrRect >
static PointOrRect	convertFromDistantParentSpace (const Component *parent, const Component &target, PointOrRect coordInParent)
template<typename PointOrRect >
static PointOrRect	convertFromParentSpace (const Component &comp, const PointOrRect pointInParentSpace)
template<typename PointOrRect >
static PointOrRect	convertToParentSpace (const Component &comp, const PointOrRect pointInLocalSpace)
static Identifier	getColourPropertyID (int colourID)
static Rectangle< int >	getParentOrMainMonitorBounds (const Component &comp)
static bool	hitTest (Component &comp, Point< float > localPoint)
template<typename PointOrRect >
static PointOrRect	localPositionToRawPeerPos (const Component &comp, PointOrRect pos) noexcept
static bool	modalWouldBlockComponent (const Component &maybeBlocked, Component *modal)
template<typename PointOrRect >
static PointOrRect	rawPeerPositionToLocal (const Component &comp, PointOrRect pos) noexcept
static void	releaseAllCachedImageResources (Component &c)
static void *	runModalLoopCallback (void *userData)
template<typename Function >
static void	sendMouseEventToComponentsThatAreBlockedByModal (Component &modal, Function &&function)

Member Typedef Documentation

SH

using juce::detail::ComponentHelpers::SH = ScalingHelpers

Member Function Documentation

clipChildComponent()

static bool juce::detail::ComponentHelpers::clipChildComponent ( const Component &  child, Graphics &  g, const Rectangle< int >  clipRect, Point< int >  delta  )

inlinestatic

References clipObscuredRegions(), juce::Rectangle< ValueType >::getIntersection(), juce::Component::getPosition(), juce::Component::isOpaque(), juce::Component::isTransformed(), and juce::Component::isVisible().

Referenced by clipObscuredRegions().

clipObscuredRegions()

static bool juce::detail::ComponentHelpers::clipObscuredRegions ( const Component &  comp, Graphics &  g, const Rectangle< int >  clipRect, Point< int >  delta  )

inlinestatic

References clipChildComponent().

Referenced by clipChildComponent().

convertCoordinate()

template<typename PointOrRect >

static PointOrRect juce::detail::ComponentHelpers::convertCoordinate ( const Component *  target, const Component *  source, PointOrRect  p  )

inlinestatic

References convertFromDistantParentSpace(), convertFromParentSpace(), convertToParentSpace(), jassert, JUCE_BEGIN_IGNORE_WARNINGS_MSVC, and JUCE_END_IGNORE_WARNINGS_MSVC.

convertFromDistantParentSpace()

template<typename PointOrRect >

static PointOrRect juce::detail::ComponentHelpers::convertFromDistantParentSpace ( const Component *  parent, const Component &  target, PointOrRect  coordInParent  )

inlinestatic

References convertFromDistantParentSpace(), convertFromParentSpace(), jassert, JUCE_BEGIN_IGNORE_WARNINGS_MSVC, and JUCE_END_IGNORE_WARNINGS_MSVC.

Referenced by convertCoordinate(), and convertFromDistantParentSpace().

convertFromParentSpace()

template<typename PointOrRect >

static PointOrRect juce::detail::ComponentHelpers::convertFromParentSpace ( const Component &  comp, const PointOrRect  pointInParentSpace  )

inlinestatic

References juce::Component::getParentComponent(), juce::Component::getPeer(), juce::Component::isOnDesktop(), jassertfalse, juce::detail::ScalingHelpers::scaledScreenPosToUnscaled(), juce::detail::ScalingHelpers::subtractPosition(), and juce::detail::ScalingHelpers::unscaledScreenPosToScaled().

Referenced by convertCoordinate(), and convertFromDistantParentSpace().

convertToParentSpace()

template<typename PointOrRect >

static PointOrRect juce::detail::ComponentHelpers::convertToParentSpace ( const Component &  comp, const PointOrRect  pointInLocalSpace  )

inlinestatic

References juce::detail::ScalingHelpers::addPosition(), juce::Component::getParentComponent(), juce::Component::getPeer(), juce::Component::isOnDesktop(), jassertfalse, juce::detail::ScalingHelpers::scaledScreenPosToUnscaled(), and juce::detail::ScalingHelpers::unscaledScreenPosToScaled().

Referenced by convertCoordinate().

getColourPropertyID()

static Identifier juce::detail::ComponentHelpers::getColourPropertyID ( int  colourID )

inlinestatic

References juce::detail::colourPropertyPrefix, juce::end(), and juce::numElementsInArray().

getParentOrMainMonitorBounds()

static Rectangle< int > juce::detail::ComponentHelpers::getParentOrMainMonitorBounds ( const Component &  comp )

inlinestatic

References juce::Desktop::getDisplays(), juce::Desktop::getInstance(), juce::Component::getParentComponent(), juce::Displays::getPrimaryDisplay(), and juce::Displays::Display::userArea.

hitTest()

static bool juce::detail::ComponentHelpers::hitTest ( Component &  comp, Point< float >  localPoint  )

inlinestatic

References juce::Component::getHeight(), juce::Component::getWidth(), juce::Component::hitTest(), and juce::Point< ValueType >::roundToInt().

localPositionToRawPeerPos()

template<typename PointOrRect >

static PointOrRect juce::detail::ComponentHelpers::localPositionToRawPeerPos ( const Component &  comp, PointOrRect  pos  )

inlinestaticnoexcept

References juce::detail::ScalingHelpers::scaledScreenPosToUnscaled().

modalWouldBlockComponent()

static bool juce::detail::ComponentHelpers::modalWouldBlockComponent ( const Component &  maybeBlocked, Component *  modal  )

inlinestatic

References juce::Component::canModalEventBeSentToComponent(), and juce::Component::isParentOf().

Referenced by sendMouseEventToComponentsThatAreBlockedByModal().

rawPeerPositionToLocal()

template<typename PointOrRect >

static PointOrRect juce::detail::ComponentHelpers::rawPeerPositionToLocal ( const Component &  comp, PointOrRect  pos  )

inlinestaticnoexcept

References juce::detail::ScalingHelpers::unscaledScreenPosToScaled().

releaseAllCachedImageResources()

static void juce::detail::ComponentHelpers::releaseAllCachedImageResources ( Component &  c )

inlinestatic

References releaseAllCachedImageResources().

Referenced by releaseAllCachedImageResources().

runModalLoopCallback()

static void * juce::detail::ComponentHelpers::runModalLoopCallback ( void *  userData )

inlinestatic

References juce::Component::runModalLoop().

sendMouseEventToComponentsThatAreBlockedByModal()

template<typename Function >

static void juce::detail::ComponentHelpers::sendMouseEventToComponentsThatAreBlockedByModal ( Component &  modal, Function &&  function  )

inlinestatic

References juce::Time::getCurrentTime(), juce::Desktop::getInstance(), juce::Desktop::getMouseSources(), modalWouldBlockComponent(), and juce::detail::ScalingHelpers::screenPosToLocalPos().

---

The documentation for this struct was generated from the following file:

• juce_ComponentHelpers.h