#include <juce_TreeView.h>
Classes | |
| struct | LookAndFeelMethods |
| class | ItemComponent |
| class | ContentComponent |
| class | TreeViewport |
| struct | InsertPoint |
| class | InsertPointHighlight |
| class | TargetGroupHighlight |
Public Types | |
| enum | ColourIds { backgroundColourId = 0x1000500 , linesColourId = 0x1000501 , dragAndDropIndicatorColourId = 0x1000502 , selectedItemBackgroundColourId = 0x1000503 , oddItemsColourId = 0x1000504 , evenItemsColourId = 0x1000505 } |
| Public Types inherited from juce::Component | |
| enum class | FocusContainerType { none , focusContainer , keyboardFocusContainer } |
| enum | FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly } |
Private Member Functions | |
| std::unique_ptr< AccessibilityHandler > | createAccessibilityHandler () override |
| void | itemsChanged () noexcept |
| void | updateVisibleItems () |
| void | updateButtonUnderMouse (const MouseEvent &) |
| void | showDragHighlight (const InsertPoint &) noexcept |
| void | hideDragHighlight () noexcept |
| void | handleDrag (const StringArray &, const SourceDetails &) |
| void | handleDrop (const StringArray &, const SourceDetails &) |
| bool | toggleOpenSelectedItem () |
| void | moveOutOfSelectedItem () |
| void | moveIntoSelectedItem () |
| void | moveByPages (int) |
Private Attributes | |
| std::unique_ptr< TreeViewport > | viewport |
| TreeViewItem * | rootItem = nullptr |
| std::unique_ptr< InsertPointHighlight > | dragInsertPointHighlight |
| std::unique_ptr< TargetGroupHighlight > | dragTargetGroupHighlight |
| int | indentSize = -1 |
| bool | defaultOpenness = false |
| bool | rootItemVisible = true |
| bool | multiSelectEnabled = false |
| bool | openCloseButtonsVisible = true |
Friends | |
| class | TreeViewItem |
Detailed Description
A tree-view component.
Use one of these to hold and display a structure of TreeViewItem objects.
@tags{GUI}
Member Enumeration Documentation
◆ ColourIds
| enum juce::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
Constructor & Destructor Documentation
◆ TreeView()
◆ ~TreeView()
|
override |
Destructor.
Member Function Documentation
◆ areItemsOpenByDefault()
|
inlinenoexcept |
Returns true if the tree's items default to being open.
- See also
- setDefaultOpenness
◆ areOpenCloseButtonsVisible()
|
inlinenoexcept |
Returns whether open/close buttons are shown.
- See also
- setOpenCloseButtonsVisible
◆ clearSelectedItems()
| void juce::TreeView::clearSelectedItems | ( | ) |
Deselects any items that are currently selected.
◆ colourChanged()
|
overridevirtual |
This method is called when a colour is changed by the setColour() method.
- See also
- setColour, findColour
Reimplemented from juce::Component.
◆ createAccessibilityHandler()
|
overrideprivatevirtual |
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 also
- getAccessibilityHandler
Reimplemented from juce::Component.
◆ deleteRootItem()
| void juce::TreeView::deleteRootItem | ( | ) |
This will remove and delete the current root item.
It's a convenient way of deleting the item and calling setRootItem (nullptr).
◆ enablementChanged()
|
overridevirtual |
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 also
- setEnabled, isEnabled
Reimplemented from juce::Component.
◆ fileDragEnter()
|
overridevirtual |
Callback to indicate that some files are being dragged over this component.
This gets called when the user moves the mouse into this component while dragging.
Use this callback as a trigger to make your component repaint itself to give the user feedback about whether the files can be dropped here or not.
- Parameters
-
files the set of (absolute) pathnames of the files that the user is dragging x the mouse x position, relative to this component y the mouse y position, relative to this component
Reimplemented from juce::FileDragAndDropTarget.
◆ fileDragExit()
|
overridevirtual |
Callback to indicate that the mouse has moved away from this component.
This gets called when the user moves the mouse out of this component while dragging the files.
If you've used fileDragEnter() to repaint your component and give feedback, use this as a signal to repaint it in its normal state.
- Parameters
-
files the set of (absolute) pathnames of the files that the user is dragging
Reimplemented from juce::FileDragAndDropTarget.
◆ fileDragMove()
|
overridevirtual |
Callback to indicate that the user is dragging some files over this component.
This gets called when the user moves the mouse over this component while dragging. Normally overriding itemDragEnter() and itemDragExit() are enough, but this lets you know what happens in-between.
- Parameters
-
files the set of (absolute) pathnames of the files that the user is dragging x the mouse x position, relative to this component y the mouse y position, relative to this component
Reimplemented from juce::FileDragAndDropTarget.
◆ filesDropped()
|
overridevirtual |
Callback to indicate that the user has dropped the files onto this component.
When the user drops the files, this get called, and you can use the files in whatever way is appropriate.
Note that after this is called, the fileDragExit method may not be called, so you should clean up in here if there's anything you need to do when the drag finishes.
- Parameters
-
files the set of (absolute) pathnames of the files that the user is dragging x the mouse x position, relative to this component y the mouse y position, relative to this component
Implements juce::FileDragAndDropTarget.
◆ findItemFromIdentifierString()
| TreeViewItem * juce::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.
◆ getIndentSize()
|
noexcept |
Returns the number of pixels by which each nested level of the tree is indented.
- See also
- setIndentSize
◆ getItemAt()
|
noexcept |
Returns the item that contains a given y-position relative to the top of the TreeView component.
◆ getItemComponent()
| Component * juce::TreeView::getItemComponent | ( | const TreeViewItem * | item | ) | const |
Returns the component that currently represents a given TreeViewItem.
◆ getItemOnRow()
| TreeViewItem * juce::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()
◆ getNumRowsInTree()
| int juce::TreeView::getNumRowsInTree | ( | ) | const |
Returns the number of rows the tree is using, depending on which items are open.
- See also
- TreeViewItem::getRowNumberInTree()
◆ getNumSelectedItems()
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
◆ getOpennessState()
| std::unique_ptr< XmlElement > juce::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.
- 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
◆ getRootItem()
|
inlinenoexcept |
Returns the tree's root item.
This will be the last object passed to setRootItem(), or nullptr if none has been set.
◆ getSelectedItem()
|
noexcept |
Returns one of the selected items in the tree.
- Parameters
-
index the index, 0 to (getNumSelectedItems() - 1)
◆ getViewport()
◆ handleDrag()
|
private |
◆ handleDrop()
|
private |
◆ hideDragHighlight()
|
privatenoexcept |
◆ isInterestedInDragSource()
|
overridevirtual |
Callback to check whether this target is interested in the type of object being dragged.
- Parameters
-
dragSourceDetails contains information about the source of the drag operation.
- Returns
- true if this component wants to receive the other callbacks regarding this type of object; if it returns false, no other callbacks will be made.
Implements juce::DragAndDropTarget.
◆ isInterestedInFileDrag()
|
overridevirtual |
Callback to check whether this target is interested in the set of files being offered.
Note that this will be called repeatedly when the user is dragging the mouse around over your component, so don't do anything time-consuming in here, like opening the files to have a look inside them!
- Parameters
-
files the set of (absolute) pathnames of the files that the user is dragging
- Returns
- true if this component wants to receive the other callbacks regarding this type of object; if it returns false, no other callbacks will be made.
Implements juce::FileDragAndDropTarget.
◆ isMultiSelectEnabled()
|
inlinenoexcept |
Returns whether multi-select has been enabled for the tree.
- See also
- setMultiSelectEnabled
◆ isRootItemVisible()
|
inlinenoexcept |
Returns true if the root item is visible.
- See also
- setRootItemVisible
◆ itemDragEnter()
|
overridevirtual |
Callback to indicate that something is being dragged over this component.
This gets called when the user moves the mouse into this component while dragging something.
Use this callback as a trigger to make your component repaint itself to give the user feedback about whether the item can be dropped here or not.
- Parameters
-
dragSourceDetails contains information about the source of the drag operation.
- See also
- itemDragExit
Reimplemented from juce::DragAndDropTarget.
◆ itemDragExit()
|
overridevirtual |
Callback to indicate that something has been dragged off the edge of this component.
This gets called when the user moves the mouse out of this component while dragging something.
If you've used itemDragEnter() to repaint your component and give feedback, use this as a signal to repaint it in its normal state.
- Parameters
-
dragSourceDetails contains information about the source of the drag operation.
- See also
- itemDragEnter
Reimplemented from juce::DragAndDropTarget.
◆ itemDragMove()
|
overridevirtual |
Callback to indicate that the user is dragging something over this component.
This gets called when the user moves the mouse over this component while dragging something. Normally overriding itemDragEnter() and itemDragExit() are enough, but this lets you know what happens in-between.
- Parameters
-
dragSourceDetails contains information about the source of the drag operation.
Reimplemented from juce::DragAndDropTarget.
◆ itemDropped()
|
overridevirtual |
Callback to indicate that the user has dropped something onto this component.
When the user drops an item this get called, and you can use the description to work out whether your object wants to deal with it or not.
Note that after this is called, the itemDragExit method may not be called, so you should clean up in here if there's anything you need to do when the drag finishes.
- Parameters
-
dragSourceDetails contains information about the source of the drag operation.
Implements juce::DragAndDropTarget.
◆ itemsChanged()
|
privatenoexcept |
◆ keyPressed()
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 also
- keyStateChanged, getCurrentlyFocusedComponent, addKeyListener
Reimplemented from juce::Component.
◆ moveByPages()
◆ moveIntoSelectedItem()
|
private |
◆ moveOutOfSelectedItem()
|
private |
◆ moveSelectedRow()
Moves the selected row up or down by the specified number of rows.
◆ paint()
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().
- Parameters
-
g the graphics context that must be used to do the drawing operations.
- See also
- repaint, paintOverChildren, Graphics
Reimplemented from juce::Component.
◆ resized()
|
overridevirtual |
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 also
- moved, setSize
Reimplemented from juce::Component.
◆ restoreOpennessState()
| void juce::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
◆ scrollToKeepItemVisible()
| void juce::TreeView::scrollToKeepItemVisible | ( | TreeViewItem * | item | ) |
Tries to scroll the tree so that this item is on-screen somewhere.
◆ setDefaultOpenness()
| void juce::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
◆ setIndentSize()
Changes the distance by which each nested level of the tree is indented.
- See also
- getIndentSize
◆ setMultiSelectEnabled()
| void juce::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
◆ setOpenCloseButtonsVisible()
| void juce::TreeView::setOpenCloseButtonsVisible | ( | bool | shouldBeVisible | ) |
Sets a flag to indicate whether to hide the open/close buttons.
- See also
- areOpenCloseButtonsVisible
◆ setRootItem()
| void juce::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.
◆ setRootItemVisible()
| void juce::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).
◆ showDragHighlight()
|
privatenoexcept |
◆ toggleOpenSelectedItem()
|
private |
◆ updateButtonUnderMouse()
|
private |
◆ updateVisibleItems()
|
private |
Friends And Related Symbol Documentation
◆ TreeViewItem
|
friend |
Member Data Documentation
◆ defaultOpenness
|
private |
◆ dragInsertPointHighlight
|
private |
◆ dragTargetGroupHighlight
|
private |
◆ indentSize
|
private |
◆ multiSelectEnabled
|
private |
◆ openCloseButtonsVisible
|
private |
◆ rootItem
|
private |
◆ rootItemVisible
|
private |
◆ viewport
|
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/widgets/juce_TreeView.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/widgets/juce_TreeView.cpp
Generated on for LMMS by
1.16.1