openshot-audio  0.1.7
Classes | Public Types | Public Member Functions | List of all members
ComboBox Class Reference

#include <juce_ComboBox.h>

Inheritance diagram for ComboBox:
Component SettableTooltipClient Label::Listener Value::Listener AsyncUpdater MouseListener TooltipClient

Classes

class  Listener
 
struct  LookAndFeelMethods
 

Public Types

enum  ColourIds {
  backgroundColourId = 0x1000b00, textColourId = 0x1000a00, outlineColourId = 0x1000c00, buttonColourId = 0x1000d00,
  arrowColourId = 0x1000e00
}
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 

Public Member Functions

 ComboBox (const String &componentName=String::empty)
 
 ~ComboBox ()
 
void setEditableText (bool isEditable)
 
bool isTextEditable () const noexcept
 
void setJustificationType (Justification justification)
 
Justification getJustificationType () const noexcept
 
void addItem (const String &newItemText, int newItemId)
 
void addItemList (const StringArray &items, int firstItemIdOffset)
 
void addSeparator ()
 
void addSectionHeading (const String &headingName)
 
void setItemEnabled (int itemId, bool shouldBeEnabled)
 
bool isItemEnabled (int itemId) const noexcept
 
void changeItemText (int itemId, const String &newText)
 
void clear (NotificationType notification=sendNotificationAsync)
 
int getNumItems () const noexcept
 
String getItemText (int index) const
 
int getItemId (int index) const noexcept
 
int indexOfItemId (int itemId) const noexcept
 
int getSelectedId () const noexcept
 
ValuegetSelectedIdAsValue ()
 
void setSelectedId (int newItemId, NotificationType notification=sendNotificationAsync)
 
int getSelectedItemIndex () const
 
void setSelectedItemIndex (int newItemIndex, NotificationType notification=sendNotificationAsync)
 
String getText () const
 
void setText (const String &newText, NotificationType notification=sendNotificationAsync)
 
void showEditor ()
 
virtual void showPopup ()
 
void hidePopup ()
 
bool isPopupActive () const noexcept
 
virtual void addItemsToMenu (PopupMenu &) const
 
void addListener (Listener *listener)
 
void removeListener (Listener *listener)
 
void setTextWhenNothingSelected (const String &newMessage)
 
String getTextWhenNothingSelected () const
 
void setTextWhenNoChoicesAvailable (const String &newMessage)
 
String getTextWhenNoChoicesAvailable () const
 
void setTooltip (const String &newTooltip) override
 
void setScrollWheelEnabled (bool enabled) noexcept
 
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 () noexcept
 
virtual ~Component ()
 
 Component (const String &componentName) noexcept
 
const StringgetName () const noexcept
 
virtual void setName (const String &newName)
 
const StringgetComponentID () const noexcept
 
void setComponentID (const String &newID)
 
virtual void setVisible (bool shouldBeVisible)
 
bool isVisible () const noexcept
 
virtual void visibilityChanged ()
 
bool isShowing () const
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 
void removeFromDesktop ()
 
bool isOnDesktop () const noexcept
 
ComponentPeergetPeer () const
 
virtual void userTriedToCloseWindow ()
 
virtual void minimisationStateChanged (bool isNowMinimised)
 
virtual float getDesktopScaleFactor () const
 
void toFront (bool shouldAlsoGainFocus)
 
void toBack ()
 
void toBehind (Component *other)
 
void setAlwaysOnTop (bool shouldStayOnTop)
 
bool isAlwaysOnTop () const noexcept
 
int getX () const noexcept
 
int getY () const noexcept
 
int getWidth () const noexcept
 
int getHeight () const noexcept
 
int getRight () const noexcept
 
Point< int > getPosition () const noexcept
 
int getBottom () const noexcept
 
const Rectangle< int > & getBounds () const noexcept
 
Rectangle< int > getLocalBounds () const noexcept
 
Rectangle< int > getBoundsInParent () const noexcept
 
int getScreenX () const
 
int getScreenY () const
 
Point< int > getScreenPosition () const
 
Rectangle< int > getScreenBounds () const
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 
Rectangle< int > getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &localArea) const
 
void setTopLeftPosition (int x, int y)
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 
void setTopRightPosition (int x, int y)
 
void setSize (int newWidth, int newHeight)
 
void setBounds (int x, int y, int width, int height)
 
void setBounds (const Rectangle< int > &newBounds)
 
void setBounds (const RelativeRectangle &newBounds)
 
void setBounds (const String &newBoundsExpression)
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 
void setBoundsInset (const BorderSize< int > &borders)
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 
void setCentrePosition (int x, int y)
 
void setCentreRelative (float x, float y)
 
void centreWithSize (int width, int height)
 
void setTransform (const AffineTransform &transform)
 
AffineTransform getTransform () const
 
bool isTransformed () const noexcept
 
int proportionOfWidth (float proportion) const noexcept
 
int proportionOfHeight (float proportion) const noexcept
 
int getParentWidth () const noexcept
 
int getParentHeight () const noexcept
 
Rectangle< int > getParentMonitorArea () const
 
int getNumChildComponents () const noexcept
 
ComponentgetChildComponent (int index) const noexcept
 
int getIndexOfChildComponent (const Component *child) const noexcept
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 
void addChildComponent (Component *child, int zOrder=-1)
 
void addChildComponent (Component &child, int zOrder=-1)
 
void addAndMakeVisible (Component *child, int zOrder=-1)
 
void addAndMakeVisible (Component &child, int zOrder=-1)
 
void addChildAndSetID (Component *child, const String &componentID)
 
void removeChildComponent (Component *childToRemove)
 
ComponentremoveChildComponent (int childIndexToRemove)
 
void removeAllChildren ()
 
void deleteAllChildren ()
 
ComponentgetParentComponent () const noexcept
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 
ComponentgetTopLevelComponent () const noexcept
 
bool isParentOf (const Component *possibleChild) const noexcept
 
virtual void childrenChanged ()
 
virtual bool hitTest (int x, int y)
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 
bool contains (Point< int > localPoint)
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 
ComponentgetComponentAt (int x, int y)
 
ComponentgetComponentAt (Point< int > position)
 
void repaint ()
 
void repaint (int x, int y, int width, int height)
 
void repaint (const Rectangle< int > &area)
 
void setBufferedToImage (bool shouldBeBuffered)
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 
void setComponentEffect (ImageEffectFilter *newEffect)
 
ImageEffectFiltergetComponentEffect () const noexcept
 
LookAndFeelgetLookAndFeel () const noexcept
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 
void sendLookAndFeelChange ()
 
void setOpaque (bool shouldBeOpaque)
 
bool isOpaque () const noexcept
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 
bool isBroughtToFrontOnMouseClick () const noexcept
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 
bool getWantsKeyboardFocus () const noexcept
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 
void grabKeyboardFocus ()
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 
void moveKeyboardFocusToSibling (bool moveToNext)
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 
int getExplicitFocusOrder () const
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 
bool isFocusContainer () const noexcept
 
bool isEnabled () const noexcept
 
void setEnabled (bool shouldBeEnabled)
 
void setAlpha (float newAlpha)
 
float getAlpha () const
 
void setMouseCursor (const MouseCursor &cursorType)
 
virtual MouseCursor getMouseCursor ()
 
void updateMouseCursor () const
 
virtual void paintOverChildren (Graphics &g)
 
virtual void mouseMove (const MouseEvent &event) override
 
virtual void mouseEnter (const MouseEvent &event) override
 
virtual void mouseExit (const MouseEvent &event) override
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 
void removeMouseListener (MouseListener *listenerToRemove)
 
void addKeyListener (KeyListener *newListener)
 
void removeKeyListener (KeyListener *listenerToRemove)
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 
bool isMouseOver (bool includeChildren=false) const
 
bool isMouseButtonDown () const
 
bool isMouseOverOrDragging () const
 
Point< int > getMouseXYRelative () const
 
virtual void moved ()
 
virtual void childBoundsChanged (Component *child)
 
virtual void parentSizeChanged ()
 
virtual void broughtToFront ()
 
void addComponentListener (ComponentListener *newListener)
 
void removeComponentListener (ComponentListener *listenerToRemove)
 
void postCommandMessage (int commandId)
 
virtual void handleCommandMessage (int commandId)
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 
void exitModalState (int returnValue)
 
bool isCurrentlyModal () const noexcept
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 
virtual void inputAttemptWhenModal ()
 
NamedValueSetgetProperties () noexcept
 
const NamedValueSetgetProperties () const noexcept
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 
void setColour (int colourId, Colour newColour)
 
void removeColour (int colourId)
 
bool isColourSpecified (int colourId) const
 
void copyAllExplicitColoursTo (Component &target) const
 
virtual MarkerListgetMarkers (bool xAxis)
 
void * getWindowHandle () const
 
PositionergetPositioner () const noexcept
 
void setPositioner (Positioner *newPositioner)
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 
CachedComponentImagegetCachedComponentImage () const noexcept
 
 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 ()
 
- Public Member Functions inherited from SettableTooltipClient
virtual ~SettableTooltipClient ()
 
- Public Member Functions inherited from TooltipClient
virtual ~TooltipClient ()
 
- Public Member Functions inherited from Label::Listener
virtual ~Listener ()
 
virtual void editorShown (Label *, TextEditor &)
 
virtual void editorHidden (Label *, 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
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks)
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 
- Protected Member Functions inherited from Component
virtual ComponentPeercreateNewPeer (int styleFlags, void *nativeWindowToAttachTo)
 
- Protected Member Functions inherited from SettableTooltipClient
 SettableTooltipClient ()
 

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

◆ 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

Constructor & Destructor Documentation

◆ ComboBox()

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::~ComboBox ( )

Destructor.

Member Function Documentation

◆ addItem()

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

◆ addItemList()

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.

◆ addItemsToMenu()

void ComboBox::addItemsToMenu ( PopupMenu menu) const
virtual

Adds the items in this ComboBox to the given menu.

◆ addListener()

void ComboBox::addListener ( Listener listener)

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

◆ addSectionHeading()

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

◆ addSeparator()

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

◆ changeItemText()

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

Changes the text for an existing item.

◆ clear()

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

◆ colourChanged()

void ComboBox::colourChanged ( )
overridevirtual

This method is called when a colour is changed by the setColour() method.

See also
setColour, findColour

Reimplemented from Component.

◆ enablementChanged()

void ComboBox::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 Component.

◆ focusGained()

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

Called to indicate that this component has just acquired the keyboard focus.

See also
focusLost, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus

Reimplemented from Component.

◆ focusLost()

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

Called to indicate that this component has just lost the keyboard focus.

See also
focusGained, setWantsKeyboardFocus, getCurrentlyFocusedComponent, hasKeyboardFocus

Reimplemented from Component.

◆ getItemId()

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)

◆ getItemText()

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)

◆ getJustificationType()

Justification ComboBox::getJustificationType ( ) const
noexcept

Returns the current justification for the text box.

See also
setJustificationType

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

◆ getSelectedId()

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

◆ getSelectedIdAsValue()

Value& ComboBox::getSelectedIdAsValue ( )
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.

◆ getSelectedItemIndex()

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

◆ getText()

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

◆ getTextWhenNoChoicesAvailable()

String ComboBox::getTextWhenNoChoicesAvailable ( ) const

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

See also
setTextWhenNoChoicesAvailable

◆ getTextWhenNothingSelected()

String ComboBox::getTextWhenNothingSelected ( ) const

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

See also
setTextWhenNothingSelected

◆ getTooltip()

String ComboBox::getTooltip ( )
inlineoverridevirtual

Returns the tooltip assigned to this object.

Reimplemented from SettableTooltipClient.

◆ handleAsyncUpdate()

void ComboBox::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 AsyncUpdater.

◆ hidePopup()

void ComboBox::hidePopup ( )

Hides the combo box's popup list, if it's currently visible.

◆ indexOfItemId()

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.

◆ isItemEnabled()

bool ComboBox::isItemEnabled ( int  itemId) const
noexcept

Returns true if the given item is enabled.

◆ isPopupActive()

bool ComboBox::isPopupActive ( ) const
inlinenoexcept

Returns true if the popup menu is currently being shown.

◆ isTextEditable()

bool ComboBox::isTextEditable ( ) const
noexcept

Returns true if the text is directly editable.

See also
setEditableText

◆ JUCE_DEPRECATED() [1/4]

ComboBox::JUCE_DEPRECATED ( void   clearbool)

◆ JUCE_DEPRECATED() [2/4]

ComboBox::JUCE_DEPRECATED ( void   setSelectedIdint, bool)

◆ JUCE_DEPRECATED() [3/4]

ComboBox::JUCE_DEPRECATED ( void   setSelectedItemIndexint, bool)

◆ JUCE_DEPRECATED() [4/4]

ComboBox::JUCE_DEPRECATED ( void   setTextconst String &, bool)

◆ keyPressed()

bool ComboBox::keyPressed ( const KeyPress key)
overridevirtual

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

◆ keyStateChanged()

bool ComboBox::keyStateChanged ( bool  isKeyDown)
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
isKeyDowntrue if a key has been pressed; false if it has been released
See also
keyPressed, KeyPress, getCurrentlyFocusedComponent, addKeyListener

Reimplemented from Component.

◆ labelTextChanged()

void ComboBox::labelTextChanged ( Label labelThatHasChanged)
overridevirtual

Called when a Label's text has changed.

Implements Label::Listener.

◆ lookAndFeelChanged()

void ComboBox::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 Component.

◆ mouseDown()

void ComboBox::mouseDown ( const MouseEvent event)
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
eventdetails 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 Component.

◆ mouseDrag()

void ComboBox::mouseDrag ( const MouseEvent event)
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
eventdetails 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 Component.

◆ mouseUp()

void ComboBox::mouseUp ( const MouseEvent event)
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
eventdetails 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 Component.

◆ mouseWheelMove()

void ComboBox::mouseWheelMove ( const MouseEvent event,
const MouseWheelDetails wheel 
)
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. (Bear in mind that if you attach a component as a mouse-listener to other components, then those wheel moves will also end up calling this method and being passed up to the parents, which may not be what you intended to happen).

Parameters
eventdetails about the mouse event
wheeldetails about the mouse wheel movement

Reimplemented from Component.

◆ paint()

void ComboBox::paint ( Graphics g)
overridevirtual

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
gthe graphics context that must be used to do the drawing operations.
See also
repaint, paintOverChildren, Graphics

Reimplemented from Component.

◆ parentHierarchyChanged()

void ComboBox::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 Component.

◆ removeListener()

void ComboBox::removeListener ( Listener listener)

Deregisters a previously-registered listener.

◆ resized()

void ComboBox::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 Component.

◆ setEditableText()

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.

◆ setItemEnabled()

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.

◆ setJustificationType()

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.

◆ setScrollWheelEnabled()

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.

◆ setSelectedId()

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

◆ setSelectedItemIndex()

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

◆ setText()

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

◆ setTextWhenNoChoicesAvailable()

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.

◆ setTextWhenNothingSelected()

void ComboBox::setTextWhenNothingSelected ( const String newMessage)

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

See also
getTextWhenNothingSelected

◆ setTooltip()

void ComboBox::setTooltip ( const String newTooltip)
overridevirtual

Gives the ComboBox a tooltip.

Reimplemented from SettableTooltipClient.

◆ showEditor()

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

◆ showPopup()

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.

◆ valueChanged()

void ComboBox::valueChanged ( Value value)
overridevirtual

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 Value::Listener.


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