JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Types | Public Member Functions | List of all members
ComboBox Class Reference

A component that lets the user choose from a drop-down list of choices. More...

Inherits Component, SettableTooltipClient, Label::Listener, Value::Listener, and AsyncUpdater.

Classes

class  Listener
 A class for receiving events from a ComboBox. More...
 
struct  LookAndFeelMethods
 This abstract base class is implemented by LookAndFeel classes to provide ComboBox functionality. More...
 

Public Types

enum  ColourIds {
  backgroundColourId = 0x1000b00, textColourId = 0x1000a00, outlineColourId = 0x1000c00, buttonColourId = 0x1000d00,
  arrowColourId = 0x1000e00
}
 A set of colour IDs to use to change the colour of various aspects of the combo box. More...
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 Enumeration used by the focusChanged() and focusLost() methods. More...
 

Public Member Functions

 ComboBox (const String &componentName=String::empty)
 Creates a combo-box.
 
 ~ComboBox ()
 Destructor.
 
void setEditableText (bool isEditable)
 Sets whether the test in the combo-box is editable.
 
bool isTextEditable () const noexcept
 Returns true if the text is directly editable.
 
void setJustificationType (Justification justification)
 Sets the style of justification to be used for positioning the text.
 
Justification getJustificationType () const noexcept
 Returns the current justification for the text box.
 
void addItem (const String &newItemText, int newItemId)
 Adds an item to be shown in the drop-down list.
 
void addItemList (const StringArray &items, int firstItemIdOffset)
 Adds an array of items to the drop-down list.
 
void addSeparator ()
 Adds a separator line to the drop-down list.
 
void addSectionHeading (const String &headingName)
 Adds a heading to the drop-down list, so that you can group the items into different sections.
 
void setItemEnabled (int itemId, bool shouldBeEnabled)
 This allows items in the drop-down list to be selectively disabled.
 
bool isItemEnabled (int itemId) const noexcept
 Returns true if the given item is enabled.
 
void changeItemText (int itemId, const String &newText)
 Changes the text for an existing item.
 
void clear (NotificationType notification=sendNotificationAsync)
 Removes all the items from the drop-down list.
 
int getNumItems () const noexcept
 Returns the number of items that have been added to the list.
 
String getItemText (int index) const
 Returns the text for one of the items in the list.
 
int getItemId (int index) const noexcept
 Returns the ID for one of the items in the list.
 
int indexOfItemId (int itemId) const noexcept
 Returns the index in the list of a particular item ID.
 
int getSelectedId () const noexcept
 Returns the ID of the item that's currently shown in the box.
 
ValuegetSelectedIdAsValue ()
 Returns a Value object that can be used to get or set the selected item's ID.
 
void setSelectedId (int newItemId, NotificationType notification=sendNotificationAsync)
 Sets one of the items to be the current selection.
 
int getSelectedItemIndex () const
 Returns the index of the item that's currently shown in the box.
 
void setSelectedItemIndex (int newItemIndex, NotificationType notification=sendNotificationAsync)
 Sets one of the items to be the current selection.
 
String getText () const
 Returns the text that is currently shown in the combo-box's text field.
 
void setText (const String &newText, NotificationType notification=sendNotificationAsync)
 Sets the contents of the combo-box's text field.
 
void showEditor ()
 Programmatically opens the text editor to allow the user to edit the current item.
 
virtual void showPopup ()
 Pops up the combo box's list.
 
void addListener (Listener *listener)
 Registers a listener that will be called when the box's content changes.
 
void removeListener (Listener *listener)
 Deregisters a previously-registered listener.
 
void setTextWhenNothingSelected (const String &newMessage)
 Sets a message to display when there is no item currently selected.
 
String getTextWhenNothingSelected () const
 Returns the text that is shown when no item is selected.
 
void setTextWhenNoChoicesAvailable (const String &newMessage)
 Sets the message to show when there are no items in the list, and the user clicks on the drop-down box.
 
String getTextWhenNoChoicesAvailable () const
 Returns the text shown when no items have been added to the list.
 
void setTooltip (const String &newTooltip) override
 Gives the ComboBox a tooltip.
 
void setScrollWheelEnabled (bool enabled) noexcept
 This can be used to allow the scroll-wheel to nudge the chosen item.
 
void labelTextChanged (Label *) override
 
void enablementChanged () override
 
void colourChanged () override
 
void focusGained (Component::FocusChangeType) override
 
void focusLost (Component::FocusChangeType) override
 
void handleAsyncUpdate () override
 
String getTooltip () override
 
void mouseDown (const MouseEvent &) override
 
void mouseDrag (const MouseEvent &) override
 
void mouseUp (const MouseEvent &) override
 
void mouseWheelMove (const MouseEvent &, const MouseWheelDetails &) override
 
void lookAndFeelChanged () override
 
void paint (Graphics &) override
 
void resized () override
 
bool keyStateChanged (bool) override
 
bool keyPressed (const KeyPress &) override
 
void valueChanged (Value &) override
 
void parentHierarchyChanged () override
 
 JUCE_DEPRECATED (void clear(bool))
 
 JUCE_DEPRECATED (void setSelectedId(int, bool))
 
 JUCE_DEPRECATED (void setSelectedItemIndex(int, bool))
 
 JUCE_DEPRECATED (void setText(const String &, bool))
 
- Public Member Functions inherited from Component
 Component ()
 Creates a component.
 
virtual ~Component ()
 Destructor.
 
 Component (const String &componentName)
 Creates a component, setting its name at the same time.
 
const StringgetName () const noexcept
 Returns the name of this component.
 
virtual void setName (const String &newName)
 Sets the name of this component.
 
const StringgetComponentID () const noexcept
 Returns the ID string that was set by setComponentID().
 
void setComponentID (const String &newID)
 Sets the component's ID string.
 
virtual void setVisible (bool shouldBeVisible)
 Makes the component visible or invisible.
 
bool isVisible () const noexcept
 Tests whether the component is visible or not.
 
virtual void visibilityChanged ()
 Called when this component's visibility changes.
 
bool isShowing () const
 Tests whether this component and all its parents are visible.
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 Makes this component appear as a window on the desktop.
 
void removeFromDesktop ()
 If the component is currently showing on the desktop, this will hide it.
 
bool isOnDesktop () const noexcept
 Returns true if this component is currently showing on the desktop.
 
ComponentPeergetPeer () const
 Returns the heavyweight window that contains this component.
 
virtual void userTriedToCloseWindow ()
 For components on the desktop, this is called if the system wants to close the window.
 
virtual void minimisationStateChanged (bool isNowMinimised)
 Called for a desktop component which has just been minimised or un-minimised.
 
virtual float getDesktopScaleFactor () const
 Returns the default scale factor to use for this component when it is placed on the desktop.
 
void toFront (bool shouldAlsoGainFocus)
 Brings the component to the front of its siblings.
 
void toBack ()
 Changes this component's z-order to be at the back of all its siblings.
 
void toBehind (Component *other)
 Changes this component's z-order so that it's just behind another component.
 
void setAlwaysOnTop (bool shouldStayOnTop)
 Sets whether the component should always be kept at the front of its siblings.
 
bool isAlwaysOnTop () const noexcept
 Returns true if this component is set to always stay in front of its siblings.
 
int getX () const noexcept
 Returns the x coordinate of the component's left edge.
 
int getY () const noexcept
 Returns the y coordinate of the top of this component.
 
int getWidth () const noexcept
 Returns the component's width in pixels.
 
int getHeight () const noexcept
 Returns the component's height in pixels.
 
int getRight () const noexcept
 Returns the x coordinate of the component's right-hand edge.
 
Point< int > getPosition () const noexcept
 Returns the component's top-left position as a Point.
 
int getBottom () const noexcept
 Returns the y coordinate of the bottom edge of this component.
 
const Rectangle< int > & getBounds () const noexcept
 Returns this component's bounding box.
 
Rectangle< int > getLocalBounds () const noexcept
 Returns the component's bounds, relative to its own origin.
 
Rectangle< int > getBoundsInParent () const noexcept
 Returns the area of this component's parent which this component covers.
 
void getVisibleArea (RectangleList< int > &result, bool includeSiblings) const
 Returns the region of this component that's not obscured by other, opaque components.
 
int getScreenX () const
 Returns this component's x coordinate relative the screen's top-left origin.
 
int getScreenY () const
 Returns this component's y coordinate relative the screen's top-left origin.
 
Point< int > getScreenPosition () const
 Returns the position of this component's top-left corner relative to the screen's top-left.
 
Rectangle< int > getScreenBounds () const
 Returns the bounds of this component, relative to the screen's top-left.
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Rectangle< int > getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space.
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate.
 
void setTopLeftPosition (int x, int y)
 Moves the component to a new position.
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 Moves the component to a new position.
 
void setTopRightPosition (int x, int y)
 Moves the component to a new position.
 
void setSize (int newWidth, int newHeight)
 Changes the size of the component.
 
void setBounds (int x, int y, int width, int height)
 Changes the component's position and size.
 
void setBounds (const Rectangle< int > &newBounds)
 Changes the component's position and size.
 
void setBounds (const RelativeRectangle &newBounds)
 Changes the component's position and size.
 
void setBounds (const String &newBoundsExpression)
 Sets the component's bounds with an expression.
 
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.
 
void setBoundsInset (const BorderSize< int > &borders)
 Changes the component's position and size based on the amount of space to leave around it.
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 Positions the component within a given rectangle, keeping its proportions unchanged.
 
void setCentrePosition (int x, int y)
 Changes the position of the component's centre.
 
void setCentreRelative (float x, float y)
 Changes the position of the component's centre.
 
void centreWithSize (int width, int height)
 Changes the component's size and centres it within its parent.
 
void setTransform (const AffineTransform &transform)
 Sets a transform matrix to be applied to this component.
 
AffineTransform getTransform () const
 Returns the transform that is currently being applied to this component.
 
bool isTransformed () const noexcept
 Returns true if a non-identity transform is being applied to this component.
 
int proportionOfWidth (float proportion) const noexcept
 Returns a proportion of the component's width.
 
int proportionOfHeight (float proportion) const noexcept
 Returns a proportion of the component's height.
 
int getParentWidth () const noexcept
 Returns the width of the component's parent.
 
int getParentHeight () const noexcept
 Returns the height of the component's parent.
 
Rectangle< int > getParentMonitorArea () const
 Returns the screen coordinates of the monitor that contains this component.
 
int getNumChildComponents () const noexcept
 Returns the number of child components that this component contains.
 
ComponentgetChildComponent (int index) const noexcept
 Returns one of this component's child components, by it index.
 
int getIndexOfChildComponent (const Component *child) const noexcept
 Returns the index of this component in the list of child components.
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 Looks for a child component with the specified ID.
 
void addChildComponent (Component *child, int zOrder=-1)
 Adds a child component to this one.
 
void addChildComponent (Component &child, int zOrder=-1)
 Adds a child component to this one.
 
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.
 
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.
 
void addChildAndSetID (Component *child, const String &componentID)
 Adds a child component to this one, makes it visible, and sets its component ID.
 
void removeChildComponent (Component *childToRemove)
 Removes one of this component's child-components.
 
ComponentremoveChildComponent (int childIndexToRemove)
 Removes one of this component's child-components by index.
 
void removeAllChildren ()
 Removes all this component's children.
 
void deleteAllChildren ()
 Removes all this component's children, and deletes them.
 
ComponentgetParentComponent () const noexcept
 Returns the component which this component is inside.
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 Searches the parent components for a component of a specified class.
 
ComponentgetTopLevelComponent () const noexcept
 Returns the highest-level component which contains this one or its parents.
 
bool isParentOf (const Component *possibleChild) const noexcept
 Checks whether a component is anywhere inside this component or its children.
 
virtual void childrenChanged ()
 Subclasses can use this callback to be told when children are added or removed, or when their z-order changes.
 
virtual bool hitTest (int x, int y)
 Tests whether a given point inside the component.
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 Changes the default return value for the hitTest() method.
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 Retrieves the current state of the mouse-click interception flags.
 
bool contains (Point< int > localPoint)
 Returns true if a given point lies within this component or one of its children.
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 Returns true if a given point lies in this component, taking any overlapping siblings into account.
 
ComponentgetComponentAt (int x, int y)
 Returns the component at a certain point within this one.
 
ComponentgetComponentAt (Point< int > position)
 Returns the component at a certain point within this one.
 
void repaint ()
 Marks the whole component as needing to be redrawn.
 
void repaint (int x, int y, int width, int height)
 Marks a subsection of this component as needing to be redrawn.
 
void repaint (const Rectangle< int > &area)
 Marks a subsection of this component as needing to be redrawn.
 
void setBufferedToImage (bool shouldBeBuffered)
 Makes the component use an internal buffer to optimise its redrawing.
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 Generates a snapshot of part of this component.
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 Draws this component and all its subcomponents onto the specified graphics context.
 
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.
 
void setComponentEffect (ImageEffectFilter *newEffect)
 Adds an effect filter to alter the component's appearance.
 
ImageEffectFiltergetComponentEffect () const noexcept
 Returns the current component effect.
 
LookAndFeelgetLookAndFeel () const noexcept
 Finds the appropriate look-and-feel to use for this component.
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 Sets the look and feel to use for this component.
 
void sendLookAndFeelChange ()
 Calls the lookAndFeelChanged() method in this component and all its children.
 
void setOpaque (bool shouldBeOpaque)
 Indicates whether any parts of the component might be transparent.
 
bool isOpaque () const noexcept
 Returns true if no parts of this component are transparent.
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 Indicates whether the component should be brought to the front when clicked.
 
bool isBroughtToFrontOnMouseClick () const noexcept
 Indicates whether the component should be brought to the front when clicked-on.
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component needs keyboard focus or not.
 
bool getWantsKeyboardFocus () const noexcept
 Returns true if the component is interested in getting keyboard focus.
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 Chooses whether a click on this component automatically grabs the focus.
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 Returns the last value set with setMouseClickGrabsKeyboardFocus().
 
void grabKeyboardFocus ()
 Tries to give keyboard focus to this component.
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 Returns true if this component currently has the keyboard focus.
 
void moveKeyboardFocusToSibling (bool moveToNext)
 Tries to move the keyboard focus to one of this component's siblings.
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component.
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified.
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the index used in determining the order in which focusable components should be traversed.
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 Indicates whether this component is a parent for components that can have their focus traversed.
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container.
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled.
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component.
 
void setAlpha (float newAlpha)
 Changes the transparency of this component.
 
float getAlpha () const
 Returns the component's current transparancy level.
 
void setMouseCursor (const MouseCursor &cursorType)
 Changes the mouse cursor shape to use when the mouse is over this component.
 
virtual MouseCursor getMouseCursor ()
 Returns the mouse cursor shape to use when the mouse is over this component.
 
void updateMouseCursor () const
 Forces the current mouse cursor to be updated.
 
virtual void paintOverChildren (Graphics &g)
 Components can override this method to draw over the top of their children.
 
virtual void mouseMove (const MouseEvent &event) override
 Called when the mouse moves inside a component.
 
virtual void mouseEnter (const MouseEvent &event) override
 Called when the mouse first enters a component.
 
virtual void mouseExit (const MouseEvent &event) override
 Called when the mouse moves out of a component.
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 Called when a mouse button has been double-clicked on a component.
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 Called when a pinch-to-zoom mouse-gesture is used.
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 Causes automatic repaints when the mouse enters or exits this component.
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 Registers a listener to be told when mouse events occur in this component.
 
void removeMouseListener (MouseListener *listenerToRemove)
 Deregisters a mouse listener.
 
void addKeyListener (KeyListener *newListener)
 Adds a listener that wants to hear about keypresses that this component receives.
 
void removeKeyListener (KeyListener *listenerToRemove)
 Removes a previously-registered key listener.
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 Called when a modifier key is pressed or released.
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 Called to indicate that one of this component's children has been focused or unfocused.
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component.
 
bool isMouseButtonDown () const
 Returns true if the mouse button is currently held down in this component.
 
bool isMouseOverOrDragging () const
 True if the mouse is over this component, or if it's being dragged in this component.
 
Point< int > getMouseXYRelative () const
 Returns the mouse's current position, relative to this component.
 
virtual void moved ()
 Called when this component's position has been changed.
 
virtual void childBoundsChanged (Component *child)
 Called when one of this component's children is moved or resized.
 
virtual void parentSizeChanged ()
 Called when this component's immediate parent has been resized.
 
virtual void broughtToFront ()
 Called when this component has been moved to the front of its siblings.
 
void addComponentListener (ComponentListener *newListener)
 Adds a listener to be told about changes to the component hierarchy or position.
 
void removeComponentListener (ComponentListener *listenerToRemove)
 Removes a component listener.
 
void postCommandMessage (int commandId)
 Dispatches a numbered message to this component.
 
virtual void handleCommandMessage (int commandId)
 Called to handle a command that was sent by postCommandMessage().
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Runs a component modally, waiting until the loop terminates.
 
void exitModalState (int returnValue)
 Ends a component's modal state.
 
bool isCurrentlyModal () const noexcept
 Returns true if this component is the modal one.
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 Checks whether there's a modal component somewhere that's stopping this one from receiving messages.
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 When a component is modal, this callback allows it to choose which other components can still receive events.
 
virtual void inputAttemptWhenModal ()
 Called when the user tries to click on a component that is blocked by another modal component.
 
NamedValueSetgetProperties () noexcept
 Returns the set of properties that belong to this component.
 
const NamedValueSetgetProperties () const noexcept
 Returns the set of properties that belong to this component.
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 Looks for a colour that has been registered with the given colour ID number.
 
void setColour (int colourId, Colour newColour)
 Registers a colour to be used for a particular purpose.
 
void removeColour (int colourId)
 If a colour has been set with setColour(), this will remove it.
 
bool isColourSpecified (int colourId) const
 Returns true if the specified colour ID has been explicitly set for this component using the setColour() method.
 
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.
 
virtual MarkerListgetMarkers (bool xAxis)
 Components can implement this method to provide a MarkerList.
 
void * getWindowHandle () const
 Returns the underlying native window handle for this component.
 
PositionergetPositioner () const noexcept
 Returns the Positioner object that has been set for this component.
 
void setPositioner (Positioner *newPositioner)
 Sets a new Positioner object for this component.
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 Gives the component a CachedComponentImage that should be used to buffer its painting.
 
CachedComponentImagegetCachedComponentImage () const noexcept
 Returns the object that was set by setCachedComponentImage().
 
 JUCE_DEPRECATED (Point< int > relativePositionToGlobal(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > globalPositionToRelative(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > relativePositionToOtherComponent(const Component *, Point< int >) const)
 
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()
 Destructor.
 
- Public Member Functions inherited from SettableTooltipClient
virtual ~SettableTooltipClient ()
 Destructor.
 
- Public Member Functions inherited from TooltipClient
virtual ~TooltipClient ()
 Destructor.
 
- Public Member Functions inherited from Label::Listener
virtual ~Listener ()
 Destructor.
 
virtual void editorShown (Label *, TextEditor &textEditorShown)
 Called when a Label goes into editing mode and displays a TextEditor.
 
- Public Member Functions inherited from Value::Listener
 Listener ()
 
virtual ~Listener ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Component
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
 Returns the component that currently has the keyboard focus.
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 If any component has keyboard focus, this will defocus it.
 
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.
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 Returns true if a mouse button is currently down.
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 Returns the number of components that are currently in a modal state.
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 Returns one of the components that are currently modal.
 
- Protected Member Functions inherited from SettableTooltipClient
 SettableTooltipClient ()
 
- Private Member Functions inherited from AsyncUpdater
 AsyncUpdater ()
 Creates an AsyncUpdater object.
 
virtual ~AsyncUpdater ()
 Destructor.
 
void triggerAsyncUpdate ()
 Causes the callback to be triggered at a later time.
 
void cancelPendingUpdate () noexcept
 This will stop any pending updates from happening.
 
void handleUpdateNowIfNeeded ()
 If an update has been triggered and is pending, this will invoke it synchronously.
 
bool isUpdatePending () const noexcept
 Returns true if there's an update callback in the pipeline.
 

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 register a ComboBox::Listener to receive callbacks.

See Also
ComboBox::Listener

Member Enumeration Documentation

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

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.

Constructor & Destructor Documentation

ComboBox::ComboBox ( const String componentName = String::empty)
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.

Parameters
componentNamethe name to set for the component (see Component::setName())
ComboBox::~ComboBox ( )

Destructor.

Member Function Documentation

void ComboBox::setEditableText ( bool  isEditable)

Sets whether the test 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.

bool ComboBox::isTextEditable ( ) const
noexcept

Returns true if the text is directly editable.

See Also
setEditableText
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.

Justification ComboBox::getJustificationType ( ) const
noexcept

Returns the current justification for the text box.

See Also
setJustificationType
void ComboBox::addItem ( const String newItemText,
int  newItemId 
)

Adds an item to be shown in the drop-down list.

Parameters
newItemTextthe text of the item to show in the list
newItemIdan 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
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.

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().

void ComboBox::addSectionHeading ( const String headingName)

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

bool ComboBox::isItemEnabled ( int  itemId) const
noexcept

Returns true if the given item is enabled.

void ComboBox::changeItemText ( int  itemId,
const String newText 
)

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.

See Also
addItem, getNumItems
int ComboBox::getNumItems ( ) const
noexcept

Returns the number of items that have been added to the list.

Note that this doesn't include headers or separators.

String ComboBox::getItemText ( int  index) const

Returns the text for one of the items in the list.

Note that this doesn't include headers or separators.

Parameters
indexthe item's index from 0 to (getNumItems() - 1)
int ComboBox::getItemId ( int  index) const
noexcept

Returns the ID for one of the items in the list.

Note that this doesn't include headers or separators.

Parameters
indexthe item's index from 0 to (getNumItems() - 1)
int ComboBox::indexOfItemId ( int  itemId) const
noexcept

Returns the index in the list of a particular item ID.

If no such ID is found, this will return -1.

int ComboBox::getSelectedId ( ) const
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
Value& ComboBox::getSelectedIdAsValue ( )

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.

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.

Parameters
newItemIdthe new item to select
notificationdetermines the type of change notification that will be sent to listeners if the value changes
See Also
getSelectedId, setSelectedItemIndex, setText
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.

See Also
setSelectedItemIndex, getSelectedId, getText
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.

Parameters
newItemIndexthe new item to select
notificationdetermines the type of change notification that will be sent to listeners if the value changes
See Also
getSelectedItemIndex, setSelectedId, setText
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.

See Also
setText, getSelectedId, getSelectedItemIndex
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.

Parameters
newTextthe text to select
notificationdetermines the type of change notification that will be sent to listeners if the text changes
See Also
getText
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.

See Also
Label::showEditor();
virtual void ComboBox::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.

void ComboBox::addListener ( Listener listener)

Registers a listener that will be called when the box's content changes.

void ComboBox::removeListener ( Listener listener)

Deregisters a previously-registered listener.

void ComboBox::setTextWhenNothingSelected ( const String newMessage)

Sets a message to display when there is no item currently selected.

See Also
getTextWhenNothingSelected
String ComboBox::getTextWhenNothingSelected ( ) const

Returns the text that is shown when no item is selected.

See Also
setTextWhenNothingSelected
void ComboBox::setTextWhenNoChoicesAvailable ( const String newMessage)

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.

String ComboBox::getTextWhenNoChoicesAvailable ( ) const

Returns the text shown when no items have been added to the list.

See Also
setTextWhenNoChoicesAvailable
void ComboBox::setTooltip ( const String newTooltip)
overridevirtual

Gives the ComboBox a tooltip.

Reimplemented from SettableTooltipClient.

void ComboBox::setScrollWheelEnabled ( bool  enabled)
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::labelTextChanged ( Label )
overridevirtual

Implements Label::Listener.

void ComboBox::enablementChanged ( )
overridevirtual

Reimplemented from Component.

void ComboBox::colourChanged ( )
overridevirtual

Reimplemented from Component.

void ComboBox::focusGained ( Component::FocusChangeType  )
overridevirtual

Reimplemented from Component.

void ComboBox::focusLost ( Component::FocusChangeType  )
overridevirtual

Reimplemented from Component.

void ComboBox::handleAsyncUpdate ( )
overridevirtual

Implements AsyncUpdater.

String ComboBox::getTooltip ( )
overridevirtual

Reimplemented from SettableTooltipClient.

void ComboBox::mouseDown ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void ComboBox::mouseDrag ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void ComboBox::mouseUp ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void ComboBox::mouseWheelMove ( const MouseEvent ,
const MouseWheelDetails  
)
overridevirtual

Reimplemented from Component.

void ComboBox::lookAndFeelChanged ( )
overridevirtual

Reimplemented from Component.

void ComboBox::paint ( Graphics )
overridevirtual

Reimplemented from Component.

void ComboBox::resized ( )
overridevirtual

Reimplemented from Component.

bool ComboBox::keyStateChanged ( bool  )
overridevirtual

Reimplemented from Component.

bool ComboBox::keyPressed ( const KeyPress )
overridevirtual

Reimplemented from Component.

void ComboBox::valueChanged ( Value )
overridevirtual

Implements Value::Listener.

void ComboBox::parentHierarchyChanged ( )
overridevirtual

Reimplemented from Component.

ComboBox::JUCE_DEPRECATED ( void   clearbool)
ComboBox::JUCE_DEPRECATED ( void   setSelectedIdint, bool)
ComboBox::JUCE_DEPRECATED ( void   setSelectedItemIndexint, bool)
ComboBox::JUCE_DEPRECATED ( void   setTextconst String &, bool)

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