#include <juce_ComponentPeer.h>

Inheritance diagram for juce::ComponentPeer:

Classes
class	OptionalBorderSize
struct	DragInfo
struct	ScaleFactorListener

Public Types
enum	StyleFlags { windowAppearsOnTaskbar = (1 << 0) , windowIsTemporary = (1 << 1) , windowIgnoresMouseClicks = (1 << 2) , windowHasTitleBar = (1 << 3) , windowIsResizable = (1 << 4) , windowHasMinimiseButton = (1 << 5) , windowHasMaximiseButton = (1 << 6) , windowHasCloseButton = (1 << 7) , windowHasDropShadow = (1 << 8) , windowRepaintedExplictly = (1 << 9) , windowIgnoresKeyPresses = (1 << 10) , windowRequiresSynchronousCoreGraphicsRendering = (1 << 11) , windowIsSemiTransparent = (1 << 30) }
enum class	Style { automatic , light , dark }

Public Member Functions
	ComponentPeer (Component &component, int styleFlags)
	~ComponentPeer () override
Component &	getComponent () noexcept
int	getStyleFlags () const noexcept
uint32	getUniqueID () const noexcept
virtual void *	getNativeHandle () const =0
virtual void	setVisible (bool shouldBeVisible)=0
virtual void	setTitle (const String &title)=0
virtual bool	setDocumentEditedStatus (bool edited)
virtual void	setRepresentedFile (const File &)
virtual void	setBounds (const Rectangle< int > &newBounds, bool isNowFullScreen)=0
void	updateBounds ()
virtual Rectangle< int >	getBounds () const =0
virtual Point< float >	localToGlobal (Point< float > relativePosition)=0
virtual Point< float >	globalToLocal (Point< float > screenPosition)=0
Point< int >	localToGlobal (Point< int > relativePosition)
Point< int >	globalToLocal (Point< int > screenPosition)
virtual Rectangle< int >	localToGlobal (const Rectangle< int > &relativePosition)
virtual Rectangle< int >	globalToLocal (const Rectangle< int > &screenPosition)
Rectangle< float >	localToGlobal (const Rectangle< float > &relativePosition)
Rectangle< float >	globalToLocal (const Rectangle< float > &screenPosition)
Rectangle< int >	getAreaCoveredBy (const Component &subComponent) const
virtual void	setMinimised (bool shouldBeMinimised)=0
virtual bool	isMinimised () const =0
virtual void	setFullScreen (bool shouldBeFullScreen)=0
virtual bool	isFullScreen () const =0
virtual bool	isKioskMode () const
void	setNonFullScreenBounds (const Rectangle< int > &newBounds) noexcept
const Rectangle< int > &	getNonFullScreenBounds () const noexcept
virtual void	setIcon (const Image &newIcon)=0
void	setConstrainer (ComponentBoundsConstrainer *newConstrainer) noexcept
ComponentBoundsConstrainer *	getConstrainer () const noexcept
virtual bool	contains (Point< int > localPos, bool trueIfInAChildWindow) const =0
virtual OptionalBorderSize	getFrameSizeIfPresent () const =0
virtual BorderSize< int >	getFrameSize () const =0
void	handleMovedOrResized ()
virtual void	handleScreenSizeChange ()
void	handlePaint (LowLevelGraphicsContext &contextToPaintTo)
virtual bool	setAlwaysOnTop (bool alwaysOnTop)=0
virtual void	toFront (bool takeKeyboardFocus)=0
virtual void	toBehind (ComponentPeer *other)=0
void	handleBroughtToFront ()
virtual bool	isFocused () const =0
virtual void	grabFocus ()=0
void	handleFocusGain ()
void	handleFocusLoss ()
Component *	getLastFocusedSubcomponent () const noexcept
bool	handleKeyPress (int keyCode, juce_wchar textCharacter)
bool	handleKeyPress (const KeyPress &key)
bool	handleKeyUpOrDown (bool isKeyDown)
void	handleModifierKeysChange ()
virtual void	closeInputMethodContext ()
void	refreshTextInputTarget ()
TextInputTarget *	findCurrentTextInputTarget ()
virtual void	repaint (const Rectangle< int > &area)=0
virtual void	performAnyPendingRepaintsNow ()=0
virtual void	setAlpha (float newAlpha)=0
void	handleMouseEvent (MouseInputSource::InputSourceType type, Point< float > positionWithinPeer, ModifierKeys newMods, float pressure, float orientation, int64 time, PenDetails pen={}, int touchIndex=0)
void	handleMouseWheel (MouseInputSource::InputSourceType type, Point< float > positionWithinPeer, int64 time, const MouseWheelDetails &, int touchIndex=0)
void	handleMagnifyGesture (MouseInputSource::InputSourceType type, Point< float > positionWithinPeer, int64 time, float scaleFactor, int touchIndex=0)
void	handleUserClosingWindow ()
bool	handleDragMove (const DragInfo &)
bool	handleDragExit (const DragInfo &)
bool	handleDragDrop (const DragInfo &)
virtual StringArray	getAvailableRenderingEngines ()=0
virtual int	getCurrentRenderingEngine () const
virtual void	setCurrentRenderingEngine (int index)
void	addScaleFactorListener (ScaleFactorListener *listenerToAdd)
void	removeScaleFactorListener (ScaleFactorListener *listenerToRemove)
virtual double	getPlatformScaleFactor () const noexcept
virtual void	setHasChangedSinceSaved (bool)
void	setAppStyle (Style s)
Style	getAppStyle () const

Static Public Member Functions
static int	getNumPeers () noexcept
static ComponentPeer *	getPeer (int index) noexcept
static ComponentPeer *	getPeerFor (const Component *) noexcept
static bool	isValidPeer (const ComponentPeer *peer) noexcept
static ModifierKeys	getCurrentModifiersRealtime () noexcept

Static Protected Member Functions
static void	forceDisplayUpdate ()

Protected Attributes
Component &	component
const int	styleFlags
Rectangle< int >	lastNonFullscreenBounds
ComponentBoundsConstrainer *	constrainer = nullptr
ListenerList< ScaleFactorListener >	scaleFactorListeners
Style	style = Style::automatic

Static Protected Attributes
static std::function< ModifierKeys()>	getNativeRealtimeModifiers = nullptr

Private Member Functions
virtual void	appStyleChanged ()
virtual void	textInputRequired (Point< int >, TextInputTarget &)=0
virtual void	dismissPendingTextInput ()
void	globalFocusChanged (Component *) override
Component *	getTargetForKeyPress ()
Private Member Functions inherited from juce::FocusChangeListener
virtual	~FocusChangeListener ()=default

Private Attributes
WeakReference< Component >	lastFocusedComponent
WeakReference< Component >	dragAndDropTargetComponent
Component *	lastDragAndDropCompUnderMouse = nullptr
TextInputTarget *	textInputTarget = nullptr
const uint32	uniqueID
bool	isWindowMinimised = false

Detailed Description

The Component class uses a ComponentPeer internally to create and manage a real operating-system window.

This is an abstract base class - the platform specific code contains implementations of it for the various platforms.

User-code should very rarely need to have any involvement with this class.

See also: Component::createNewPeer

@tags{GUI}

Member Enumeration Documentation

◆ Style

enum class juce::ComponentPeer::Style

strong

Enumerator
automatic	A style that matches the system-wide style.
light	A light style, which will probably use dark text on a light background.
dark	A dark style, which will probably use light text on a dark background.

◆ StyleFlags

enum juce::ComponentPeer::StyleFlags

A combination of these flags is passed to the ComponentPeer constructor.

Enumerator
windowAppearsOnTaskbar	Indicates that the window should have a corresponding entry on the taskbar (ignored on MacOSX)
windowIsTemporary	Indicates that the window is a temporary popup, like a menu, tooltip, etc.
windowIgnoresMouseClicks	Indicates that the window should let mouse clicks pass through it (may not be possible on some platforms).
windowHasTitleBar	Indicates that the window should have a normal OS-specific title bar and frame. if not specified, the window will be borderless.
windowIsResizable	Indicates that the window should have a resizable border.
windowHasMinimiseButton	Indicates that if the window has a title bar, it should have a minimise button on it.
windowHasMaximiseButton	Indicates that if the window has a title bar, it should have a maximise button on it.
windowHasCloseButton	Indicates that if the window has a title bar, it should have a close button on it.
windowHasDropShadow	Indicates that the window should have a drop-shadow (this may not be possible on all platforms).
windowRepaintedExplictly	Not intended for public use - this tells a window not to do its own repainting, but only to repaint when the performAnyPendingRepaintsNow() method is called.
windowIgnoresKeyPresses	Tells the window not to catch any keypresses. This can be used for things like plugin windows, to stop them interfering with the host's shortcut keys.
windowRequiresSynchronousCoreGraphicsRendering	Indicates that the window should not be rendered with asynchronous Core Graphics drawing operations. Use this if there are issues with regions not being redrawn at the expected time (macOS and iOS only).
windowIsSemiTransparent	Not intended for public use - makes a window transparent.

Constructor & Destructor Documentation

◆ ComponentPeer()

juce::ComponentPeer::ComponentPeer	(	Component &	component,
		int	styleFlags )

Creates a peer.

The component is the one that we intend to represent, and the style flags are a combination of the values in the StyleFlags enum

◆ ~ComponentPeer()

juce::ComponentPeer::~ComponentPeer ( )

override

Destructor.

Member Function Documentation

◆ addScaleFactorListener()

void juce::ComponentPeer::addScaleFactorListener ( ScaleFactorListener * listenerToAdd )

inline

Adds a scale factor listener.

◆ appStyleChanged()

virtual void juce::ComponentPeer::appStyleChanged ( )

inlineprivatevirtual

◆ closeInputMethodContext()

void juce::ComponentPeer::closeInputMethodContext ( )

virtual

If there's a currently active input-method context - i.e. characters are being composed using multiple keystrokes - this should commit the current state of the context to the text and clear the context. This should not hide the virtual keyboard.

Reimplemented in juce::HWNDComponentPeer.

◆ contains()

virtual bool juce::ComponentPeer::contains	(	Point< int >	localPos,
		bool	trueIfInAChildWindow ) const

pure virtual

Checks if a point is in the window.

The position is relative to the top-left of this window, in unscaled peer coordinates. If trueIfInAChildWindow is false, then this returns false if the point is actually inside a child of this window.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ dismissPendingTextInput()

void juce::ComponentPeer::dismissPendingTextInput ( )

privatevirtual

If there's some kind of OS input-method in progress, this should dismiss it.

Overrides of this function should call closeInputMethodContext().

This function should not be called directly by Components - use refreshTextInputTarget instead.

Reimplemented in juce::HWNDComponentPeer.

◆ findCurrentTextInputTarget()

TextInputTarget * juce::ComponentPeer::findCurrentTextInputTarget ( )

Returns the currently focused TextInputTarget, or null if none is found.

◆ forceDisplayUpdate()

void juce::ComponentPeer::forceDisplayUpdate ( )

staticprotected

◆ getAppStyle()

Style juce::ComponentPeer::getAppStyle ( ) const

inline

Returns the style requested for this app.

◆ getAreaCoveredBy()

Rectangle< int > juce::ComponentPeer::getAreaCoveredBy ( const Component & subComponent ) const

Returns the area in peer coordinates that is covered by the given sub-comp (which may be at any depth)

◆ getAvailableRenderingEngines()

virtual StringArray juce::ComponentPeer::getAvailableRenderingEngines ( )

pure virtual

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ getBounds()

virtual Rectangle< int > juce::ComponentPeer::getBounds ( ) const

pure virtual

Returns the current position and size of the window.

If the native window is contained in another window, then the coordinates are relative to the parent window's origin, not the screen origin.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ getComponent()

Component & juce::ComponentPeer::getComponent ( )

inlinenoexcept

Returns the component being represented by this peer.

◆ getConstrainer()

ComponentBoundsConstrainer * juce::ComponentPeer::getConstrainer ( ) const

inlinenoexcept

Returns the current constrainer, if one has been set.

◆ getCurrentModifiersRealtime()

ModifierKeys juce::ComponentPeer::getCurrentModifiersRealtime ( )

staticnoexcept

On desktop platforms this method will check all the mouse and key states and return a ModifierKeys object representing them.

This isn't recommended and is only needed in special circumstances for up-to-date modifier information at times when the app's event loop isn't running normally.

Another reason to avoid this method is that it's not stateless and calling it may update the ModifierKeys::currentModifiers object, which could cause subtle changes in the behaviour of some components.

◆ getCurrentRenderingEngine()

int juce::ComponentPeer::getCurrentRenderingEngine ( ) const

virtual

Reimplemented in juce::HWNDComponentPeer.

◆ getFrameSize()

virtual BorderSize< int > juce::ComponentPeer::getFrameSize ( ) const

pure virtual

Returns the size of the window frame that's around this window. Whether or not the window has a normal window frame depends on the flags that were set when the window was created by Component::addToDesktop()

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ getFrameSizeIfPresent()

virtual OptionalBorderSize juce::ComponentPeer::getFrameSizeIfPresent ( ) const

pure virtual

Returns the size of the window frame that's around this window.

Depending on the platform the border size may be invalid for a short transient after creating a new window. Hence the returned value must be checked using operator bool() and the contained value can be accessed using operator*() only if it is present.

Whether or not the window has a normal window frame depends on the flags that were set when the window was created by Component::addToDesktop()

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ getLastFocusedSubcomponent()

Component * juce::ComponentPeer::getLastFocusedSubcomponent ( ) const

noexcept

◆ getNativeHandle()

virtual void * juce::ComponentPeer::getNativeHandle ( ) const

pure virtual

Returns the raw handle to whatever kind of window is being used.

On windows, this is probably a HWND, on the mac, it's likely to be a WindowRef, but remember there's no guarantees what you'll get back.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ getNonFullScreenBounds()

const Rectangle< int > & juce::ComponentPeer::getNonFullScreenBounds ( ) const

noexcept

Returns the size to restore to if fullscreen mode is turned off.

◆ getNumPeers()

int juce::ComponentPeer::getNumPeers ( )

staticnoexcept

Returns the number of currently-active peers.

See also: getPeer

◆ getPeer()

ComponentPeer * juce::ComponentPeer::getPeer ( int index )

staticnoexcept

Returns one of the currently-active peers.

See also: getNumPeers

◆ getPeerFor()

ComponentPeer * juce::ComponentPeer::getPeerFor ( const Component * component )

staticnoexcept

Returns the peer that's attached to the given component, or nullptr if there isn't one.

◆ getPlatformScaleFactor()

virtual double juce::ComponentPeer::getPlatformScaleFactor ( ) const

inlinevirtualnoexcept

On Windows and Linux this will return the OS scaling factor currently being applied to the native window. This is used to convert between physical and logical pixels at the OS API level and you shouldn't need to use it in your own code unless you are dealing directly with the native window.

Reimplemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ getStyleFlags()

int juce::ComponentPeer::getStyleFlags ( ) const

inlinenoexcept

Returns the set of style flags that were set when the window was created.

See also: Component::addToDesktop

◆ getTargetForKeyPress()

Component * juce::ComponentPeer::getTargetForKeyPress ( )

private

◆ getUniqueID()

uint32 juce::ComponentPeer::getUniqueID ( ) const

inlinenoexcept

Returns a unique ID for this peer. Each peer that is created is given a different ID.

◆ globalFocusChanged()

void juce::ComponentPeer::globalFocusChanged ( Component * focusedComponent )

overrideprivatevirtual

Callback to indicate that the currently focused component has changed.

Implements juce::FocusChangeListener.

◆ globalToLocal() [1/4]

Rectangle< float > juce::ComponentPeer::globalToLocal ( const Rectangle< float > & screenPosition )

Converts a screen area to a position relative to the top-left of this component.

◆ globalToLocal() [2/4]

Rectangle< int > juce::ComponentPeer::globalToLocal ( const Rectangle< int > & screenPosition )

virtual

Converts a screen area to a position relative to the top-left of this component.

Reimplemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ globalToLocal() [3/4]

virtual Point< float > juce::ComponentPeer::globalToLocal ( Point< float > screenPosition )

pure virtual

Converts a screen coordinate to a position relative to the top-left of this component.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ globalToLocal() [4/4]

Point< int > juce::ComponentPeer::globalToLocal ( Point< int > screenPosition )

Converts a screen coordinate to a position relative to the top-left of this component.

◆ grabFocus()

virtual void juce::ComponentPeer::grabFocus ( )

pure virtual

Tries to give the window keyboard focus.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ handleBroughtToFront()

void juce::ComponentPeer::handleBroughtToFront ( )

Called when the window is brought to the front, either by the OS or by a call to toFront().

◆ handleDragDrop()

bool juce::ComponentPeer::handleDragDrop ( const DragInfo & info )

◆ handleDragExit()

bool juce::ComponentPeer::handleDragExit ( const DragInfo & info )

◆ handleDragMove()

bool juce::ComponentPeer::handleDragMove ( const DragInfo & info )

◆ handleFocusGain()

void juce::ComponentPeer::handleFocusGain ( )

Called when the window gains keyboard focus.

◆ handleFocusLoss()

void juce::ComponentPeer::handleFocusLoss ( )

Called when the window loses keyboard focus.

◆ handleKeyPress() [1/2]

bool juce::ComponentPeer::handleKeyPress ( const KeyPress & key )

Called when a key is pressed. Returns true if the keystroke was used.

◆ handleKeyPress() [2/2]

bool juce::ComponentPeer::handleKeyPress	(	int	keyCode,
		juce_wchar	textCharacter )

Called when a key is pressed. For keycode info, see the KeyPress class. Returns true if the keystroke was used.

◆ handleKeyUpOrDown()

bool juce::ComponentPeer::handleKeyUpOrDown ( bool isKeyDown )

Called whenever a key is pressed or released. Returns true if the keystroke was used.

◆ handleMagnifyGesture()

void juce::ComponentPeer::handleMagnifyGesture	(	MouseInputSource::InputSourceType	type,
		Point< float >	positionWithinPeer,
		int64	time,
		float	scaleFactor,
		int	touchIndex = 0 )

◆ handleModifierKeysChange()

void juce::ComponentPeer::handleModifierKeysChange ( )

Called whenever a modifier key is pressed or released.

◆ handleMouseEvent()

void juce::ComponentPeer::handleMouseEvent	(	MouseInputSource::InputSourceType	type,
		Point< float >	positionWithinPeer,
		ModifierKeys	newMods,
		float	pressure,
		float	orientation,
		int64	time,
		PenDetails	pen = {},
		int	touchIndex = 0 )

◆ handleMouseWheel()

void juce::ComponentPeer::handleMouseWheel	(	MouseInputSource::InputSourceType	type,
		Point< float >	positionWithinPeer,
		int64	time,
		const MouseWheelDetails &	wheel,
		int	touchIndex = 0 )

◆ handleMovedOrResized()

void juce::ComponentPeer::handleMovedOrResized ( )

This is called when the window's bounds change. A peer implementation must call this when the window is moved and resized, so that this method can pass the message on to the component.

◆ handlePaint()

void juce::ComponentPeer::handlePaint ( LowLevelGraphicsContext & contextToPaintTo )

This is called to repaint the component into the given context.

If this fails, it's probably be because your CPU floating-point precision mode has been set to low.. This setting is sometimes changed by things like Direct3D, and can mess up a lot of the calculations that the library needs to do.

◆ handleScreenSizeChange()

void juce::ComponentPeer::handleScreenSizeChange ( )

virtual

This is called if the screen resolution changes. A peer implementation must call this if the monitor arrangement changes or the available screen size changes.

◆ handleUserClosingWindow()

void juce::ComponentPeer::handleUserClosingWindow ( )

◆ isFocused()

virtual bool juce::ComponentPeer::isFocused ( ) const

pure virtual

True if the window has the keyboard focus.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ isFullScreen()

virtual bool juce::ComponentPeer::isFullScreen ( ) const

pure virtual

True if the window is currently full-screen.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ isKioskMode()

bool juce::ComponentPeer::isKioskMode ( ) const

virtual

True if the window is in kiosk-mode.

◆ isMinimised()

virtual bool juce::ComponentPeer::isMinimised ( ) const

pure virtual

True if the window is currently minimised.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ isValidPeer()

bool juce::ComponentPeer::isValidPeer ( const ComponentPeer * peer )

staticnoexcept

Checks if this peer object is valid.

See also: getNumPeers

◆ localToGlobal() [1/4]

Rectangle< float > juce::ComponentPeer::localToGlobal ( const Rectangle< float > & relativePosition )

Converts a rectangle relative to the top-left of this component to screen coordinates.

◆ localToGlobal() [2/4]

Rectangle< int > juce::ComponentPeer::localToGlobal ( const Rectangle< int > & relativePosition )

virtual

Converts a rectangle relative to the top-left of this component to screen coordinates.

Reimplemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ localToGlobal() [3/4]

virtual Point< float > juce::ComponentPeer::localToGlobal ( Point< float > relativePosition )

pure virtual

Converts a position relative to the top-left of this component to screen coordinates.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ localToGlobal() [4/4]

Point< int > juce::ComponentPeer::localToGlobal ( Point< int > relativePosition )

Converts a position relative to the top-left of this component to screen coordinates.

◆ performAnyPendingRepaintsNow()

virtual void juce::ComponentPeer::performAnyPendingRepaintsNow ( )

pure virtual

This can be called (from the message thread) to cause the immediate redrawing of any areas of this window that need repainting.

You shouldn't ever really need to use this, it's mainly for special purposes like supporting audio plugins where the host's event loop is out of our control.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ refreshTextInputTarget()

void juce::ComponentPeer::refreshTextInputTarget ( )

Alerts the peer that the current text input target has changed somehow.

The peer may hide or show the virtual keyboard as a result of this call.

◆ removeScaleFactorListener()

void juce::ComponentPeer::removeScaleFactorListener ( ScaleFactorListener * listenerToRemove )

inline

Removes a scale factor listener.

◆ repaint()

virtual void juce::ComponentPeer::repaint ( const Rectangle< int > & area )

pure virtual

Invalidates a region of the window to be repainted asynchronously.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ setAlpha()

virtual void juce::ComponentPeer::setAlpha ( float newAlpha )

pure virtual

Changes the window's transparency.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ setAlwaysOnTop()

virtual bool juce::ComponentPeer::setAlwaysOnTop ( bool alwaysOnTop )

pure virtual

Sets this window to either be always-on-top or normal. Some kinds of window might not be able to do this, so should return false.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ setAppStyle()

void juce::ComponentPeer::setAppStyle ( Style s )

inline

On operating systems that support it, this will update the style of this peer as requested.

Note that this will not update the theme system-wide. This will only update UI elements so that they display appropriately for this peer!

◆ setBounds()

virtual void juce::ComponentPeer::setBounds	(	const Rectangle< int > &	newBounds,
		bool	isNowFullScreen )

pure virtual

Moves and resizes the window.

If the native window is contained in another window, then the coordinates are relative to the parent window's origin, not the screen origin.

This should result in a callback to handleMovedOrResized().

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ setConstrainer()

void juce::ComponentPeer::setConstrainer ( ComponentBoundsConstrainer * newConstrainer )

noexcept

Sets a constrainer to use if the peer can resize itself. The constrainer won't be deleted by this object, so the caller must manage its lifetime.

◆ setCurrentRenderingEngine()

void juce::ComponentPeer::setCurrentRenderingEngine ( int index )

virtual

Reimplemented in juce::HWNDComponentPeer.

◆ setDocumentEditedStatus()

bool juce::ComponentPeer::setDocumentEditedStatus ( bool edited )

virtual

If this type of window is capable of indicating that the document in it has been edited, then this changes its status.

For example in OSX, this changes the appearance of the close button.

Returns: true if the window has a mechanism for showing this, or false if not.

◆ setFullScreen()

virtual void juce::ComponentPeer::setFullScreen ( bool shouldBeFullScreen )

pure virtual

Enable/disable fullscreen mode for the window.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ setHasChangedSinceSaved()

virtual void juce::ComponentPeer::setHasChangedSinceSaved ( bool )

inlinevirtual

On platforms that support it, this will update the window's titlebar in some way to indicate that the window's document needs saving.

◆ setIcon()

virtual void juce::ComponentPeer::setIcon ( const Image & newIcon )

pure virtual

Attempts to change the icon associated with this window.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ setMinimised()

virtual void juce::ComponentPeer::setMinimised ( bool shouldBeMinimised )

pure virtual

Minimises the window.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ setNonFullScreenBounds()

void juce::ComponentPeer::setNonFullScreenBounds ( const Rectangle< int > & newBounds )

noexcept

Sets the size to restore to if fullscreen mode is turned off.

◆ setRepresentedFile()

void juce::ComponentPeer::setRepresentedFile ( const File & )

virtual

If this type of window is capable of indicating that it represents a file, then this lets you set the file.

E.g. in OSX it'll show an icon for the file in the title bar.

◆ setTitle()

virtual void juce::ComponentPeer::setTitle ( const String & title )

pure virtual

Changes the title of the window.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ setVisible()

virtual void juce::ComponentPeer::setVisible ( bool shouldBeVisible )

pure virtual

Shows or hides the window.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ textInputRequired()

virtual void juce::ComponentPeer::textInputRequired	(	Point< int >	,
		TextInputTarget &	)

privatepure virtual

Tells the window that text input may be required at the given position. This may cause things like a virtual on-screen keyboard to appear, depending on the OS.

This function should not be called directly by Components - use refreshTextInputTarget instead.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ toBehind()

virtual void juce::ComponentPeer::toBehind ( ComponentPeer * other )

pure virtual

Moves the window to be just behind another one.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ toFront()

virtual void juce::ComponentPeer::toFront ( bool takeKeyboardFocus )

pure virtual

Brings the window to the top, optionally also giving it keyboard focus.

Implemented in juce::HWNDComponentPeer, and juce::LinuxComponentPeer.

◆ updateBounds()

void juce::ComponentPeer::updateBounds ( )

Updates the peer's bounds to match its component.

Member Data Documentation

◆ component

Component& juce::ComponentPeer::component

protected

◆ constrainer

ComponentBoundsConstrainer* juce::ComponentPeer::constrainer = nullptr

protected

◆ dragAndDropTargetComponent

WeakReference<Component> juce::ComponentPeer::dragAndDropTargetComponent

private

◆ getNativeRealtimeModifiers

std::function< ModifierKeys()> juce::ComponentPeer::getNativeRealtimeModifiers = nullptr

staticprotected

◆ isWindowMinimised

bool juce::ComponentPeer::isWindowMinimised = false

private

◆ lastDragAndDropCompUnderMouse

Component* juce::ComponentPeer::lastDragAndDropCompUnderMouse = nullptr

private

◆ lastFocusedComponent

WeakReference<Component> juce::ComponentPeer::lastFocusedComponent

private

◆ lastNonFullscreenBounds

Rectangle<int> juce::ComponentPeer::lastNonFullscreenBounds

protected

◆ scaleFactorListeners

ListenerList<ScaleFactorListener> juce::ComponentPeer::scaleFactorListeners

protected

◆ style

Style juce::ComponentPeer::style = Style::automatic

protected

◆ styleFlags

const int juce::ComponentPeer::styleFlags

protected

◆ textInputTarget

TextInputTarget* juce::ComponentPeer::textInputTarget = nullptr

private

◆ uniqueID

const uint32 juce::ComponentPeer::uniqueID

private

The documentation for this class was generated from the following files:

/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/windows/juce_ComponentPeer.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/windows/juce_ComponentPeer.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Style

◆ StyleFlags

Constructor & Destructor Documentation

◆ ComponentPeer()

◆ ~ComponentPeer()

Member Function Documentation

◆ addScaleFactorListener()

◆ appStyleChanged()

◆ closeInputMethodContext()

◆ contains()

◆ dismissPendingTextInput()

◆ findCurrentTextInputTarget()

◆ forceDisplayUpdate()

◆ getAppStyle()

◆ getAreaCoveredBy()

◆ getAvailableRenderingEngines()

◆ getBounds()

◆ getComponent()

◆ getConstrainer()

◆ getCurrentModifiersRealtime()

◆ getCurrentRenderingEngine()

◆ getFrameSize()

◆ getFrameSizeIfPresent()

◆ getLastFocusedSubcomponent()

◆ getNativeHandle()

◆ getNonFullScreenBounds()

◆ getNumPeers()

◆ getPeer()

◆ getPeerFor()

◆ getPlatformScaleFactor()

◆ getStyleFlags()

◆ getTargetForKeyPress()

◆ getUniqueID()

◆ globalFocusChanged()

◆ globalToLocal() [1/4]

◆ globalToLocal() [2/4]

◆ globalToLocal() [3/4]

◆ globalToLocal() [4/4]

◆ grabFocus()

◆ handleBroughtToFront()

◆ handleDragDrop()

◆ handleDragExit()

◆ handleDragMove()

◆ handleFocusGain()

◆ handleFocusLoss()

◆ handleKeyPress() [1/2]

◆ handleKeyPress() [2/2]

◆ handleKeyUpOrDown()

◆ handleMagnifyGesture()

◆ handleModifierKeysChange()

◆ handleMouseEvent()

◆ handleMouseWheel()

◆ handleMovedOrResized()

◆ handlePaint()

◆ handleScreenSizeChange()

◆ handleUserClosingWindow()

◆ isFocused()

◆ isFullScreen()

◆ isKioskMode()

◆ isMinimised()

◆ isValidPeer()

◆ localToGlobal() [1/4]

◆ localToGlobal() [2/4]

◆ localToGlobal() [3/4]

◆ localToGlobal() [4/4]

◆ performAnyPendingRepaintsNow()

◆ refreshTextInputTarget()

◆ removeScaleFactorListener()

◆ repaint()