A debugging tool that displays component hierarchy and properties. More...

#include <gin_componentviewer.h>

Inherits juce::DocumentWindow, and juce::ComponentListener.

Public Member Functions
	ComponentViewer (Component toTrack=nullptr, juce::PropertiesFile settings=nullptr, bool alwaysOnTop=true)
	Creates a ComponentViewer window.

	~ComponentViewer () override
	Destructor.

Public Attributes
std::function< void()>	onClose
	Callback invoked when the user requests to close the window.

Detailed Description

A debugging tool that displays component hierarchy and properties.

ComponentViewer is a window that shows information about the component under the mouse cursor, including its position, size, class name, and component hierarchy. This is extremely useful for debugging UI layouts and understanding component structures during development.

Features:

Shows component under mouse in real-time
Displays component hierarchy tree
Shows component properties (bounds, class name, etc.)
Optional window position persistence
Auto-cleanup when tracked component is deleted
Can be set to always-on-top

Example usage:

auto* viewer = new ComponentViewer (mainComponent, nullptr, true);
viewer->setVisible (true);
// ComponentViewer will delete itself when closed or when mainComponent is deleted

See also: onClose

Constructor & Destructor Documentation

◆ ComponentViewer()

ComponentViewer::ComponentViewer	(	Component *	toTrack = `nullptr`,
		juce::PropertiesFile *	settings = `nullptr`,
		bool	alwaysOnTop = `true`
	)

Creates a ComponentViewer window.

Parameters

toTrack	Optional component to track - when this component is deleted, the ComponentViewer will automatically be deleted as well. Pass nullptr to disable this feature.
settings	Optional PropertiesFile for storing window position. Pass nullptr to use a default settings file.
alwaysOnTop	If true, the window will stay on top of other windows

◆ ~ComponentViewer()

ComponentViewer::~ComponentViewer ( )

override

Destructor.

Member Data Documentation

◆ onClose

std::function<void ()> ComponentViewer::onClose

Callback invoked when the user requests to close the window.

By default, the ComponentViewer deletes itself when closed. You can override this behavior by setting this callback to perform custom cleanup.

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

gin_componentviewer.h