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 Member Functions | |
| ListBox (const String &componentName=String::empty, ListBoxModel *model=0) | |
| Creates a ListBox. | |
| ~ListBox () | |
| Destructor. | |
| void | setModel (ListBoxModel *newModel) |
| Changes the current data model to display. | |
| ListBoxModel * | getModel () 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. | |
| const SparseSet< int > | getSelectedRows () const |
| Returns a sparse set indicating the rows that are currently selected. | |
| void | setSelectedRows (const SparseSet< int > &setOfRowsToBeSelected, bool sendNotificationEventToModel=true) |
| 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, const 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. | |
| ScrollBar * | getVerticalScrollBar () const noexcept |
| Returns a pointer to the scrollbar. | |
| ScrollBar * | getHorizontalScrollBar () const noexcept |
| Returns a pointer to the 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. | |
| const 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. | |
| Component * | getComponentForRowNumber (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 const Image | createSnapshotOfSelectedRows (int &x, int &y) |
| This fairly obscure method creates an image that just shows the currently selected row components. | |
| Viewport * | getViewport () const noexcept |
| Returns the viewport that this ListBox uses. | |
| bool | keyPressed (const KeyPress &key) |
| Called when a key is pressed. | |
| bool | keyStateChanged (bool isKeyDown) |
| Called when a key is pressed or released. | |
| void | paint (Graphics &g) |
| Components can override this method to draw their content. | |
| void | paintOverChildren (Graphics &g) |
| Components can override this method to draw over the top of their children. | |
| void | resized () |
| Called when this component's size has been changed. | |
| void | visibilityChanged () |
| Called when this component's visiblility changes. | |
| void | mouseWheelMove (const MouseEvent &e, float wheelIncrementX, float wheelIncrementY) |
| Called when the mouse-wheel is moved. | |
| void | mouseMove (const MouseEvent &) |
| Called when the mouse moves inside this component. | |
| void | mouseExit (const MouseEvent &) |
| Called when the mouse moves out of this component. | |
| void | mouseUp (const MouseEvent &) |
| Called when a mouse button is released. | |
| void | colourChanged () |
| This method is called when a colour is changed by the setColour() method. | |
| void | startDragAndDrop (const MouseEvent &e, const var &dragDescription, bool allowDraggingToOtherWindows=true) |
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.
| enum ListBox::ColourIds |
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.
| ListBox::ListBox | ( | const String & | componentName = String::empty, |
| ListBoxModel * | model = 0 |
||
| ) |
Creates a ListBox.
The model pointer passed-in can be null, in which case you can set it later with setModel().
| ListBox::~ListBox | ( | ) |
Destructor.
| void ListBox::setModel | ( | ListBoxModel * | newModel ) |
Changes the current data model to display.
| ListBoxModel* ListBox::getModel | ( | ) | const |
Returns the current list model.
Reimplemented in TableListBox.
| 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.
| rowNumber | the row to select |
| dontScrollToShowThisRow | if 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 |
| deselectOthersFirst | if true and there are multiple selections, these will first be deselected before this item is selected |
| 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()
| firstRow | the first row to select (inclusive) |
| lastRow | the last row to select (inclusive) |
| void ListBox::deselectRow | ( | int | rowNumber ) |
Deselects a row.
If it's not currently selected, this will do nothing.
| void ListBox::deselectAllRows | ( | ) |
Deselects any currently selected rows.
| void ListBox::flipRowSelection | ( | int | rowNumber ) |
Selects or deselects a row.
If the row's currently selected, this deselects it, and vice-versa.
| const SparseSet<int> ListBox::getSelectedRows | ( | ) | const |
Returns a sparse set indicating the rows that are currently selected.
| void ListBox::setSelectedRows | ( | const SparseSet< int > & | setOfRowsToBeSelected, |
| bool | sendNotificationEventToModel = true |
||
| ) |
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.
| 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.
| 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.
| index | the index of the selected row to return, (from 0 to getNumSelectedRows() - 1) |
| 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, |
| const 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.
| 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.
| 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.
| void ListBox::scrollToEnsureRowIsOnscreen | ( | int | row ) |
Scrolls if necessary to make sure that a particular row is visible.
| ScrollBar* ListBox::getVerticalScrollBar | ( | ) | const |
Returns a pointer to the scrollbar.
(Unlikely to be useful for most people).
| ScrollBar* ListBox::getHorizontalScrollBar | ( | ) | const |
Returns a pointer to the scrollbar.
(Unlikely to be useful for most people).
| int ListBox::getRowContainingPosition | ( | int | x, |
| int | y | ||
| ) | const |
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.
| int ListBox::getInsertionIndexForPosition | ( | int | x, |
| int | y | ||
| ) | const |
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.
| const Rectangle<int> ListBox::getRowPosition | ( | int | rowNumber, |
| bool | relativeToComponentTopLeft | ||
| ) | const |
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 |
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.
| int ListBox::getRowNumberOfComponent | ( | Component * | rowComponent ) | const |
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 |
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 ) |
| int ListBox::getRowHeight | ( | ) | const |
Returns the height of a row in the list.
| int ListBox::getNumRowsOnScreen | ( | ) | const |
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
setColour (ListBox::outlineColourId, colourXYZ);
| int ListBox::getOutlineThickness | ( | ) | const |
Returns the thickness of outline that will be drawn around the listbox.
| 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 |
Returns the space currently available for the row items, taking into account borders, scrollbars, etc.
| void ListBox::repaintRow | ( | int | rowNumber ) |
Repaints one of the rows.
This is a lightweight alternative to calling updateContent, and just causes a repaint of the row's area.
| virtual const 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.
| Viewport* ListBox::getViewport | ( | ) | const |
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 & | key ) | [virtual] |
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.
Reimplemented from Component.
| bool ListBox::keyStateChanged | ( | bool | isKeyDown ) | [virtual] |
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.
| isKeyDown | true if a key has been pressed; false if it has been released |
Reimplemented from Component.
| void ListBox::paint | ( | Graphics & | g ) | [virtual] |
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().
| g | the graphics context that must be used to do the drawing operations. |
Reimplemented from Component.
| void ListBox::paintOverChildren | ( | Graphics & | g ) | [virtual] |
| void ListBox::resized | ( | ) | [virtual] |
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.
Reimplemented from Component.
Reimplemented in TableListBox.
| void ListBox::visibilityChanged | ( | ) | [virtual] |
Called when this component's visiblility changes.
Reimplemented from Component.
| void ListBox::mouseWheelMove | ( | const MouseEvent & | e, |
| float | wheelIncrementX, | ||
| float | wheelIncrementY | ||
| ) | [virtual] |
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, the 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.
| e | details about the position and status of the mouse event |
| wheelIncrementX | the speed and direction of the horizontal scroll-wheel - a positive value means the wheel has been pushed to the right, negative means it was pushed to the left |
| wheelIncrementY | the speed and direction of the vertical scroll-wheel - a positive value means the wheel has been pushed upwards, negative means it was pushed downwards |
Reimplemented from Component.
| void ListBox::mouseMove | ( | const MouseEvent & | e ) | [virtual] |
Called when the mouse moves inside this component.
If the mouse button isn't pressed and the mouse moves over a component, this will be called to let the component react to this.
A component will always get a mouseEnter callback before a mouseMove.
| e | details about the position and status of the mouse event |
Reimplemented from Component.
| void ListBox::mouseExit | ( | const MouseEvent & | e ) | [virtual] |
Called when the mouse moves out of this component.
This will be called when the mouse moves off the edge of this component.
If the mouse button was pressed, and it was then dragged off the edge of the component and released, then this callback will happen when the button is released, after the mouseUp callback.
If you're writing a component that needs to repaint itself when the mouse enters and exits, it might be quicker to use the setRepaintsOnMouseActivity() method.
| e | details about the position and status of the mouse event |
Reimplemented from Component.
| void ListBox::mouseUp | ( | const MouseEvent & | e ) | [virtual] |
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.
| e | details about the position and status of the mouse event |
Reimplemented from Component.
| void ListBox::colourChanged | ( | ) | [virtual] |
This method is called when a colour is changed by the setColour() method.
Reimplemented from Component.
| void ListBox::startDragAndDrop | ( | const MouseEvent & | e, |
| const var & | dragDescription, | ||
| bool | allowDraggingToOtherWindows = true |
||
| ) |
