A layout that arranges child elements in a grid. More...
#include <qcustomplot.h>
Public Types | |
enum | FillOrder { foRowsFirst, foColumnsFirst } |
![]() | |
enum | SizeConstraintRect { scrInnerRect, scrOuterRect } |
enum | UpdatePhase { upPreparation, upMargins, upLayout } |
Public Member Functions | |
bool | addElement (int row, int column, QCPLayoutElement *element) |
bool | addElement (QCPLayoutElement *element) |
int | columnCount () const |
int | columnSpacing () const |
QList< double > | columnStretchFactors () const |
QCPLayoutElement * | element (int row, int column) const |
virtual QCPLayoutElement * | elementAt (int index) const Q_DECL_OVERRIDE |
virtual int | elementCount () const Q_DECL_OVERRIDE |
virtual QList< QCPLayoutElement * > | elements (bool recursive) const Q_DECL_OVERRIDE |
void | expandTo (int newRowCount, int newColumnCount) |
FillOrder | fillOrder () const |
bool | hasElement (int row, int column) |
void | indexToRowCol (int index, int &row, int &column) const |
void | insertColumn (int newIndex) |
void | insertRow (int newIndex) |
virtual QSize | maximumOuterSizeHint () const Q_DECL_OVERRIDE |
virtual QSize | minimumOuterSizeHint () const Q_DECL_OVERRIDE |
QCPLayoutGrid () | |
int | rowColToIndex (int row, int column) const |
int | rowCount () const |
int | rowSpacing () const |
QList< double > | rowStretchFactors () const |
void | setColumnSpacing (int pixels) |
void | setColumnStretchFactor (int column, double factor) |
void | setColumnStretchFactors (const QList< double > &factors) |
void | setFillOrder (FillOrder order, bool rearrange=true) |
void | setRowSpacing (int pixels) |
void | setRowStretchFactor (int row, double factor) |
void | setRowStretchFactors (const QList< double > &factors) |
void | setWrap (int count) |
virtual void | simplify () Q_DECL_OVERRIDE |
virtual bool | take (QCPLayoutElement *element) Q_DECL_OVERRIDE |
virtual QCPLayoutElement * | takeAt (int index) Q_DECL_OVERRIDE |
virtual void | updateLayout () Q_DECL_OVERRIDE |
int | wrap () const |
virtual | ~QCPLayoutGrid () |
![]() | |
void | clear () |
QCPLayout () | |
bool | remove (QCPLayoutElement *element) |
bool | removeAt (int index) |
virtual void | update (UpdatePhase phase) Q_DECL_OVERRIDE |
![]() | |
QCP::MarginSides | autoMargins () const |
QCPLayout * | layout () const |
QCPMarginGroup * | marginGroup (QCP::MarginSide side) const |
QHash< QCP::MarginSide, QCPMarginGroup * > | marginGroups () const |
QMargins | margins () const |
QSize | maximumSize () const |
QMargins | minimumMargins () const |
QSize | minimumSize () const |
QRect | outerRect () const |
QCPLayoutElement (QCustomPlot *parentPlot=0) | |
QRect | rect () const |
virtual double | selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE |
void | setAutoMargins (QCP::MarginSides sides) |
void | setMarginGroup (QCP::MarginSides sides, QCPMarginGroup *group) |
void | setMargins (const QMargins &margins) |
void | setMaximumSize (const QSize &size) |
void | setMaximumSize (int width, int height) |
void | setMinimumMargins (const QMargins &margins) |
void | setMinimumSize (const QSize &size) |
void | setMinimumSize (int width, int height) |
void | setOuterRect (const QRect &rect) |
void | setSizeConstraintRect (SizeConstraintRect constraintRect) |
SizeConstraintRect | sizeConstraintRect () const |
virtual | ~QCPLayoutElement () |
![]() | |
bool | antialiased () const |
QCPLayer * | layer () const |
QCPLayerable * | parentLayerable () const |
QCustomPlot * | parentPlot () const |
QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0) | |
bool | realVisibility () const |
void | setAntialiased (bool enabled) |
Q_SLOT bool | setLayer (QCPLayer *layer) |
bool | setLayer (const QString &layerName) |
void | setVisible (bool on) |
bool | visible () const |
virtual | ~QCPLayerable () |
Protected Member Functions | |
void | getMaximumRowColSizes (QVector< int > *maxColWidths, QVector< int > *maxRowHeights) const |
void | getMinimumRowColSizes (QVector< int > *minColWidths, QVector< int > *minRowHeights) const |
![]() | |
void | adoptElement (QCPLayoutElement *el) |
QVector< int > | getSectionSizes (QVector< int > maxSizes, QVector< int > minSizes, QVector< double > stretchFactors, int totalSize) const |
void | releaseElement (QCPLayoutElement *el) |
void | sizeConstraintsChanged () const |
![]() | |
virtual void | applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE |
virtual int | calculateAutoMargin (QCP::MarginSide side) |
virtual void | draw (QCPPainter *painter) Q_DECL_OVERRIDE |
virtual void | layoutChanged () |
virtual void | parentPlotInitialized (QCustomPlot *parentPlot) Q_DECL_OVERRIDE |
![]() | |
void | applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const |
virtual QRect | clipRect () const |
virtual void | deselectEvent (bool *selectionStateChanged) |
void | initializeParentPlot (QCustomPlot *parentPlot) |
virtual void | mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details) |
virtual void | mouseMoveEvent (QMouseEvent *event, const QPointF &startPos) |
virtual void | mousePressEvent (QMouseEvent *event, const QVariant &details) |
virtual void | mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos) |
bool | moveToLayer (QCPLayer *layer, bool prepend) |
virtual void | selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) |
virtual QCP::Interaction | selectionCategory () const |
void | setParentLayerable (QCPLayerable *parentLayerable) |
virtual void | wheelEvent (QWheelEvent *event) |
Protected Attributes | |
int | mColumnSpacing |
QList< double > | mColumnStretchFactors |
QList< QList< QCPLayoutElement * > > | mElements |
FillOrder | mFillOrder |
int | mRowSpacing |
QList< double > | mRowStretchFactors |
int | mWrap |
![]() | |
QCP::MarginSides | mAutoMargins |
QHash< QCP::MarginSide, QCPMarginGroup * > | mMarginGroups |
QMargins | mMargins |
QSize | mMaximumSize |
QMargins | mMinimumMargins |
QSize | mMinimumSize |
QRect | mOuterRect |
QCPLayout * | mParentLayout |
QRect | mRect |
SizeConstraintRect | mSizeConstraintRect |
![]() | |
bool | mAntialiased |
QCPLayer * | mLayer |
QPointer< QCPLayerable > | mParentLayerable |
QCustomPlot * | mParentPlot |
bool | mVisible |
Additional Inherited Members | |
![]() | |
void | layerChanged (QCPLayer *newLayer) |
![]() | |
static QSize | getFinalMaximumOuterSize (const QCPLayoutElement *el) |
static QSize | getFinalMinimumOuterSize (const QCPLayoutElement *el) |
A layout that arranges child elements in a grid.
Elements are laid out in a grid with configurable stretch factors (setColumnStretchFactor, setRowStretchFactor) and spacing (setColumnSpacing, setRowSpacing).
Elements can be added to cells via addElement. The grid is expanded if the specified row or column doesn't exist yet. Whether a cell contains a valid layout element can be checked with hasElement, that element can be retrieved with element. If rows and columns that only have empty cells shall be removed, call simplify. Removal of elements is either done by just adding the element to a different layout or by using the QCPLayout interface take or remove.
If you use addElement(QCPLayoutElement*) without explicit parameters for row and column, the grid layout will choose the position according to the current setFillOrder and the wrapping (setWrap).
Row and column insertion can be performed with insertRow and insertColumn.
Definition at line 1327 of file qcustomplot.h.
Defines in which direction the grid is filled when using addElement(QCPLayoutElement*). The column/row at which wrapping into the next row/column occurs can be specified with setWrap.
Enumerator | |
---|---|
foRowsFirst | Rows are filled first, and a new element is wrapped to the next column if the row count would exceed setWrap. |
foColumnsFirst | Columns are filled first, and a new element is wrapped to the next row if the column count would exceed setWrap. |
Definition at line 1349 of file qcustomplot.h.
|
explicit |
Creates an instance of QCPLayoutGrid and sets default values.
Definition at line 4079 of file qcustomplot.cpp.
|
virtual |
Definition at line 4087 of file qcustomplot.cpp.
bool QCPLayoutGrid::addElement | ( | int | row, |
int | column, | ||
QCPLayoutElement * | element | ||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Adds the element to cell with row and column. If element is already in a layout, it is first removed from there. If row or column don't exist yet, the layout is expanded accordingly.
Returns true if the element was added successfully, i.e. if the cell at row and column didn't already have an element.
Use the overload of this method without explicit row/column index to place the element according to the configured fill order and wrapping settings.
Definition at line 4134 of file qcustomplot.cpp.
bool QCPLayoutGrid::addElement | ( | QCPLayoutElement * | element | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Adds the element to the next empty cell according to the current fill order (setFillOrder) and wrapping (setWrap). If element is already in a layout, it is first removed from there. If necessary, the layout is expanded to hold the new element.
Returns true if the element was added successfully.
Definition at line 4160 of file qcustomplot.cpp.
|
inline |
Returns the number of columns in the layout.
Definition at line 1359 of file qcustomplot.h.
|
inline |
Definition at line 1362 of file qcustomplot.h.
|
inline |
Definition at line 1360 of file qcustomplot.h.
QCPLayoutElement * QCPLayoutGrid::element | ( | int | row, |
int | column | ||
) | const |
Returns the element in the cell in row and column.
Returns 0 if either the row/column is invalid or if the cell is empty. In those cases, a qDebug message is printed. To check whether a cell exists and isn't empty, use hasElement.
Definition at line 4102 of file qcustomplot.cpp.
|
virtual |
Note that the association of the linear index to the row/column based cells depends on the current setting of setFillOrder.
Implements QCPLayout.
Definition at line 4600 of file qcustomplot.cpp.
|
inlinevirtual |
Returns the number of elements/cells in the layout.
Implements QCPLayout.
Definition at line 1379 of file qcustomplot.h.
|
virtual |
Returns a list of all child elements in this layout element. If recursive is true, all sub-child elements are included in the list, too.
Reimplemented from QCPLayout.
Definition at line 4655 of file qcustomplot.cpp.
void QCPLayoutGrid::expandTo | ( | int | newRowCount, |
int | newColumnCount | ||
) |
Expands the layout to have newRowCount rows and newColumnCount columns. So the last valid row index will be newRowCount-1, the last valid column index will be newColumnCount-1.
If the current column/row count is already larger or equal to newColumnCount/newRowCount, this function does nothing in that dimension.
Newly created cells are empty, new rows and columns have the stretch factor 1.
Note that upon a call to addElement, the layout is expanded automatically to contain the specified row and column, using this function.
Definition at line 4416 of file qcustomplot.cpp.
|
inline |
Definition at line 1365 of file qcustomplot.h.
|
protected |
Definition at line 4807 of file qcustomplot.cpp.
|
protected |
Definition at line 4774 of file qcustomplot.cpp.
bool QCPLayoutGrid::hasElement | ( | int | row, |
int | column | ||
) |
Returns whether the cell at row and column exists and contains a valid element, i.e. isn't empty.
Definition at line 4196 of file qcustomplot.cpp.
void QCPLayoutGrid::indexToRowCol | ( | int | index, |
int & | row, | ||
int & | column | ||
) | const |
Converts the linear index to row and column indices and writes the result to row and column.
The way the cells are indexed depends on setFillOrder. If it is foRowsFirst, the indices increase left to right and then top to bottom. If it is foColumnsFirst, the indices increase top to bottom and then left to right.
If there are no cells (i.e. column or row count is zero), sets row and column to -1.
For the retrieved row and column to be valid, the passed index must be valid itself, i.e. greater or equal to zero and smaller than the current elementCount.
Definition at line 4532 of file qcustomplot.cpp.
void QCPLayoutGrid::insertColumn | ( | int | newIndex | ) |
Inserts a new column with empty cells at the column index newIndex. Valid values for newIndex range from 0 (inserts a column at the left) to columnCount (appends a column at the right).
Definition at line 4468 of file qcustomplot.cpp.
void QCPLayoutGrid::insertRow | ( | int | newIndex | ) |
Inserts a new row with empty cells at the row index newIndex. Valid values for newIndex range from 0 (inserts a row at the top) to rowCount (appends a row at the bottom).
Definition at line 4441 of file qcustomplot.cpp.
|
virtual |
Returns the suggested maximum size this layout element (the outerRect) may be expanded to, if no manual maximum size is set.
if a maximum size (setMaximumSize) was not set manually, parent layouts use the returned size (usually indirectly through QCPLayout::getFinalMaximumOuterSize) to determine the maximum allowed size of this layout element.
A manual maximum size is considered set if it is smaller than Qt's QWIDGETSIZE_MAX
.
The default implementation simply returns QWIDGETSIZE_MAX
for both width and height, implying no suggested maximum size. Reimplementations may use their detailed knowledge about the layout element's content to provide size hints.
Reimplemented from QCPLayoutElement.
Definition at line 4740 of file qcustomplot.cpp.
|
virtual |
Returns the suggested minimum size this layout element (the outerRect) may be compressed to, if no manual minimum size is set.
if a minimum size (setMinimumSize) was not set manually, parent layouts use the returned size (usually indirectly through QCPLayout::getFinalMinimumOuterSize) to determine the minimum allowed size of this layout element.
A manual minimum size is considered set if it is non-zero.
The default implementation simply returns the sum of the horizontal margins for the width and the sum of the vertical margins for the height. Reimplementations may use their detailed knowledge about the layout element's content to provide size hints.
Reimplemented from QCPLayoutElement.
Definition at line 4723 of file qcustomplot.cpp.
int QCPLayoutGrid::rowColToIndex | ( | int | row, |
int | column | ||
) | const |
Converts the given row and column to the linear index used by some methods of QCPLayoutGrid and QCPLayout.
The way the cells are indexed depends on setFillOrder. If it is foRowsFirst, the indices increase left to right and then top to bottom. If it is foColumnsFirst, the indices increase top to bottom and then left to right.
For the returned index to be valid, row and column must be valid indices themselves, i.e. greater or equal to zero and smaller than the current rowCount/columnCount.
Definition at line 4499 of file qcustomplot.cpp.
|
inline |
Returns the number of rows in the layout.
Definition at line 1358 of file qcustomplot.h.
|
inline |
Definition at line 1363 of file qcustomplot.h.
|
inline |
Definition at line 1361 of file qcustomplot.h.
void QCPLayoutGrid::setColumnSpacing | ( | int | pixels | ) |
Sets the gap that is left blank between columns to pixels.
Definition at line 4315 of file qcustomplot.cpp.
void QCPLayoutGrid::setColumnStretchFactor | ( | int | column, |
double | factor | ||
) |
Sets the stretch factor of column.
Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond their minimum and maximum widths/heights, regardless of the stretch factor. (see QCPLayoutElement::setMinimumSize, QCPLayoutElement::setMaximumSize, QCPLayoutElement::setSizeConstraintRect.)
The default stretch factor of newly created rows/columns is 1.
Definition at line 4216 of file qcustomplot.cpp.
void QCPLayoutGrid::setColumnStretchFactors | ( | const QList< double > & | factors | ) |
Sets the stretch factors of all columns. factors must have the size columnCount.
Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond their minimum and maximum widths/heights, regardless of the stretch factor. (see QCPLayoutElement::setMinimumSize, QCPLayoutElement::setMaximumSize, QCPLayoutElement::setSizeConstraintRect.)
The default stretch factor of newly created rows/columns is 1.
Definition at line 4240 of file qcustomplot.cpp.
void QCPLayoutGrid::setFillOrder | ( | FillOrder | order, |
bool | rearrange = true |
||
) |
Sets the filling order and wrapping behaviour that is used when adding new elements with the method addElement(QCPLayoutElement*).
The specified order defines whether rows or columns are filled first. Using setWrap, you can control at which row/column count wrapping into the next column/row will occur. If you set it to zero, no wrapping will ever occur. Changing the fill order also changes the meaning of the linear index used e.g. in elementAt and takeAt. The default fill order for QCPLayoutGrid is foColumnsFirst.
If you want to have all current elements arranged in the new order, set rearrange to true. The elements will be rearranged in a way that tries to preserve their linear index. However, empty cells are skipped during build-up of the new cell order, which shifts the succeeding element's index. The rearranging is performed even if the specified order is already the current fill order. Thus this method can be used to re-wrap the current elements.
If rearrange is false, the current element arrangement is not changed, which means the linear indexes change (because the linear index is dependent on the fill order).
Note that the method addElement(int row, int column, QCPLayoutElement *element) with explicitly stated row and column is not subject to wrapping and can place elements even beyond the specified wrapping point.
Definition at line 4377 of file qcustomplot.cpp.
void QCPLayoutGrid::setRowSpacing | ( | int | pixels | ) |
Sets the gap that is left blank between rows to pixels.
Definition at line 4325 of file qcustomplot.cpp.
void QCPLayoutGrid::setRowStretchFactor | ( | int | row, |
double | factor | ||
) |
Sets the stretch factor of row.
Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond their minimum and maximum widths/heights, regardless of the stretch factor. (see QCPLayoutElement::setMinimumSize, QCPLayoutElement::setMaximumSize, QCPLayoutElement::setSizeConstraintRect.)
The default stretch factor of newly created rows/columns is 1.
Definition at line 4269 of file qcustomplot.cpp.
void QCPLayoutGrid::setRowStretchFactors | ( | const QList< double > & | factors | ) |
Sets the stretch factors of all rows. factors must have the size rowCount.
Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond their minimum and maximum widths/heights, regardless of the stretch factor. (see QCPLayoutElement::setMinimumSize, QCPLayoutElement::setMaximumSize, QCPLayoutElement::setSizeConstraintRect.)
The default stretch factor of newly created rows/columns is 1.
Definition at line 4293 of file qcustomplot.cpp.
void QCPLayoutGrid::setWrap | ( | int | count | ) |
Sets the maximum number of columns or rows that are used, before new elements added with addElement(QCPLayoutElement*) will start to fill the next row or column, respectively. It depends on setFillOrder, whether rows or columns are wrapped.
If count is set to zero, no wrapping will ever occur.
If you wish to re-wrap the elements currently in the layout, call setFillOrder with rearrange set to true (the actual fill order doesn't need to be changed for the rearranging to be done).
Note that the method addElement(int row, int column, QCPLayoutElement *element) with explicitly stated row and column is not subject to wrapping and can place elements even beyond the specified wrapping point.
Definition at line 4347 of file qcustomplot.cpp.
|
virtual |
Simplifies the layout by collapsing rows and columns which only contain empty cells.
Reimplemented from QCPLayout.
Definition at line 4678 of file qcustomplot.cpp.
|
virtual |
Removes the specified element from the layout and returns true on success.
If the element isn't in this layout, returns false.
Note that some layouts don't remove the respective cell right away but leave an empty cell after successful removal of the layout element. To collapse empty cells, use simplify.
Implements QCPLayout.
Definition at line 4636 of file qcustomplot.cpp.
|
virtual |
Note that the association of the linear index to the row/column based cells depends on the current setting of setFillOrder.
Implements QCPLayout.
Definition at line 4619 of file qcustomplot.cpp.
|
virtual |
Reimplemented from QCPLayout.
Definition at line 4564 of file qcustomplot.cpp.
|
inline |
Definition at line 1364 of file qcustomplot.h.
|
protected |
Definition at line 1404 of file qcustomplot.h.
|
protected |
Definition at line 1402 of file qcustomplot.h.
|
protected |
Definition at line 1401 of file qcustomplot.h.
|
protected |
Definition at line 1406 of file qcustomplot.h.
|
protected |
Definition at line 1404 of file qcustomplot.h.
|
protected |
Definition at line 1403 of file qcustomplot.h.
|
protected |
Definition at line 1405 of file qcustomplot.h.