openshot-audio
0.1.6
|
#include <juce_ComboBox.h>
Classes | |
class | Listener |
struct | LookAndFeelMethods |
Public Types | |
enum | ColourIds { backgroundColourId = 0x1000b00, textColourId = 0x1000a00, outlineColourId = 0x1000c00, buttonColourId = 0x1000d00, arrowColourId = 0x1000e00 } |
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 register a ComboBox::Listener to receive callbacks.
enum 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.
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 |
|
explicit |
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.
componentName | the name to set for the component (see Component::setName()) |
ComboBox::~ComboBox | ( | ) |
Destructor.
Adds an item to be shown in the drop-down list.
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! |
void 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.
|
virtual |
Adds the items in this ComboBox to the given menu.
void ComboBox::addListener | ( | Listener * | listener | ) |
Registers a listener that will be called when the box's content changes.
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.
void ComboBox::addSeparator | ( | ) |
Adds a separator line to the drop-down list.
This is like adding a separator to a popup menu. See PopupMenu::addSeparator().
Changes the text for an existing item.
void 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.
|
override |
|
override |
|
override |
|
override |
Returns the ID for one of the items in the list. Note that this doesn't include headers or separators.
index | the item's index from 0 to (getNumItems() - 1) |
Returns the text for one of the items in the list. Note that this doesn't include headers or separators.
index | the item's index from 0 to (getNumItems() - 1) |
|
noexcept |
Returns the current justification for the text box.
|
noexcept |
Returns the number of items that have been added to the list.
Note that this doesn't include headers or separators.
|
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.
|
inline |
Returns a Value object that can be used to get or set the selected item's ID.
You can call Value::referTo() on this object to make the combo box control another Value object.
int 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.
String 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.
String ComboBox::getTextWhenNoChoicesAvailable | ( | ) | const |
Returns the text shown when no items have been added to the list.
String ComboBox::getTextWhenNothingSelected | ( | ) | const |
Returns the text that is shown when no item is selected.
|
inlineoverride |
|
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 AsyncUpdater.
void ComboBox::hidePopup | ( | ) |
Hides the combo box's popup list, if it's currently visible.
Returns the index in the list of a particular item ID. If no such ID is found, this will return -1.
|
noexcept |
Returns true if the given item is enabled.
|
inlinenoexcept |
Returns true if the popup menu is currently being shown.
|
noexcept |
Returns true if the text is directly editable.
ComboBox::JUCE_DEPRECATED | ( | void | clearbool | ) |
ComboBox::JUCE_DEPRECATED | ( | void | setSelectedIdint, bool | ) |
ComboBox::JUCE_DEPRECATED | ( | void | setSelectedItemIndexint, bool | ) |
ComboBox::JUCE_DEPRECATED | ( | void | setTextconst String &, bool | ) |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
void ComboBox::removeListener | ( | Listener * | listener | ) |
Deregisters a previously-registered listener.
|
override |
void 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.
void ComboBox::setItemEnabled | ( | int | itemId, |
bool | shouldBeEnabled | ||
) |
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.
void ComboBox::setJustificationType | ( | Justification | justification | ) |
Sets the style of justification to be used for positioning the text.
The default is Justification::centredLeft. The text is displayed using a Label component inside the ComboBox.
|
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.
void 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.
newItemId | the new item to select |
notification | determines the type of change notification that will be sent to listeners if the value changes |
void 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.
newItemIndex | the new item to select |
notification | determines the type of change notification that will be sent to listeners if the value changes |
void 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 -1, otherwise it wil return the approriate ID.
newText | the text to select |
notification | determines the type of change notification that will be sent to listeners if the text changes |
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.
Sets a message to display when there is no item currently selected.
void 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.
|
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.
|
override |