A tree-view component. More...

Inheritance diagram for TreeView:

Classes
struct	LookAndFeelMethods
	This abstract base class is implemented by LookAndFeel classes to provide treeview drawing functionality. More...

Public Types
enum	ColourIds { backgroundColourId = 0x1000500, linesColourId = 0x1000501, dragAndDropIndicatorColourId = 0x1000502, selectedItemBackgroundColourId = 0x1000503, oddItemsColourId = 0x1000504, evenItemsColourId = 0x1000505 }
	A set of colour IDs to use to change the colour of various aspects of the treeview. More...

Public Types inherited from Component
enum	FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
	Enumeration used by the focusGained() and focusLost() methods. More...

Public Member Functions
	TreeView (const String &componentName=String())
	Creates an empty treeview. More...

	~TreeView () override
	Destructor. More...

void	setRootItem (TreeViewItem *newRootItem)
	Sets the item that is displayed in the treeview. More...

TreeViewItem *	getRootItem () const noexcept
	Returns the tree's root item. More...

void	deleteRootItem ()
	This will remove and delete the current root item. More...

void	setRootItemVisible (bool shouldBeVisible)
	Changes whether the tree's root item is shown or not. More...

bool	isRootItemVisible () const noexcept
	Returns true if the root item is visible. More...

void	setDefaultOpenness (bool isOpenByDefault)
	Sets whether items are open or closed by default. More...

bool	areItemsOpenByDefault () const noexcept
	Returns true if the tree's items default to being open. More...

void	setMultiSelectEnabled (bool canMultiSelect)
	This sets a flag to indicate that the tree can be used for multi-selection. More...

bool	isMultiSelectEnabled () const noexcept
	Returns whether multi-select has been enabled for the tree. More...

void	setOpenCloseButtonsVisible (bool shouldBeVisible)
	Sets a flag to indicate whether to hide the open/close buttons. More...

bool	areOpenCloseButtonsVisible () const noexcept
	Returns whether open/close buttons are shown. More...

void	clearSelectedItems ()
	Deselects any items that are currently selected. More...

int	getNumSelectedItems (int maximumDepthToSearchTo=-1) const noexcept
	Returns the number of items that are currently selected. More...

TreeViewItem *	getSelectedItem (int index) const noexcept
	Returns one of the selected items in the tree. More...

void	moveSelectedRow (int deltaRows)
	Moves the selected row up or down by the specified number of rows. More...

int	getNumRowsInTree () const
	Returns the number of rows the tree is using. More...

TreeViewItem *	getItemOnRow (int index) const
	Returns the item on a particular row of the tree. More...

TreeViewItem *	getItemAt (int yPosition) const noexcept
	Returns the item that contains a given y position. More...

void	scrollToKeepItemVisible (TreeViewItem *item)
	Tries to scroll the tree so that this item is on-screen somewhere. More...

Viewport *	getViewport () const noexcept
	Returns the treeview's Viewport object. More...

int	getIndentSize () noexcept
	Returns the number of pixels by which each nested level of the tree is indented. More...

void	setIndentSize (int newIndentSize)
	Changes the distance by which each nested level of the tree is indented. More...

TreeViewItem *	findItemFromIdentifierString (const String &identifierString) const
	Searches the tree for an item with the specified identifier. More...

std::unique_ptr< XmlElement >	getOpennessState (bool alsoIncludeScrollPosition) const
	Saves the current state of open/closed nodes so it can be restored later. More...

void	restoreOpennessState (const XmlElement &newState, bool restoreStoredSelection)
	Restores a previously saved arrangement of open/closed nodes. More...

void	paint (Graphics &) override

void	resized () override

bool	keyPressed (const KeyPress &) override

void	colourChanged () override

void	enablementChanged () override

bool	isInterestedInFileDrag (const StringArray &files) override

void	fileDragEnter (const StringArray &files, int x, int y) override

void	fileDragMove (const StringArray &files, int x, int y) override

void	fileDragExit (const StringArray &files) override

void	filesDropped (const StringArray &files, int x, int y) override

bool	isInterestedInDragSource (const SourceDetails &) override

void	itemDragEnter (const SourceDetails &) override

void	itemDragMove (const SourceDetails &) override

void	itemDragExit (const SourceDetails &) override

void	itemDropped (const SourceDetails &) override

Public Member Functions inherited from Component
	Component () noexcept
	Creates a component. More...

	~Component () override
	Destructor. More...

	Component (const String &componentName) noexcept
	Creates a component, setting its name at the same time. More...

const String &	getName () const noexcept
	Returns the name of this component. More...

virtual void	setName (const String &newName)
	Sets the name of this component. More...

const String &	getComponentID () const noexcept
	Returns the ID string that was set by setComponentID(). More...

void	setComponentID (const String &newID)
	Sets the component's ID string. More...

virtual void	setVisible (bool shouldBeVisible)
	Makes the component visible or invisible. More...

bool	isVisible () const noexcept
	Tests whether the component is visible or not. More...

virtual void	visibilityChanged ()
	Called when this component's visibility changes. More...

bool	isShowing () const
	Tests whether this component and all its parents are visible. More...

virtual void	addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
	Makes this component appear as a window on the desktop. More...

void	removeFromDesktop ()
	If the component is currently showing on the desktop, this will hide it. More...

bool	isOnDesktop () const noexcept
	Returns true if this component is currently showing on the desktop. More...

ComponentPeer *	getPeer () const
	Returns the heavyweight window that contains this component. More...

virtual void	userTriedToCloseWindow ()
	For components on the desktop, this is called if the system wants to close the window. More...

virtual void	minimisationStateChanged (bool isNowMinimised)
	Called for a desktop component which has just been minimised or un-minimised. More...

virtual float	getDesktopScaleFactor () const
	Returns the default scale factor to use for this component when it is placed on the desktop. More...

void	toFront (bool shouldAlsoGainFocus)
	Brings the component to the front of its siblings. More...

void	toBack ()
	Changes this component's z-order to be at the back of all its siblings. More...

void	toBehind (Component *other)
	Changes this component's z-order so that it's just behind another component. More...

void	setAlwaysOnTop (bool shouldStayOnTop)
	Sets whether the component should always be kept at the front of its siblings. More...

bool	isAlwaysOnTop () const noexcept
	Returns true if this component is set to always stay in front of its siblings. More...

int	getX () const noexcept
	Returns the x coordinate of the component's left edge. More...

int	getY () const noexcept
	Returns the y coordinate of the top of this component. More...

int	getWidth () const noexcept
	Returns the component's width in pixels. More...

int	getHeight () const noexcept
	Returns the component's height in pixels. More...

int	getRight () const noexcept
	Returns the x coordinate of the component's right-hand edge. More...

Point< int >	getPosition () const noexcept
	Returns the component's top-left position as a Point. More...

int	getBottom () const noexcept
	Returns the y coordinate of the bottom edge of this component. More...

Rectangle< int >	getBounds () const noexcept
	Returns this component's bounding box. More...

Rectangle< int >	getLocalBounds () const noexcept
	Returns the component's bounds, relative to its own origin. More...

Rectangle< int >	getBoundsInParent () const noexcept
	Returns the area of this component's parent which this component covers. More...

int	getScreenX () const
	Returns this component's x coordinate relative the screen's top-left origin. More...

int	getScreenY () const
	Returns this component's y coordinate relative the screen's top-left origin. More...

Point< int >	getScreenPosition () const
	Returns the position of this component's top-left corner relative to the screen's top-left. More...

Rectangle< int >	getScreenBounds () const
	Returns the bounds of this component, relative to the screen's top-left. More...

Point< int >	getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
	Converts a point to be relative to this component's coordinate space. More...

Point< float >	getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
	Converts a point to be relative to this component's coordinate space. More...

Rectangle< int >	getLocalArea (const Component *sourceComponent, Rectangle< int > areaRelativeToSourceComponent) const
	Converts a rectangle to be relative to this component's coordinate space. More...

Point< int >	localPointToGlobal (Point< int > localPoint) const
	Converts a point relative to this component's top-left into a screen coordinate. More...

Point< float >	localPointToGlobal (Point< float > localPoint) const
	Converts a point relative to this component's top-left into a screen coordinate. More...

Rectangle< int >	localAreaToGlobal (Rectangle< int > localArea) const
	Converts a rectangle from this component's coordinate space to a screen coordinate. More...

void	setTopLeftPosition (int x, int y)
	Moves the component to a new position. More...

void	setTopLeftPosition (Point< int > newTopLeftPosition)
	Moves the component to a new position. More...

void	setTopRightPosition (int x, int y)
	Moves the component to a new position. More...

void	setSize (int newWidth, int newHeight)
	Changes the size of the component. More...

void	setBounds (int x, int y, int width, int height)
	Changes the component's position and size. More...

void	setBounds (Rectangle< int > newBounds)
	Changes the component's position and size. More...

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. More...

void	setBoundsRelative (Rectangle< float > proportionalArea)
	Changes the component's position and size in terms of fractions of its parent's size. More...

void	setBoundsInset (BorderSize< int > borders)
	Changes the component's position and size based on the amount of space to leave around it. More...

void	setBoundsToFit (Rectangle< int > targetArea, Justification justification, bool onlyReduceInSize)
	Positions the component within a given rectangle, keeping its proportions unchanged. More...

void	setCentrePosition (int x, int y)
	Changes the position of the component's centre. More...

void	setCentrePosition (Point< int > newCentrePosition)
	Changes the position of the component's centre. More...

void	setCentreRelative (float x, float y)
	Changes the position of the component's centre. More...

void	centreWithSize (int width, int height)
	Changes the component's size and centres it within its parent. More...

void	setTransform (const AffineTransform &transform)
	Sets a transform matrix to be applied to this component. More...

AffineTransform	getTransform () const
	Returns the transform that is currently being applied to this component. More...

bool	isTransformed () const noexcept
	Returns true if a non-identity transform is being applied to this component. More...

int	proportionOfWidth (float proportion) const noexcept
	Returns a proportion of the component's width. More...

int	proportionOfHeight (float proportion) const noexcept
	Returns a proportion of the component's height. More...

int	getParentWidth () const noexcept
	Returns the width of the component's parent. More...

int	getParentHeight () const noexcept
	Returns the height of the component's parent. More...

Rectangle< int >	getParentMonitorArea () const
	Returns the screen coordinates of the monitor that contains this component. More...

int	getNumChildComponents () const noexcept
	Returns the number of child components that this component contains. More...

Component *	getChildComponent (int index) const noexcept
	Returns one of this component's child components, by it index. More...

int	getIndexOfChildComponent (const Component *child) const noexcept
	Returns the index of this component in the list of child components. More...

const Array< Component * > &	getChildren () const noexcept
	Provides access to the underlying array of child components. More...

Component *	findChildWithID (StringRef componentID) const noexcept
	Looks for a child component with the specified ID. More...

void	addChildComponent (Component *child, int zOrder=-1)
	Adds a child component to this one. More...

void	addChildComponent (Component &child, int zOrder=-1)
	Adds a child component to this one. More...

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. More...

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. More...

void	addChildAndSetID (Component *child, const String &componentID)
	Adds a child component to this one, makes it visible, and sets its component ID. More...

void	removeChildComponent (Component *childToRemove)
	Removes one of this component's child-components. More...

Component *	removeChildComponent (int childIndexToRemove)
	Removes one of this component's child-components by index. More...

void	removeAllChildren ()
	Removes all this component's children. More...

void	deleteAllChildren ()
	Removes and deletes all of this component's children. More...

Component *	getParentComponent () const noexcept
	Returns the component which this component is inside. More...

template<class TargetClass >
TargetClass *	findParentComponentOfClass () const
	Searches the parent components for a component of a specified class. More...

Component *	getTopLevelComponent () const noexcept
	Returns the highest-level component which contains this one or its parents. More...

bool	isParentOf (const Component *possibleChild) const noexcept
	Checks whether a component is anywhere inside this component or its children. More...

virtual void	parentHierarchyChanged ()
	Called to indicate that the component's parents have changed. More...

virtual void	childrenChanged ()
	Subclasses can use this callback to be told when children are added or removed, or when their z-order changes. More...

virtual bool	hitTest (int x, int y)
	Tests whether a given point is inside the component. More...

void	setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
	Changes the default return value for the hitTest() method. More...

void	getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
	Retrieves the current state of the mouse-click interception flags. More...

bool	contains (Point< int > localPoint)
	Returns true if a given point lies within this component or one of its children. More...

bool	reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
	Returns true if a given point lies in this component, taking any overlapping siblings into account. More...

Component *	getComponentAt (int x, int y)
	Returns the component at a certain point within this one. More...

Component *	getComponentAt (Point< int > position)
	Returns the component at a certain point within this one. More...

void	repaint ()
	Marks the whole component as needing to be redrawn. More...

void	repaint (int x, int y, int width, int height)
	Marks a subsection of this component as needing to be redrawn. More...

void	repaint (Rectangle< int > area)
	Marks a subsection of this component as needing to be redrawn. More...

void	setBufferedToImage (bool shouldBeBuffered)
	Makes the component use an internal buffer to optimise its redrawing. More...

Image	createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
	Generates a snapshot of part of this component. More...

void	paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
	Draws this component and all its subcomponents onto the specified graphics context. More...

void	setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
	This allows you to indicate that this component doesn't require its graphics context to be clipped when it is being painted. More...

bool	isPaintingUnclipped () const noexcept
	Returns true if this component doesn't require its graphics context to be clipped when it is being painted. More...

void	setComponentEffect (ImageEffectFilter *newEffect)
	Adds an effect filter to alter the component's appearance. More...

ImageEffectFilter *	getComponentEffect () const noexcept
	Returns the current component effect. More...

LookAndFeel &	getLookAndFeel () const noexcept
	Finds the appropriate look-and-feel to use for this component. More...

void	setLookAndFeel (LookAndFeel *newLookAndFeel)
	Sets the look and feel to use for this component. More...

virtual void	lookAndFeelChanged ()
	Called to let the component react to a change in the look-and-feel setting. More...

void	sendLookAndFeelChange ()
	Calls the lookAndFeelChanged() method in this component and all its children. More...

void	setOpaque (bool shouldBeOpaque)
	Indicates whether any parts of the component might be transparent. More...

bool	isOpaque () const noexcept
	Returns true if no parts of this component are transparent. More...

void	setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
	Indicates whether the component should be brought to the front when clicked. More...

bool	isBroughtToFrontOnMouseClick () const noexcept
	Indicates whether the component should be brought to the front when clicked-on. More...

void	setWantsKeyboardFocus (bool wantsFocus) noexcept
	Sets a flag to indicate whether this component needs keyboard focus or not. More...

bool	getWantsKeyboardFocus () const noexcept
	Returns true if the component is interested in getting keyboard focus. More...

void	setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
	Chooses whether a click on this component automatically grabs the focus. More...

bool	getMouseClickGrabsKeyboardFocus () const noexcept
	Returns the last value set with setMouseClickGrabsKeyboardFocus(). More...

void	grabKeyboardFocus ()
	Tries to give keyboard focus to this component. More...

bool	hasKeyboardFocus (bool trueIfChildIsFocused) const
	Returns true if this component currently has the keyboard focus. More...

void	moveKeyboardFocusToSibling (bool moveToNext)
	Tries to move the keyboard focus to one of this component's siblings. More...

virtual KeyboardFocusTraverser *	createFocusTraverser ()
	Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component. More...

int	getExplicitFocusOrder () const
	Returns the focus order of this component, if one has been specified. More...

void	setExplicitFocusOrder (int newFocusOrderIndex)
	Sets the index used in determining the order in which focusable components should be traversed. More...

void	setFocusContainer (bool shouldBeFocusContainer) noexcept
	Indicates whether this component is a parent for components that can have their focus traversed. More...

bool	isFocusContainer () const noexcept
	Returns true if this component has been marked as a focus container. More...

bool	isEnabled () const noexcept
	Returns true if the component (and all its parents) are enabled. More...

void	setEnabled (bool shouldBeEnabled)
	Enables or disables this component. More...

float	getAlpha () const noexcept
	Returns the component's current transparency level. More...

void	setAlpha (float newAlpha)
	Changes the transparency of this component. More...

virtual void	alphaChanged ()
	Called when setAlpha() is used to change the alpha value of this component. More...

void	setMouseCursor (const MouseCursor &cursorType)
	Changes the mouse cursor shape to use when the mouse is over this component. More...

virtual MouseCursor	getMouseCursor ()
	Returns the mouse cursor shape to use when the mouse is over this component. More...

void	updateMouseCursor () const
	Forces the current mouse cursor to be updated. More...

virtual void	paintOverChildren (Graphics &g)
	Components can override this method to draw over the top of their children. More...

void	mouseMove (const MouseEvent &event) override
	Called when the mouse moves inside a component. More...

void	mouseEnter (const MouseEvent &event) override
	Called when the mouse first enters a component. More...

void	mouseExit (const MouseEvent &event) override
	Called when the mouse moves out of a component. More...

void	mouseDown (const MouseEvent &event) override
	Called when a mouse button is pressed. More...

void	mouseDrag (const MouseEvent &event) override
	Called when the mouse is moved while a button is held down. More...

void	mouseUp (const MouseEvent &event) override
	Called when a mouse button is released. More...

void	mouseDoubleClick (const MouseEvent &event) override
	Called when a mouse button has been double-clicked on a component. More...

void	mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
	Called when the mouse-wheel is moved. More...

void	mouseMagnify (const MouseEvent &event, float scaleFactor) override
	Called when a pinch-to-zoom mouse-gesture is used. More...

void	setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
	Causes automatic repaints when the mouse enters or exits this component. More...

void	addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
	Registers a listener to be told when mouse events occur in this component. More...

void	removeMouseListener (MouseListener *listenerToRemove)
	Deregisters a mouse listener. More...

void	addKeyListener (KeyListener *newListener)
	Adds a listener that wants to hear about keypresses that this component receives. More...

void	removeKeyListener (KeyListener *listenerToRemove)
	Removes a previously-registered key listener. More...

virtual bool	keyStateChanged (bool isKeyDown)
	Called when a key is pressed or released. More...

virtual void	modifierKeysChanged (const ModifierKeys &modifiers)
	Called when a modifier key is pressed or released. More...

virtual void	focusGained (FocusChangeType cause)
	Called to indicate that this component has just acquired the keyboard focus. More...

virtual void	focusLost (FocusChangeType cause)
	Called to indicate that this component has just lost the keyboard focus. More...

virtual void	focusOfChildComponentChanged (FocusChangeType cause)
	Called to indicate a change in whether or not this component is the parent of the currently-focused component. More...

bool	isMouseOver (bool includeChildren=false) const
	Returns true if the mouse is currently over this component. More...

bool	isMouseButtonDown (bool includeChildren=false) const
	Returns true if the mouse button is currently held down in this component. More...

bool	isMouseOverOrDragging (bool includeChildren=false) const
	True if the mouse is over this component, or if it's being dragged in this component. More...

Point< int >	getMouseXYRelative () const
	Returns the mouse's current position, relative to this component. More...

virtual void	moved ()
	Called when this component's position has been changed. More...

virtual void	childBoundsChanged (Component *child)
	Called when one of this component's children is moved or resized. More...

virtual void	parentSizeChanged ()
	Called when this component's immediate parent has been resized. More...

virtual void	broughtToFront ()
	Called when this component has been moved to the front of its siblings. More...

void	addComponentListener (ComponentListener *newListener)
	Adds a listener to be told about changes to the component hierarchy or position. More...

void	removeComponentListener (ComponentListener *listenerToRemove)
	Removes a component listener. More...

void	postCommandMessage (int commandId)
	Dispatches a numbered message to this component. More...

virtual void	handleCommandMessage (int commandId)
	Called to handle a command that was sent by postCommandMessage(). More...

int	runModalLoop ()
	Runs a component modally, waiting until the loop terminates. More...

void	enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
	Puts the component into a modal state. More...

void	exitModalState (int returnValue)
	Ends a component's modal state. More...

bool	isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) const noexcept
	Returns true if this component is the modal one. More...

bool	isCurrentlyBlockedByAnotherModalComponent () const
	Checks whether there's a modal component somewhere that's stopping this one from receiving messages. More...

virtual bool	canModalEventBeSentToComponent (const Component *targetComponent)
	When a component is modal, this callback allows it to choose which other components can still receive events. More...

virtual void	inputAttemptWhenModal ()
	Called when the user tries to click on a component that is blocked by another modal component. More...

NamedValueSet &	getProperties () noexcept
	Returns the set of properties that belong to this component. More...

const NamedValueSet &	getProperties () const noexcept
	Returns the set of properties that belong to this component. More...

Colour	findColour (int colourID, bool inheritFromParent=false) const
	Looks for a colour that has been registered with the given colour ID number. More...

void	setColour (int colourID, Colour newColour)
	Registers a colour to be used for a particular purpose. More...

void	removeColour (int colourID)
	If a colour has been set with setColour(), this will remove it. More...

bool	isColourSpecified (int colourID) const
	Returns true if the specified colour ID has been explicitly set for this component using the setColour() method. More...

void	copyAllExplicitColoursTo (Component &target) const
	This looks for any colours that have been specified for this component, and copies them to the specified target component. More...

void *	getWindowHandle () const
	Returns the underlying native window handle for this component. More...

Positioner *	getPositioner () const noexcept
	Returns the Positioner object that has been set for this component. More...

void	setPositioner (Positioner *newPositioner)
	Sets a new Positioner object for this component. More...

void	setCachedComponentImage (CachedComponentImage *newCachedImage)
	Gives the component a CachedComponentImage that should be used to buffer its painting. More...

CachedComponentImage *	getCachedComponentImage () const noexcept
	Returns the object that was set by setCachedComponentImage(). More...

void	setViewportIgnoreDragFlag (bool ignoreDrag) noexcept
	Sets a flag to indicate whether mouse drag events on this Component should be ignored when it is inside a Viewport with drag-to-scroll functionality enabled. More...

bool	getViewportIgnoreDragFlag () const noexcept
	Retrieves the current state of the Viewport drag-to-scroll functionality flag. More...

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()=default
	Destructor. More...

Public Member Functions inherited from SettableTooltipClient
	~SettableTooltipClient () override=default
	Destructor. More...

virtual void	setTooltip (const String &newTooltip)
	Assigns a new tooltip to this object. More...

String	getTooltip () override
	Returns the tooltip assigned to this object. More...

Public Member Functions inherited from TooltipClient
virtual	~TooltipClient ()=default
	Destructor. More...

Public Member Functions inherited from FileDragAndDropTarget
virtual	~FileDragAndDropTarget ()=default
	Destructor. More...

Public Member Functions inherited from DragAndDropTarget
virtual	~DragAndDropTarget ()=default
	Destructor. More...

virtual bool	shouldDrawDragImageWhenOver ()
	Overriding this allows the target to tell the drag container whether to draw the drag image while the cursor is over it. More...

Additional Inherited Members
Static Public Member Functions inherited from Component
static float JUCE_CALLTYPE	getApproximateScaleFactorForComponent (Component *targetComponent)
	Returns the approximate scale factor for a given component by traversing its parent hierarchy and applying each transform and finally scaling this by the global scale factor. More...

static Component *JUCE_CALLTYPE	getCurrentlyFocusedComponent () noexcept
	Returns the component that currently has the keyboard focus. More...

static void JUCE_CALLTYPE	unfocusAllComponents ()
	If any component has keyboard focus, this will defocus it. More...

static void JUCE_CALLTYPE	beginDragAutoRepeat (int millisecondsBetweenCallbacks)
	Ensures that a non-stop stream of mouse-drag events will be sent during the current mouse-drag operation. More...

static bool JUCE_CALLTYPE	isMouseButtonDownAnywhere () noexcept
	Returns true if a mouse button is currently down. More...

static int JUCE_CALLTYPE	getNumCurrentlyModalComponents () noexcept
	Returns the number of components that are currently in a modal state. More...

static Component *JUCE_CALLTYPE	getCurrentlyModalComponent (int index=0) noexcept
	Returns one of the components that are currently modal. More...

Protected Member Functions inherited from SettableTooltipClient
	SettableTooltipClient ()=default

Detailed Description

A tree-view component.

Use one of these to hold and display a structure of TreeViewItem objects.

Member Enumeration Documentation

◆ ColourIds

enum TreeView::ColourIds

A set of colour IDs to use to change the colour of various aspects of the treeview.

These constants can be used either via the Component::setColour(), or LookAndFeel::setColour() methods.

See also: Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour

Enumerator
backgroundColourId	A background colour to fill the component with.
linesColourId	The colour to draw the lines with.
dragAndDropIndicatorColourId	The colour to use for the drag-and-drop target position indicator.
selectedItemBackgroundColourId	The colour to use to fill the background of any selected items.
oddItemsColourId	The colour to use to fill the background of the odd numbered items.
evenItemsColourId	The colour to use to fill the background of the even numbered items.

Constructor & Destructor Documentation

◆ TreeView()

TreeView::TreeView ( const String & componentName = String() )

Creates an empty treeview.

Once you've got a treeview component, you'll need to give it something to display, using the setRootItem() method.

◆ ~TreeView()

TreeView::~TreeView ( )

override

Destructor.

Member Function Documentation

◆ setRootItem()

void TreeView::setRootItem ( TreeViewItem * newRootItem )

Sets the item that is displayed in the treeview.

A tree has a single root item which contains as many sub-items as it needs. If you want the tree to contain a number of root items, you should still use a single root item above these, but hide it using setRootItemVisible().

You can pass nullptr to this method to clear the tree and remove its current root item.

The object passed in will not be deleted by the treeview, it's up to the caller to delete it when no longer needed. BUT make absolutely sure that you don't delete this item until you've removed it from the tree, either by calling setRootItem (nullptr), or by deleting the tree first. You can also use deleteRootItem() as a quick way to delete it.

◆ getRootItem()

TreeViewItem* TreeView::getRootItem ( ) const

noexcept

Returns the tree's root item.

This will be the last object passed to setRootItem(), or nullptr if none has been set.

References deleteRootItem(), and setRootItemVisible().

◆ deleteRootItem()

void TreeView::deleteRootItem ( )

This will remove and delete the current root item.

It's a convenient way of deleting the item and calling setRootItem (nullptr).

Referenced by getRootItem().

◆ setRootItemVisible()

void TreeView::setRootItemVisible ( bool shouldBeVisible )

Changes whether the tree's root item is shown or not.

If the root item is hidden, only its sub-items will be shown in the treeview - this lets you make the tree look as if it's got many root items. If it's hidden, this call will also make sure the root item is open (otherwise the treeview would look empty).

Referenced by getRootItem().

◆ isRootItemVisible()

bool TreeView::isRootItemVisible ( ) const

noexcept

Returns true if the root item is visible.

See also: setRootItemVisible

References setDefaultOpenness().

◆ setDefaultOpenness()

void TreeView::setDefaultOpenness ( bool isOpenByDefault )

Sets whether items are open or closed by default.

Normally, items are closed until the user opens them, but you can use this to make them default to being open until explicitly closed.

See also: areItemsOpenByDefault

Referenced by isRootItemVisible().

◆ areItemsOpenByDefault()

bool TreeView::areItemsOpenByDefault ( ) const

noexcept

Returns true if the tree's items default to being open.

See also: setDefaultOpenness

References setMultiSelectEnabled().

◆ setMultiSelectEnabled()

void TreeView::setMultiSelectEnabled ( bool canMultiSelect )

This sets a flag to indicate that the tree can be used for multi-selection.

You can always select multiple items internally by calling the TreeViewItem::setSelected() method, but this flag indicates whether the user is allowed to multi-select by clicking on the tree.

By default it is disabled.

See also: isMultiSelectEnabled

Referenced by areItemsOpenByDefault().

◆ isMultiSelectEnabled()

bool TreeView::isMultiSelectEnabled ( ) const

noexcept

Returns whether multi-select has been enabled for the tree.

See also: setMultiSelectEnabled

References setOpenCloseButtonsVisible().

◆ setOpenCloseButtonsVisible()

void TreeView::setOpenCloseButtonsVisible ( bool shouldBeVisible )

Sets a flag to indicate whether to hide the open/close buttons.

See also: areOpenCloseButtonsVisible

Referenced by isMultiSelectEnabled().

◆ areOpenCloseButtonsVisible()

bool TreeView::areOpenCloseButtonsVisible ( ) const

noexcept

Returns whether open/close buttons are shown.

See also: setOpenCloseButtonsVisible

References clearSelectedItems(), findItemFromIdentifierString(), getIndentSize(), getItemAt(), getItemOnRow(), getNumRowsInTree(), getNumSelectedItems(), getOpennessState(), getSelectedItem(), getViewport(), moveSelectedRow(), restoreOpennessState(), scrollToKeepItemVisible(), and setIndentSize().

◆ clearSelectedItems()

void TreeView::clearSelectedItems ( )

Deselects any items that are currently selected.

Referenced by areOpenCloseButtonsVisible().

◆ getNumSelectedItems()

int TreeView::getNumSelectedItems ( int maximumDepthToSearchTo = -1 ) const

noexcept

Returns the number of items that are currently selected.

If maximumDepthToSearchTo is >= 0, it lets you specify a maximum depth to which the tree will be recursed.

See also: getSelectedItem, clearSelectedItems

Referenced by areOpenCloseButtonsVisible(), and FileTreeComponent::getNumSelectedFiles().

◆ getSelectedItem()

TreeViewItem* TreeView::getSelectedItem ( int index ) const

noexcept

Returns one of the selected items in the tree.

Parameters

index the index, 0 to (getNumSelectedItems() - 1)

Referenced by areOpenCloseButtonsVisible().

◆ moveSelectedRow()

void TreeView::moveSelectedRow ( int deltaRows )

Moves the selected row up or down by the specified number of rows.

Referenced by areOpenCloseButtonsVisible().

◆ getNumRowsInTree()

int TreeView::getNumRowsInTree ( ) const

Returns the number of rows the tree is using.

This will depend on which items are open.

See also: TreeViewItem::getRowNumberInTree()

Referenced by areOpenCloseButtonsVisible().

◆ getItemOnRow()

TreeViewItem* TreeView::getItemOnRow ( int index ) const

Returns the item on a particular row of the tree.

If the index is out of range, this will return nullptr.

See also: getNumRowsInTree, TreeViewItem::getRowNumberInTree()

Referenced by areOpenCloseButtonsVisible().

◆ getItemAt()

TreeViewItem* TreeView::getItemAt ( int yPosition ) const

noexcept

Returns the item that contains a given y position.

The y is relative to the top of the TreeView component.

Referenced by areOpenCloseButtonsVisible().

◆ scrollToKeepItemVisible()

void TreeView::scrollToKeepItemVisible ( TreeViewItem * item )

Tries to scroll the tree so that this item is on-screen somewhere.

Referenced by areOpenCloseButtonsVisible().

◆ getViewport()

Viewport* TreeView::getViewport ( ) const

noexcept

Returns the treeview's Viewport object.

Referenced by areOpenCloseButtonsVisible().

◆ getIndentSize()

int TreeView::getIndentSize ( )

noexcept

Returns the number of pixels by which each nested level of the tree is indented.

See also: setIndentSize

Referenced by areOpenCloseButtonsVisible().

◆ setIndentSize()

void TreeView::setIndentSize ( int newIndentSize )

Changes the distance by which each nested level of the tree is indented.

See also: getIndentSize

Referenced by areOpenCloseButtonsVisible().

◆ findItemFromIdentifierString()

TreeViewItem* TreeView::findItemFromIdentifierString ( const String & identifierString ) const

Searches the tree for an item with the specified identifier.

The identifier string must have been created by calling TreeViewItem::getItemIdentifierString(). If no such item exists, this will return false. If the item is found, all of its items will be automatically opened.

Referenced by areOpenCloseButtonsVisible().

◆ getOpennessState()

std::unique_ptr<XmlElement> TreeView::getOpennessState ( bool alsoIncludeScrollPosition ) const

Saves the current state of open/closed nodes so it can be restored later.

This takes a snapshot of which nodes have been explicitly opened or closed, and records it as XML. To identify node objects it uses the TreeViewItem::getUniqueName() method to create named paths. This means that the same state of open/closed nodes can be restored to a completely different instance of the tree, as long as it contains nodes whose unique names are the same.

The caller is responsible for deleting the object that is returned.

Parameters

alsoIncludeScrollPosition if this is true, the state will also include information about where the tree has been scrolled to vertically, so this can also be restored

See also: restoreOpennessState

Referenced by areOpenCloseButtonsVisible().

◆ restoreOpennessState()

void TreeView::restoreOpennessState	(	const XmlElement &	newState,
		bool	restoreStoredSelection
	)

Restores a previously saved arrangement of open/closed nodes.

This will try to restore a snapshot of the tree's state that was created by the getOpennessState() method. If any of the nodes named in the original XML aren't present in this tree, they will be ignored.

If restoreStoredSelection is true, it will also try to re-select any items that were selected in the stored state.

See also: getOpennessState

Referenced by areOpenCloseButtonsVisible().

◆ paint()

void TreeView::paint ( Graphics & )

overridevirtual

Reimplemented from Component.

◆ resized()

void TreeView::resized ( )

overridevirtual

Reimplemented from Component.

◆ keyPressed()

bool TreeView::keyPressed ( const KeyPress & )

overridevirtual

Reimplemented from Component.

◆ colourChanged()

void TreeView::colourChanged ( )

overridevirtual

Reimplemented from Component.

◆ enablementChanged()

void TreeView::enablementChanged ( )

overridevirtual

Reimplemented from Component.

◆ isInterestedInFileDrag()

bool TreeView::isInterestedInFileDrag ( const StringArray & files )

overridevirtual

Implements FileDragAndDropTarget.

◆ fileDragEnter()

void TreeView::fileDragEnter	(	const StringArray &	files,
		int	x,
		int	y
	)

overridevirtual

Reimplemented from FileDragAndDropTarget.

◆ fileDragMove()

void TreeView::fileDragMove	(	const StringArray &	files,
		int	x,
		int	y
	)

overridevirtual

Reimplemented from FileDragAndDropTarget.

◆ fileDragExit()

void TreeView::fileDragExit ( const StringArray & files )

overridevirtual

Reimplemented from FileDragAndDropTarget.

◆ filesDropped()

void TreeView::filesDropped	(	const StringArray &	files,
		int	x,
		int	y
	)

overridevirtual

Implements FileDragAndDropTarget.

◆ isInterestedInDragSource()

bool TreeView::isInterestedInDragSource ( const SourceDetails & )

overridevirtual

Implements DragAndDropTarget.

◆ itemDragEnter()

void TreeView::itemDragEnter ( const SourceDetails & )

overridevirtual

Reimplemented from DragAndDropTarget.

◆ itemDragMove()

void TreeView::itemDragMove ( const SourceDetails & )

overridevirtual

Reimplemented from DragAndDropTarget.

◆ itemDragExit()

void TreeView::itemDragExit ( const SourceDetails & )

overridevirtual

Reimplemented from DragAndDropTarget.

◆ itemDropped()

void TreeView::itemDropped ( const SourceDetails & )

overridevirtual

Implements DragAndDropTarget.

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

juce_TreeView.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ColourIds

Constructor & Destructor Documentation

◆ TreeView()

◆ ~TreeView()

Member Function Documentation

◆ setRootItem()

◆ getRootItem()

◆ deleteRootItem()

◆ setRootItemVisible()

◆ isRootItemVisible()

◆ setDefaultOpenness()

◆ areItemsOpenByDefault()

◆ setMultiSelectEnabled()

◆ isMultiSelectEnabled()

◆ setOpenCloseButtonsVisible()

◆ areOpenCloseButtonsVisible()

◆ clearSelectedItems()

◆ getNumSelectedItems()

◆ getSelectedItem()

◆ moveSelectedRow()

◆ getNumRowsInTree()

◆ getItemOnRow()

◆ getItemAt()

◆ scrollToKeepItemVisible()

◆ getViewport()

◆ getIndentSize()

◆ setIndentSize()

◆ findItemFromIdentifierString()

◆ getOpennessState()

◆ restoreOpennessState()

◆ paint()

◆ resized()

◆ keyPressed()

◆ colourChanged()

◆ enablementChanged()

◆ isInterestedInFileDrag()

◆ fileDragEnter()

◆ fileDragMove()

◆ fileDragExit()

◆ filesDropped()

◆ isInterestedInDragSource()

◆ itemDragEnter()

◆ itemDragMove()

◆ itemDragExit()

◆ itemDropped()