openshot-audio
0.1.6
|
#include <juce_TableHeaderComponent.h>
Classes | |
class | DragOverlayComp |
class | Listener |
struct | LookAndFeelMethods |
Public Types | |
enum | ColumnPropertyFlags { visible = 1, resizable = 2, draggable = 4, appearsOnColumnMenu = 8, sortable = 16, sortedForwards = 32, sortedBackwards = 64, defaultFlags = (visible | resizable | draggable | appearsOnColumnMenu | sortable), notResizable = (visible | draggable | appearsOnColumnMenu | sortable), notResizableOrSortable = (visible | draggable | appearsOnColumnMenu), notSortable = (visible | resizable | draggable | appearsOnColumnMenu) } |
A component that displays a strip of column headings for a table, and allows these to be resized, dragged around, etc.
This is just the component that goes at the top of a table. You can use it directly for custom components, or to create a simple table, use the TableListBox class.
To use one of these, create it and use addColumn() to add all the columns that you need. Each column must be given a unique ID number that's used to refer to it.
A combination of these flags are passed into the addColumn() method to specify the properties of a column.
Enumerator | |
---|---|
visible |
If this is set, the column will be shown; if not, it will be hidden until the user enables it with the pop-up menu. |
resizable |
If this is set, the column can be resized by dragging it. |
draggable |
If this is set, the column can be dragged around to change its order in the table. |
appearsOnColumnMenu |
If this is set, the column will be shown on the pop-up menu allowing it to be hidden/shown. |
sortable |
If this is set, then clicking on the column header will set it to be the sort column, and clicking again will reverse the order. |
sortedForwards |
If this is set, the column is currently the one by which the table is sorted (forwards). |
sortedBackwards |
If this is set, the column is currently the one by which the table is sorted (backwards). |
defaultFlags |
This set of default flags is used as the default parameter value in addColumn(). |
notResizable |
A quick way of combining flags for a column that's not resizable. |
notResizableOrSortable |
A quick way of combining flags for a column that's not resizable or sortable. |
notSortable |
A quick way of combining flags for a column that's not sortable. |
TableHeaderComponent::TableHeaderComponent | ( | ) |
Creates an empty table header.
TableHeaderComponent::~TableHeaderComponent | ( | ) |
Destructor.
void TableHeaderComponent::addColumn | ( | const String & | columnName, |
int | columnId, | ||
int | width, | ||
int | minimumWidth = 30 , |
||
int | maximumWidth = -1 , |
||
int | propertyFlags = defaultFlags , |
||
int | insertIndex = -1 |
||
) |
Adds a column to the table.
This will add a column, and asynchronously call the tableColumnsChanged() method of any registered listeners.
columnName | the name of the new column. It's ok to have two or more columns with the same name |
columnId | an ID for this column. The ID can be any number apart from 0, but every column must have a unique ID. This is used to identify the column later on, after the user may have changed the order that they appear in |
width | the initial width of the column, in pixels |
maximumWidth | a maximum width that the column can take when the user is resizing it. This only applies if the 'resizable' flag is specified for this column |
minimumWidth | a minimum width that the column can take when the user is resizing it. This only applies if the 'resizable' flag is specified for this column |
propertyFlags | a combination of some of the values from the ColumnPropertyFlags enum, to define the properties of this column |
insertIndex | the index at which the column should be added. A value of 0 puts it at the start (left-hand side) and -1 puts it at the end (right-hand size) of the table. Note that the index the index within all columns, not just the index amongst those that are currently visible |
void TableHeaderComponent::addListener | ( | Listener * | newListener | ) |
Adds a listener to be informed about things that happen to the header.
This can be overridden to add custom items to the pop-up menu.
If you override this, you should call the superclass's method to add its column show/hide items, if you want them on the menu as well.
Then to handle the result, override reactToMenuItem().
Reimplemented in TableListBox::Header.
|
virtual |
This can be overridden to handle a mouse-click on one of the column headers.
The default implementation will use this click to call getSortColumnId() and change the sort order.
Finds the column ID at a given x-position in the component. If there is a column at this point this returns its ID, or if not, it will return 0.
Returns the ID of the column at a given index.
If onlyCountVisibleColumns is true, this will count the index amoungst the visible columns; otherwise it'll count it amongst all the columns, including any hidden ones.
If the index is out-of-range, it'll return 0.
Returns the name for a column.
Returns the rectangle containing of one of the columns.
The index is an index from 0 to the number of columns that are currently visible (hidden ones are not counted). It returns a rectangle showing the position of the column relative to this component's top-left. If the index is out-of-range, an empty rectangle is retrurned.
Returns the width of one of the columns.
Returns the index of a given column.
If there's no such column ID, this will return -1.
If onlyCountVisibleColumns is true, this will return the index amoungst the visible columns; otherwise it'll return the index amongst all the columns, including any hidden ones.
|
override |
int TableHeaderComponent::getNumColumns | ( | bool | onlyCountVisibleColumns | ) | const |
Returns the number of columns in the table.
If onlyCountVisibleColumns is true, this will return the number of visible columns; otherwise it'll return the total number of columns, including hidden ones.
int TableHeaderComponent::getSortColumnId | ( | ) | const |
Returns the column ID by which the table is currently sorted, or 0 if it is unsorted.
int TableHeaderComponent::getTotalWidth | ( | ) | const |
Returns the total width of all the visible columns in the table.
bool TableHeaderComponent::isColumnVisible | ( | int | columnId | ) | const |
Returns true if this column is currently visible.
bool TableHeaderComponent::isPopupMenuActive | ( | ) | const |
Returns true if the pop-up menu is enabled.
bool TableHeaderComponent::isSortedForwards | ( | ) | const |
Returns true if the table is currently sorted forwards, or false if it's backwards.
bool TableHeaderComponent::isStretchToFitActive | ( | ) | const |
Returns true if stretch-to-fit has been enabled.
|
override |
|
override |
|
override |
|
override |
|
override |
|
override |
Moves a column to a different index in the table.
columnId | the column to move |
newVisibleIndex | the target index for it, from 0 to the number of columns currently visible. |
|
override |
Override this to handle any custom items that you have added to the pop-up menu with an addMenuItems() override.
If the menuReturnId isn't one of your own custom menu items, you'll need to call TableHeaderComponent::reactToMenuItem() to allow the base class to handle the items that it had added.
Reimplemented in TableListBox::Header.
void TableHeaderComponent::removeAllColumns | ( | ) |
Deletes all columns from the table.
If there are any columns to remove, this will asynchronously call the tableColumnsChanged() method of any registered listeners.
void TableHeaderComponent::removeColumn | ( | int | columnIdToRemove | ) |
Removes a column with the given ID.
If there is such a column, this will asynchronously call the tableColumnsChanged() method of any registered listeners.
void TableHeaderComponent::removeListener | ( | Listener * | listenerToRemove | ) |
Removes a previously-registered listener.
void TableHeaderComponent::resizeAllColumnsToFit | ( | int | targetTotalWidth | ) |
If stretch-to-fit is enabled, this will resize all the columns to make them fit into the specified width, keeping their relative proportions the same.
If the minimum widths of the columns are too wide to fit into this space, it may actually end up wider.
|
override |
void TableHeaderComponent::reSortTable | ( | ) |
Triggers a re-sort of the table according to the current sort-column.
If you modifiy the table's contents, you can call this to signal that the table needs to be re-sorted.
(This doesn't do any sorting synchronously - it just asynchronously sends a call to the tableSortOrderChanged() method of any listeners).
Restores the state of the table, based on a string previously created with toString().
Changes the name of a column.
void TableHeaderComponent::setColumnVisible | ( | int | columnId, |
bool | shouldBeVisible | ||
) |
Shows or hides a column.
This can cause an asynchronous callback to the tableColumnsChanged() method of any registered listeners.
Changes the width of a column.
This will cause an asynchronous callback to the tableColumnsResized() method of any registered listeners.
void TableHeaderComponent::setPopupMenuActive | ( | bool | hasMenu | ) |
Enables or disables the pop-up menu.
The default menu allows the user to show or hide columns. You can add custom items to this menu by overloading the addMenuItems() and reactToMenuItem() methods.
By default the menu is enabled.
void TableHeaderComponent::setSortColumnId | ( | int | columnId, |
bool | sortForwards | ||
) |
Changes the column which is the sort column.
This can cause an asynchronous callback to the tableSortOrderChanged() method of any registered listeners.
If this method doesn't actually change the column ID, then no re-sort will take place (you can call reSortTable() to force a re-sort to happen if you've modified the table's contents).
void TableHeaderComponent::setStretchToFitActive | ( | bool | shouldStretchToFit | ) |
If set to true, this indicates that the columns should be expanded or shrunk to fill the entire width of the component.
By default this is disabled. Turning it on also means that when resizing a column, those on the right will be squashed to fit.
|
virtual |
Can be overridden for more control over the pop-up menu behaviour.
String TableHeaderComponent::toString | ( | ) | const |
Returns a string that encapsulates the table's current layout.
This can be restored later using restoreFromString(). It saves the order of the columns, the currently-sorted column, and the widths.