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

A list of items that can be scrolled vertically. More...

Inherits Component, and SettableTooltipClient.

Inherited by FileListComponent, and TableListBox.

Public Types

enum  ColourIds { backgroundColourId = 0x1002800, outlineColourId = 0x1002810, textColourId = 0x1002820 }
 A set of colour IDs to use to change the colour of various aspects of the label. More...
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 Enumeration used by the focusChanged() and focusLost() methods. More...
 

Public Member Functions

 ListBox (const String &componentName=String::empty, ListBoxModel *model=nullptr)
 Creates a ListBox.
 
 ~ListBox ()
 Destructor.
 
void setModel (ListBoxModel *newModel)
 Changes the current data model to display.
 
ListBoxModelgetModel () const noexcept
 Returns the current list model.
 
void updateContent ()
 Causes the list to refresh its content.
 
void setMultipleSelectionEnabled (bool shouldBeEnabled)
 Turns on multiple-selection of rows.
 
void setMouseMoveSelectsRows (bool shouldSelect)
 Makes the list react to mouse moves by selecting the row that the mouse if over.
 
void selectRow (int rowNumber, bool dontScrollToShowThisRow=false, bool deselectOthersFirst=true)
 Selects a row.
 
void selectRangeOfRows (int firstRow, int lastRow)
 Selects a set of rows.
 
void deselectRow (int rowNumber)
 Deselects a row.
 
void deselectAllRows ()
 Deselects any currently selected rows.
 
void flipRowSelection (int rowNumber)
 Selects or deselects a row.
 
SparseSet< int > getSelectedRows () const
 Returns a sparse set indicating the rows that are currently selected.
 
void setSelectedRows (const SparseSet< int > &setOfRowsToBeSelected, NotificationType sendNotificationEventToModel=sendNotification)
 Sets the rows that should be selected, based on an explicit set of ranges.
 
bool isRowSelected (int rowNumber) const
 Checks whether a row is selected.
 
int getNumSelectedRows () const
 Returns the number of rows that are currently selected.
 
int getSelectedRow (int index=0) const
 Returns the row number of a selected row.
 
int getLastRowSelected () const
 Returns the last row that the user selected.
 
void selectRowsBasedOnModifierKeys (int rowThatWasClickedOn, ModifierKeys modifiers, bool isMouseUpEvent)
 Multiply-selects rows based on the modifier keys.
 
void setVerticalPosition (double newProportion)
 Scrolls the list to a particular position.
 
double getVerticalPosition () const
 Returns the current vertical position as a proportion of the total.
 
void scrollToEnsureRowIsOnscreen (int row)
 Scrolls if necessary to make sure that a particular row is visible.
 
ScrollBargetVerticalScrollBar () const noexcept
 Returns a pointer to the vertical scrollbar.
 
ScrollBargetHorizontalScrollBar () const noexcept
 Returns a pointer to the horizontal scrollbar.
 
int getRowContainingPosition (int x, int y) const noexcept
 Finds the row index that contains a given x,y position.
 
int getInsertionIndexForPosition (int x, int y) const noexcept
 Finds a row index that would be the most suitable place to insert a new item for a given position.
 
Rectangle< int > getRowPosition (int rowNumber, bool relativeToComponentTopLeft) const noexcept
 Returns the position of one of the rows, relative to the top-left of the listbox.
 
ComponentgetComponentForRowNumber (int rowNumber) const noexcept
 Finds the row component for a given row in the list.
 
int getRowNumberOfComponent (Component *rowComponent) const noexcept
 Returns the row number that the given component represents.
 
int getVisibleRowWidth () const noexcept
 Returns the width of a row (which may be less than the width of this component if there's a scrollbar).
 
void setRowHeight (int newHeight)
 Sets the height of each row in the list.
 
int getRowHeight () const noexcept
 Returns the height of a row in the list.
 
int getNumRowsOnScreen () const noexcept
 Returns the number of rows actually visible.
 
void setOutlineThickness (int outlineThickness)
 Sets the thickness of a border that will be drawn around the box.
 
int getOutlineThickness () const noexcept
 Returns the thickness of outline that will be drawn around the listbox.
 
void setHeaderComponent (Component *newHeaderComponent)
 Sets a component that the list should use as a header.
 
void setMinimumContentWidth (int newMinimumWidth)
 Changes the width of the rows in the list.
 
int getVisibleContentWidth () const noexcept
 Returns the space currently available for the row items, taking into account borders, scrollbars, etc.
 
void repaintRow (int rowNumber) noexcept
 Repaints one of the rows.
 
virtual Image createSnapshotOfSelectedRows (int &x, int &y)
 This fairly obscure method creates an image that just shows the currently selected row components.
 
ViewportgetViewport () const noexcept
 Returns the viewport that this ListBox uses.
 
bool keyPressed (const KeyPress &) override
 
bool keyStateChanged (bool isKeyDown) override
 
void paint (Graphics &) override
 
void paintOverChildren (Graphics &) override
 
void resized () override
 
void visibilityChanged () override
 
void mouseWheelMove (const MouseEvent &, const MouseWheelDetails &) override
 
void mouseUp (const MouseEvent &) override
 
void colourChanged () override
 
void parentHierarchyChanged () override
 
void startDragAndDrop (const MouseEvent &, const var &dragDescription, bool allowDraggingToOtherWindows)
 
- Public Member Functions inherited from Component
 Component () noexcept
 Creates a component.
 
virtual ~Component ()
 Destructor.
 
 Component (const String &componentName) noexcept
 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.
 
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.
 
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.
 
virtual void lookAndFeelChanged ()
 Called to let the component react to a change in the look-and-feel setting.
 
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.
 
virtual void enablementChanged ()
 Callback to indicate that this component has been enabled or disabled.
 
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 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 mouseDown (const MouseEvent &event) override
 Called when a mouse button is pressed.
 
virtual void mouseDrag (const MouseEvent &event) override
 Called when the mouse is moved while a button is held down.
 
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 focusGained (FocusChangeType cause)
 Called to indicate that this component has just acquired the keyboard focus.
 
virtual void focusLost (FocusChangeType cause)
 Called to indicate that this component has just lost the keyboard focus.
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 Called to indicate a change in whether or not this component is the parent of the currently-focused component.
 
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.
 
virtual void setTooltip (const String &newTooltip)
 Assigns a new tooltip to this object.
 
virtual String getTooltip ()
 Returns the tooltip assigned to this object.
 
- Public Member Functions inherited from TooltipClient
virtual ~TooltipClient ()
 Destructor.
 

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

Detailed Description

A list of items that can be scrolled vertically.

To create a list, you'll need to create a subclass of ListBoxModel. This can either paint each row of the list and respond to events via callbacks, or for more specialised tasks, it can supply a custom component to fill each row.

See Also
ComboBox, TableListBox

Member Enumeration Documentation

A set of colour IDs to use to change the colour of various aspects of the label.

These constants can be used either via the Component::setColour(), or LookAndFeel::setColour() methods.

See Also
Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
Enumerator:
backgroundColourId 

The background colour to fill the list with.

Make this transparent if you don't want the background to be filled.

outlineColourId 

An optional colour to use to draw a border around the list.

Make this transparent to not have an outline.

textColourId 

The preferred colour to use for drawing text in the listbox.

Constructor & Destructor Documentation

ListBox::ListBox ( const String componentName = String::empty,
ListBoxModel model = nullptr 
)

Creates a ListBox.

The model pointer passed-in can be null, in which case you can set it later with setModel().

ListBox::~ListBox ( )

Destructor.

Member Function Documentation

void ListBox::setModel ( ListBoxModel newModel)

Changes the current data model to display.

ListBoxModel* ListBox::getModel ( ) const
noexcept

Returns the current list model.

void ListBox::updateContent ( )

Causes the list to refresh its content.

Call this when the number of rows in the list changes, or if you want it to call refreshComponentForRow() on all the row components.

This must only be called from the main message thread.

void ListBox::setMultipleSelectionEnabled ( bool  shouldBeEnabled)

Turns on multiple-selection of rows.

By default this is disabled.

When your row component gets clicked you'll need to call the selectRowsBasedOnModifierKeys() method to tell the list that it's been clicked and to get it to do the appropriate selection based on whether the ctrl/shift keys are held down.

void ListBox::setMouseMoveSelectsRows ( bool  shouldSelect)

Makes the list react to mouse moves by selecting the row that the mouse if over.

This function is here primarily for the ComboBox class to use, but might be useful for some other purpose too.

void ListBox::selectRow ( int  rowNumber,
bool  dontScrollToShowThisRow = false,
bool  deselectOthersFirst = true 
)

Selects a row.

If the row is already selected, this won't do anything.

Parameters
rowNumberthe row to select
dontScrollToShowThisRowif true, the list's position won't change; if false and the selected row is off-screen, it'll scroll to make sure that row is on-screen
deselectOthersFirstif true and there are multiple selections, these will first be deselected before this item is selected
See Also
isRowSelected, selectRowsBasedOnModifierKeys, flipRowSelection, deselectRow, deselectAllRows, selectRangeOfRows
void ListBox::selectRangeOfRows ( int  firstRow,
int  lastRow 
)

Selects a set of rows.

This will add these rows to the current selection, so you might need to clear the current selection first with deselectAllRows()

Parameters
firstRowthe first row to select (inclusive)
lastRowthe last row to select (inclusive)
void ListBox::deselectRow ( int  rowNumber)

Deselects a row.

If it's not currently selected, this will do nothing.

See Also
selectRow, deselectAllRows
void ListBox::deselectAllRows ( )

Deselects any currently selected rows.

See Also
deselectRow
void ListBox::flipRowSelection ( int  rowNumber)

Selects or deselects a row.

If the row's currently selected, this deselects it, and vice-versa.

SparseSet<int> ListBox::getSelectedRows ( ) const

Returns a sparse set indicating the rows that are currently selected.

See Also
setSelectedRows
void ListBox::setSelectedRows ( const SparseSet< int > &  setOfRowsToBeSelected,
NotificationType  sendNotificationEventToModel = sendNotification 
)

Sets the rows that should be selected, based on an explicit set of ranges.

If sendNotificationEventToModel is true, the ListBoxModel::selectedRowsChanged() method will be called. If it's false, no notification will be sent to the model.

See Also
getSelectedRows
bool ListBox::isRowSelected ( int  rowNumber) const

Checks whether a row is selected.

int ListBox::getNumSelectedRows ( ) const

Returns the number of rows that are currently selected.

See Also
getSelectedRow, isRowSelected, getLastRowSelected
int ListBox::getSelectedRow ( int  index = 0) const

Returns the row number of a selected row.

This will return the row number of the Nth selected row. The row numbers returned will be sorted in order from low to high.

Parameters
indexthe index of the selected row to return, (from 0 to getNumSelectedRows() - 1)
Returns
the row number, or -1 if the index was out of range or if there aren't any rows selected
See Also
getNumSelectedRows, isRowSelected, getLastRowSelected
int ListBox::getLastRowSelected ( ) const

Returns the last row that the user selected.

This isn't the same as the highest row number that is currently selected - if the user had multiply-selected rows 10, 5 and then 6 in that order, this would return 6.

If nothing is selected, it will return -1.

void ListBox::selectRowsBasedOnModifierKeys ( int  rowThatWasClickedOn,
ModifierKeys  modifiers,
bool  isMouseUpEvent 
)

Multiply-selects rows based on the modifier keys.

If no modifier keys are down, this will select the given row and deselect any others.

If the ctrl (or command on the Mac) key is down, it'll flip the state of the selected row.

If the shift key is down, it'll select up to the given row from the last row selected.

See Also
selectRow
void ListBox::setVerticalPosition ( double  newProportion)

Scrolls the list to a particular position.

The proportion is between 0 and 1.0, so 0 scrolls to the top of the list, 1.0 scrolls to the bottom.

If the total number of rows all fit onto the screen at once, then this method won't do anything.

See Also
getVerticalPosition
double ListBox::getVerticalPosition ( ) const

Returns the current vertical position as a proportion of the total.

This can be used in conjunction with setVerticalPosition() to save and restore the list's position. It returns a value in the range 0 to 1.

See Also
setVerticalPosition
void ListBox::scrollToEnsureRowIsOnscreen ( int  row)

Scrolls if necessary to make sure that a particular row is visible.

ScrollBar* ListBox::getVerticalScrollBar ( ) const
noexcept

Returns a pointer to the vertical scrollbar.

ScrollBar* ListBox::getHorizontalScrollBar ( ) const
noexcept

Returns a pointer to the horizontal scrollbar.

int ListBox::getRowContainingPosition ( int  x,
int  y 
) const
noexcept

Finds the row index that contains a given x,y position.

The position is relative to the ListBox's top-left. If no row exists at this position, the method will return -1.

See Also
getComponentForRowNumber
int ListBox::getInsertionIndexForPosition ( int  x,
int  y 
) const
noexcept

Finds a row index that would be the most suitable place to insert a new item for a given position.

This is useful when the user is e.g. dragging and dropping onto the listbox, because it lets you easily choose the best position to insert the item that they drop, based on where they drop it.

If the position is out of range, this will return -1. If the position is beyond the end of the list, it will return getNumRows() to indicate the end of the list.

See Also
getComponentForRowNumber
Rectangle<int> ListBox::getRowPosition ( int  rowNumber,
bool  relativeToComponentTopLeft 
) const
noexcept

Returns the position of one of the rows, relative to the top-left of the listbox.

This may be off-screen, and the range of the row number that is passed-in is not checked to see if it's a valid row.

Component* ListBox::getComponentForRowNumber ( int  rowNumber) const
noexcept

Finds the row component for a given row in the list.

The component returned will have been created using createRowComponent().

If the component for this row is off-screen or if the row is out-of-range, this will return 0.

See Also
getRowContainingPosition
int ListBox::getRowNumberOfComponent ( Component rowComponent) const
noexcept

Returns the row number that the given component represents.

If the component isn't one of the list's rows, this will return -1.

int ListBox::getVisibleRowWidth ( ) const
noexcept

Returns the width of a row (which may be less than the width of this component if there's a scrollbar).

void ListBox::setRowHeight ( int  newHeight)

Sets the height of each row in the list.

The default height is 22 pixels.

See Also
getRowHeight
int ListBox::getRowHeight ( ) const
noexcept

Returns the height of a row in the list.

See Also
setRowHeight
int ListBox::getNumRowsOnScreen ( ) const
noexcept

Returns the number of rows actually visible.

This is the number of whole rows which will fit on-screen, so the value might be more than the actual number of rows in the list.

void ListBox::setOutlineThickness ( int  outlineThickness)

Sets the thickness of a border that will be drawn around the box.

To set the colour of the outline, use

See Also
outlineColourId
int ListBox::getOutlineThickness ( ) const
noexcept

Returns the thickness of outline that will be drawn around the listbox.

See Also
setOutlineColour
void ListBox::setHeaderComponent ( Component newHeaderComponent)

Sets a component that the list should use as a header.

This will position the given component at the top of the list, maintaining the height of the component passed-in, but rescaling it horizontally to match the width of the items in the listbox.

The component will be deleted when setHeaderComponent() is called with a different component, or when the listbox is deleted.

void ListBox::setMinimumContentWidth ( int  newMinimumWidth)

Changes the width of the rows in the list.

This can be used to make the list's row components wider than the list itself - the width of the rows will be either the width of the list or this value, whichever is greater, and if the rows become wider than the list, a horizontal scrollbar will appear.

The default value for this is 0, which means that the rows will always be the same width as the list.

int ListBox::getVisibleContentWidth ( ) const
noexcept

Returns the space currently available for the row items, taking into account borders, scrollbars, etc.

void ListBox::repaintRow ( int  rowNumber)
noexcept

Repaints one of the rows.

This does not invoke updateContent(), it just invokes a straightforward repaint for the area covered by this row.

virtual Image ListBox::createSnapshotOfSelectedRows ( int &  x,
int &  y 
)
virtual

This fairly obscure method creates an image that just shows the currently selected row components.

It's a handy method for doing drag-and-drop, as it can be passed to the DragAndDropContainer for use as the drag image.

Note that it will make the row components temporarily invisible, so if you're using custom components this could affect them if they're sensitive to that sort of thing.

See Also
Component::createComponentSnapshot
Viewport* ListBox::getViewport ( ) const
noexcept

Returns the viewport that this ListBox uses.

You may need to use this to change parameters such as whether scrollbars are shown, etc.

bool ListBox::keyPressed ( const KeyPress )
overridevirtual

Reimplemented from Component.

bool ListBox::keyStateChanged ( bool  isKeyDown)
overridevirtual

Reimplemented from Component.

void ListBox::paint ( Graphics )
overridevirtual

Reimplemented from Component.

void ListBox::paintOverChildren ( Graphics )
overridevirtual

Reimplemented from Component.

void ListBox::resized ( )
overridevirtual

Reimplemented from Component.

Reimplemented in TableListBox.

void ListBox::visibilityChanged ( )
overridevirtual

Reimplemented from Component.

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

Reimplemented from Component.

void ListBox::mouseUp ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void ListBox::colourChanged ( )
overridevirtual

Reimplemented from Component.

void ListBox::parentHierarchyChanged ( )
overridevirtual

Reimplemented from Component.

void ListBox::startDragAndDrop ( const MouseEvent ,
const var dragDescription,
bool  allowDraggingToOtherWindows 
)

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