openshot-audio
0.1.6
|
#include <juce_ListBox.h>
Classes | |
class | ListViewport |
class | RowComponent |
Public Types | |
enum | ColourIds { backgroundColourId = 0x1002800, outlineColourId = 0x1002810, textColourId = 0x1002820 } |
Friends | |
class | ListViewport |
class | TableListBox |
Additional Inherited Members | |
![]() | |
SettableTooltipClient () | |
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 = 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.
|
override |
This fairly obscure method creates an image that shows the row components specified in rows (for example, these could be 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.
void ListBox::deselectAllRows | ( | ) |
Deselects any currently selected rows.
void ListBox::deselectRow | ( | int | rowNumber | ) |
Deselects a row. If it's not currently selected, this will do nothing.
void ListBox::flipRowSelection | ( | int | rowNumber | ) |
Selects or deselects a row. If the row's currently selected, this deselects it, and vice-versa.
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 nullptr.
|
inlinenoexcept |
Returns whatever header component was set with setHeaderComponent().
|
noexcept |
Returns a pointer to the horizontal scrollbar.
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.
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.
|
inlinenoexcept |
Returns the current list model.
|
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.
int ListBox::getNumSelectedRows | ( | ) | const |
Returns the number of rows that are currently selected.
|
inlinenoexcept |
Returns the thickness of outline that will be drawn around the listbox.
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.
|
inlinenoexcept |
Returns the height of a row in the list.
Returns the row number that the given component represents. If the component isn't one of the list's rows, this will return -1.
|
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.
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) |
Returns a sparse set indicating the rows that are currently selected.
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.
|
noexcept |
Returns a pointer to the vertical scrollbar.
|
noexcept |
Returns the viewport that this ListBox uses.
You may need to use this to change parameters such as whether scrollbars are shown, etc.
|
noexcept |
Returns the space currently available for the row items, taking into account borders, scrollbars, etc.
|
noexcept |
Returns the width of a row (which may be less than the width of this component if there's a scrollbar).
bool ListBox::isRowSelected | ( | int | rowNumber | ) | const |
Checks whether a row is selected.
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
|
noexcept |
Repaints one of the rows.
This does not invoke updateContent(), it just invokes a straightforward repaint for the area covered by this row.
|
override |
void ListBox::scrollToEnsureRowIsOnscreen | ( | int | row | ) |
Scrolls if necessary to make sure that a particular row is visible.
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::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::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.
|
noexcept |
If enabled, this makes the listbox flip the selection status of each row that the user clicks, without affecting other selected rows.
(This only has an effect if multiple selection is also enabled). If not enabled, you can still get the same row-flipping behaviour by holding down CMD or CTRL when clicking.
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.
void ListBox::setModel | ( | ListBoxModel * | newModel | ) |
Changes the current data model to display.
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.
|
noexcept |
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::setOutlineThickness | ( | int | outlineThickness | ) |
Sets the thickness of a border that will be drawn around the box.
To set the colour of the outline, use
void ListBox::setRowHeight | ( | int | newHeight | ) |
Sets the height of each row in the list. The default height is 22 pixels.
|
noexcept |
Sets whether a row should be selected when the mouse is pressed or released. By default this is true, but you may want to turn it off.
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.
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.
void ListBox::startDragAndDrop | ( | const MouseEvent & | e, |
const SparseSet< int > & | rowsToDrag, | ||
const var & | dragDescription, | ||
bool | allowDraggingToOtherWindows | ||
) |
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.
|
override |
|
friend |
|
friend |