#include <juce_ComboBox.h>
Classes | |
| class | Listener |
| struct | LookAndFeelMethods |
Public Types | |
| enum | ColourIds { backgroundColourId = 0x1000b00 , textColourId = 0x1000a00 , outlineColourId = 0x1000c00 , buttonColourId = 0x1000d00 , arrowColourId = 0x1000e00 , focusedOutlineColourId = 0x1000f00 } |
| Public Types inherited from juce::Component | |
| enum class | FocusContainerType { none , focusContainer , keyboardFocusContainer } |
| enum | FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly } |
Public Attributes | |
| std::function< void()> | onChange |
Private Types | |
| enum | EditableState { editableUnknown , labelIsNotEditable , labelIsEditable } |
Private Member Functions | |
| std::unique_ptr< AccessibilityHandler > | createAccessibilityHandler () override |
| PopupMenu::Item * | getItemForId (int) const noexcept |
| PopupMenu::Item * | getItemForIndex (int) const noexcept |
| bool | selectIfEnabled (int index) |
| bool | nudgeSelectedItem (int delta) |
| void | sendChange (NotificationType) |
| void | showPopupIfNotActive () |
| Private Member Functions inherited from juce::AsyncUpdater | |
| AsyncUpdater () | |
| virtual | ~AsyncUpdater () |
| void | triggerAsyncUpdate () |
| void | cancelPendingUpdate () noexcept |
| void | handleUpdateNowIfNeeded () |
| bool | isUpdatePending () const noexcept |
Private Attributes | |
| PopupMenu | currentMenu |
| Value | currentId |
| int | lastCurrentId = 0 |
| bool | isButtonDown = false |
| bool | menuActive = false |
| bool | scrollWheelEnabled = false |
| float | mouseWheelAccumulator = 0 |
| ListenerList< Listener > | listeners |
| std::unique_ptr< Label > | label |
| String | textWhenNothingSelected |
| String | noChoicesMessage |
| EditableState | labelEditableState = editableUnknown |
Detailed Description
A component that lets the user choose from a drop-down list of choices.
The combo-box has a list of text strings, each with an associated id number, that will be shown in the drop-down list when the user clicks on the component.
The currently selected choice is displayed in the combo-box, and this can either be read-only text, or editable.
To find out when the user selects a different item or edits the text, you can assign a lambda to the onChange member, or register a ComboBox::Listener to receive callbacks.
@tags{GUI}
Member Enumeration Documentation
◆ ColourIds
| enum juce::ComboBox::ColourIds |
A set of colour IDs to use to change the colour of various aspects of the combo box.
These constants can be used either via the Component::setColour(), or LookAndFeel::setColour() methods.
To change the colours of the menu that pops up, you can set the colour IDs in PopupMenu::ColourIDs.
- See also
- Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
| Enumerator | |
|---|---|
| backgroundColourId | The background colour to fill the box with. |
| textColourId | The colour for the text in the box. |
| outlineColourId | The colour for an outline around the box. |
| buttonColourId | The base colour for the button (a LookAndFeel class will probably use variations on this). |
| arrowColourId | The colour for the arrow shape that pops up the menu |
| focusedOutlineColourId | The colour that will be used to draw a box around the edge of the component when it has focus. |
◆ EditableState
|
private |
Constructor & Destructor Documentation
◆ ComboBox()
Creates a combo-box.
On construction, the text field will be empty, so you should call the setSelectedId() or setText() method to choose the initial value before displaying it.
- Parameters
-
componentName the name to set for the component (see Component::setName())
◆ ~ComboBox()
|
override |
Destructor.
Member Function Documentation
◆ addItem()
Adds an item to be shown in the drop-down list.
- Parameters
-
newItemText the text of the item to show in the list newItemId an associated ID number that can be set or retrieved - see getSelectedId() and setSelectedId(). Note that this value can not be 0!
- See also
- setItemEnabled, addSeparator, addSectionHeading, getNumItems, getItemText, getItemId
◆ addItemList()
| void juce::ComboBox::addItemList | ( | const StringArray & | items, |
| int | firstItemIdOffset ) |
Adds an array of items to the drop-down list. The item ID of each item will be its index in the StringArray + firstItemIdOffset.
◆ addListener()
| void juce::ComboBox::addListener | ( | ComboBox::Listener * | l | ) |
Registers a listener that will be called when the box's content changes.
◆ addSectionHeading()
Adds a heading to the drop-down list, so that you can group the items into different sections.
The headings are indented slightly differently to set them apart from the items on the list, and obviously can't be selected. You might want to add separators between your sections too.
- See also
- addItem, addSeparator
◆ addSeparator()
| void juce::ComboBox::addSeparator | ( | ) |
Adds a separator line to the drop-down list.
This is like adding a separator to a popup menu. See PopupMenu::addSeparator().
◆ changeItemText()
Changes the text for an existing item.
◆ clear() [1/2]
| void juce::ComboBox::clear | ( | bool | dontSendChange | ) |
◆ clear() [2/2]
| void juce::ComboBox::clear | ( | NotificationType | notification = sendNotificationAsync | ) |
Removes all the items from the drop-down list.
If this call causes the content to be cleared, and a change-message will be broadcast according to the notification parameter.
- See also
- addItem, getNumItems
◆ 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.
◆ 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.
◆ focusGained()
|
overridevirtual |
Called to indicate that this component has just acquired the keyboard focus.
- See also
- focusLost, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus
Reimplemented from juce::Component.
◆ focusLost()
|
overridevirtual |
Called to indicate that this component has just lost the keyboard focus.
- See also
- focusGained, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus
Reimplemented from juce::Component.
◆ getItemForId()
|
privatenoexcept |
◆ getItemForIndex()
|
privatenoexcept |
◆ getItemId()
Returns the ID for one of the items in the list. Note that this doesn't include headers or separators.
- Parameters
-
index the item's index from 0 to (getNumItems() - 1)
◆ getItemText()
Returns the text for one of the items in the list. Note that this doesn't include headers or separators.
- Parameters
-
index the item's index from 0 to (getNumItems() - 1)
◆ getJustificationType()
|
noexcept |
Returns the current justification for the text box.
- See also
- setJustificationType
◆ getNumItems()
|
noexcept |
Returns the number of items that have been added to the list.
Note that this doesn't include headers or separators.
◆ getRootMenu() [1/2]
◆ getRootMenu() [2/2]
|
inlinenoexcept |
◆ getSelectedId()
|
noexcept |
Returns the ID of the item that's currently shown in the box.
If no item is selected, or if the text is editable and the user has entered something which isn't one of the items in the list, then this will return 0.
- See also
- setSelectedId, getSelectedItemIndex, getText
◆ getSelectedIdAsValue()
|
inline |
◆ getSelectedItemIndex()
| int juce::ComboBox::getSelectedItemIndex | ( | ) | const |
Returns the index of the item that's currently shown in the box.
If no item is selected, or if the text is editable and the user has entered something which isn't one of the items in the list, then this will return -1.
- See also
- setSelectedItemIndex, getSelectedId, getText
◆ getText()
| String juce::ComboBox::getText | ( | ) | const |
Returns the text that is currently shown in the combo-box's text field.
If the ComboBox has editable text, then this text may have been edited by the user; otherwise it will be one of the items from the list, or possibly an empty string if nothing was selected.
- See also
- setText, getSelectedId, getSelectedItemIndex
◆ getTextWhenNoChoicesAvailable()
| String juce::ComboBox::getTextWhenNoChoicesAvailable | ( | ) | const |
Returns the text shown when no items have been added to the list.
- See also
- setTextWhenNoChoicesAvailable
◆ getTextWhenNothingSelected()
| String juce::ComboBox::getTextWhenNothingSelected | ( | ) | const |
Returns the text that is shown when no item is selected.
- See also
- setTextWhenNothingSelected
◆ getTooltip()
|
inlineoverridevirtual |
Returns the string that this object wants to show as its tooltip.
Implements juce::TooltipClient.
◆ handleAsyncUpdate()
|
overridevirtual |
Called back to do whatever your class needs to do.
This method is called by the message thread at the next convenient time after the triggerAsyncUpdate() method has been called.
Implements juce::AsyncUpdater.
◆ hidePopup()
| void juce::ComboBox::hidePopup | ( | ) |
Hides the combo box's popup list, if it's currently visible.
◆ indexOfItemId()
Returns the index in the list of a particular item ID. If no such ID is found, this will return -1.
◆ isItemEnabled()
|
noexcept |
Returns true if the given item is enabled.
◆ isPopupActive()
|
inlinenoexcept |
Returns true if the popup menu is currently being shown.
◆ isTextEditable()
|
noexcept |
Returns true if the text is directly editable.
- See also
- setEditableText
◆ 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.
◆ keyStateChanged()
|
overridevirtual |
Called when a key is pressed or released.
Whenever a key on the keyboard is pressed or released (including modifier keys like shift and ctrl), this method will be called on the component that currently has the keyboard focus. 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, then any KeyListeners that have been registered with this component will have their keyStateChanged methods called. 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.
To find out which keys are up or down at any time, see the KeyPress::isKeyCurrentlyDown() method.
- Parameters
-
isKeyDown true if a key has been pressed; false if it has been released
- See also
- keyPressed, KeyPress, getCurrentlyFocusedComponent, addKeyListener
Reimplemented from juce::Component.
◆ lookAndFeelChanged()
|
overridevirtual |
Called to let the component react to a change in the look-and-feel setting.
When the look-and-feel is changed for a component, this will be called in all its child components, recursively.
It can also be triggered manually by the sendLookAndFeelChange() method, in case an application uses a LookAndFeel class that might have changed internally.
- See also
- sendLookAndFeelChange, getLookAndFeel
Reimplemented from juce::Component.
◆ mouseDown()
|
overridevirtual |
Called when a mouse button is pressed.
The MouseEvent object passed in contains lots of methods for finding out which button was pressed, as well as which modifier keys (e.g. shift, ctrl) were held down at the time.
Once a button is held down, the mouseDrag method will be called when the mouse moves, until the button is released.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseUp, mouseDrag, mouseDoubleClick, contains
Reimplemented from juce::MouseListener.
◆ mouseDrag()
|
overridevirtual |
Called when the mouse is moved while a button is held down.
When a mouse button is pressed inside a component, that component receives mouseDrag callbacks each time the mouse moves, even if the mouse strays outside the component's bounds.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseDown, mouseUp, mouseMove, contains, setDragRepeatInterval
Reimplemented from juce::MouseListener.
◆ mouseUp()
|
overridevirtual |
Called when a mouse button is released.
A mouseUp callback is sent to the component in which a button was pressed even if the mouse is actually over a different component when the button is released.
The MouseEvent object passed in contains lots of methods for finding out which buttons were down just before they were released.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseDown, mouseDrag, mouseDoubleClick, contains
Reimplemented from juce::MouseListener.
◆ mouseWheelMove()
|
overridevirtual |
Called when the mouse-wheel is moved.
This callback is sent to the component that the mouse is over when the wheel is moved.
If not overridden, a component will forward this message to its parent, so that parent components can collect mouse-wheel messages that happen to child components which aren't interested in them.
- Parameters
-
Event details about the mouse event wheel details about the wheel movement
Reimplemented from juce::MouseListener.
◆ nudgeSelectedItem()
|
private |
◆ 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.
◆ parentHierarchyChanged()
|
overridevirtual |
Called to indicate that the component's parents have changed.
When a component is added or removed from its parent, this method will be called on all of its children (recursively - so all children of its children will also be called as well).
Subclasses can override this if they need to react to this in some way.
- See also
- getParentComponent, isShowing, ComponentListener::componentParentHierarchyChanged
Reimplemented from juce::Component.
◆ removeListener()
| void juce::ComboBox::removeListener | ( | ComboBox::Listener * | l | ) |
Deregisters a previously-registered listener.
◆ 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.
◆ selectIfEnabled()
|
private |
◆ sendChange()
|
private |
◆ setEditableText()
| void juce::ComboBox::setEditableText | ( | bool | isEditable | ) |
Sets whether the text in the combo-box is editable.
The default state for a new ComboBox is non-editable, and can only be changed by choosing from the drop-down list.
◆ setItemEnabled()
This allows items in the drop-down list to be selectively disabled.
When you add an item, it's enabled by default, but you can call this method to change its status.
If you disable an item which is already selected, this won't change the current selection - it just stops the user choosing that item from the list.
◆ setJustificationType()
| void juce::ComboBox::setJustificationType | ( | Justification | justification | ) |
◆ setScrollWheelEnabled()
|
noexcept |
This can be used to allow the scroll-wheel to nudge the chosen item. By default it's disabled, and I'd recommend leaving it disabled if there's any chance that the control might be inside a scrollable list or viewport.
◆ setSelectedId() [1/2]
| void juce::ComboBox::setSelectedId | ( | int | newItemId, |
| NotificationType | notification = sendNotificationAsync ) |
Sets one of the items to be the current selection.
This will set the ComboBox's text to that of the item that matches this ID.
- Parameters
-
newItemId the new item to select notification determines the type of change notification that will be sent to listeners if the value changes
- See also
- getSelectedId, setSelectedItemIndex, setText
◆ setSelectedId() [2/2]
◆ setSelectedItemIndex() [1/2]
| void juce::ComboBox::setSelectedItemIndex | ( | int | newItemIndex, |
| NotificationType | notification = sendNotificationAsync ) |
Sets one of the items to be the current selection.
This will set the ComboBox's text to that of the item at the given index in the list.
- Parameters
-
newItemIndex the new item to select notification determines the type of change notification that will be sent to listeners if the value changes
- See also
- getSelectedItemIndex, setSelectedId, setText
◆ setSelectedItemIndex() [2/2]
◆ setText() [1/2]
◆ setText() [2/2]
| void juce::ComboBox::setText | ( | const String & | newText, |
| NotificationType | notification = sendNotificationAsync ) |
Sets the contents of the combo-box's text field.
The text passed-in will be set as the current text regardless of whether it is one of the items in the list. If the current text isn't one of the items, then getSelectedId() will return 0, otherwise it will return the appropriate ID.
- Parameters
-
newText the text to select notification determines the type of change notification that will be sent to listeners if the text changes
- See also
- getText
◆ setTextWhenNoChoicesAvailable()
Sets the message to show when there are no items in the list, and the user clicks on the drop-down box.
By default it just says "no choices", but this lets you change it to something more meaningful.
◆ setTextWhenNothingSelected()
Sets a message to display when there is no item currently selected.
- See also
- getTextWhenNothingSelected
◆ setTooltip()
Gives the ComboBox a tooltip.
Reimplemented from juce::SettableTooltipClient.
◆ showEditor()
| void juce::ComboBox::showEditor | ( | ) |
Programmatically opens the text editor to allow the user to edit the current item.
This is the same effect as when the box is clicked-on.
- See also
- Label::showEditor();
◆ showPopup()
|
virtual |
Pops up the combo box's list. This is virtual so that you can override it with your own custom popup mechanism if you need some really unusual behaviour.
◆ showPopupIfNotActive()
|
private |
◆ valueChanged()
Called when a Value object is changed.
Note that the Value object passed as a parameter may not be exactly the same object that you registered the listener with - it might be a copy that refers to the same underlying ValueSource. To find out, you can call Value::refersToSameSourceAs().
Implements juce::Value::Listener.
Member Data Documentation
◆ currentId
|
private |
◆ currentMenu
|
private |
◆ isButtonDown
|
private |
◆ label
|
private |
◆ labelEditableState
|
private |
◆ lastCurrentId
|
private |
◆ listeners
|
private |
◆ menuActive
|
private |
◆ mouseWheelAccumulator
|
private |
◆ noChoicesMessage
|
private |
◆ onChange
| std::function<void()> juce::ComboBox::onChange |
You can assign a lambda to this callback object to have it called when the selected ID is changed.
◆ scrollWheelEnabled
|
private |
◆ textWhenNothingSelected
|
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_ComboBox.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/widgets/juce_ComboBox.cpp
Generated on for LMMS by
1.16.1