A layout that arranges child elements in a grid. More...

Inheritance diagram for QCPLayoutGrid:

Public Functions
	QCPLayoutGrid ()

int	rowCount () const

int	columnCount () const

QList< double >	columnStretchFactors () const

QList< double >	rowStretchFactors () const

int	columnSpacing () const

int	rowSpacing () const

void	setColumnStretchFactor (int column, double factor)

void	setColumnStretchFactors (const QList< double > &factors)

void	setRowStretchFactor (int row, double factor)

void	setRowStretchFactors (const QList< double > &factors)

void	setColumnSpacing (int pixels)

void	setRowSpacing (int pixels)

virtual void	updateLayout ()

virtual int	elementCount () const

virtual QCPLayoutElement *	elementAt (int index) const

virtual QCPLayoutElement *	takeAt (int index)

virtual bool	take (QCPLayoutElement *element)

virtual QList< QCPLayoutElement * >	elements (bool recursive) const

virtual void	simplify ()

virtual QSize	minimumSizeHint () const

virtual QSize	maximumSizeHint () const

QCPLayoutElement *	element (int row, int column) const

bool	addElement (int row, int column, QCPLayoutElement *element)

bool	hasElement (int row, int column)

void	expandTo (int newRowCount, int newColumnCount)

void	insertRow (int newIndex)

void	insertColumn (int newIndex)

Public Functions inherited from QCPLayout
	QCPLayout ()

virtual void	update (UpdatePhase phase)

bool	removeAt (int index)

bool	remove (QCPLayoutElement *element)

void	clear ()

Public Functions inherited from QCPLayoutElement
	QCPLayoutElement (QCustomPlot *parentPlot=0)

QCPLayout *	layout () const

QRect	rect () const

QRect	outerRect () const

QMargins	margins () const

QMargins	minimumMargins () const

QCP::MarginSides	autoMargins () const

QSize	minimumSize () const

QSize	maximumSize () const

QCPMarginGroup *	marginGroup (QCP::MarginSide side) const

QHash< QCP::MarginSide, QCPMarginGroup * >	marginGroups () const

void	setOuterRect (const QRect &rect)

void	setMargins (const QMargins &margins)

void	setMinimumMargins (const QMargins &margins)

void	setAutoMargins (QCP::MarginSides sides)

void	setMinimumSize (const QSize &size)

void	setMinimumSize (int width, int height)

void	setMaximumSize (const QSize &size)

void	setMaximumSize (int width, int height)

void	setMarginGroup (QCP::MarginSides sides, QCPMarginGroup *group)

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const

Public Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=0)

bool	visible () const

QCustomPlot *	parentPlot () const

QCPLayerable *	parentLayerable () const

QCPLayer *	layer () const

bool	antialiased () const

void	setVisible (bool on)

Q_SLOT bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setAntialiased (bool enabled)

bool	realVisibility () const

Protected Functions
void	getMinimumRowColSizes (QVector< int > minColWidths, QVector< int > minRowHeights) const

void	getMaximumRowColSizes (QVector< int > maxColWidths, QVector< int > maxRowHeights) const

Protected Functions inherited from QCPLayout
void	sizeConstraintsChanged () const

void	adoptElement (QCPLayoutElement *el)

void	releaseElement (QCPLayoutElement *el)

QVector< int >	getSectionSizes (QVector< int > maxSizes, QVector< int > minSizes, QVector< double > stretchFactors, int totalSize) const

Protected Functions inherited from QCPLayoutElement
virtual int	calculateAutoMargin (QCP::MarginSide side)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	wheelEvent (QWheelEvent *event)

virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const

virtual void	draw (QCPPainter *painter)

virtual void	parentPlotInitialized (QCustomPlot *parentPlot)

Protected Functions inherited from QCPLayerable
virtual QCP::Interaction	selectionCategory () const

virtual QRect	clipRect () const

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged)

virtual void	deselectEvent (bool *selectionStateChanged)

void	initializeParentPlot (QCustomPlot *parentPlot)

void	setParentLayerable (QCPLayerable *parentLayerable)

bool	moveToLayer (QCPLayer *layer, bool prepend)

void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

Additional Inherited Members
Public Types inherited from QCPLayoutElement
enum	UpdatePhase

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

Detailed Description

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.

Row and column insertion can be performed with insertRow and insertColumn.

Constructor & Destructor Documentation

QCPLayoutGrid::QCPLayoutGrid ( )

explicit

Creates an instance of QCPLayoutGrid and sets default values.

Member Function Documentation

int QCPLayoutGrid::rowCount ( ) const

Returns the number of rows in the layout.

See Also: columnCount

int QCPLayoutGrid::columnCount ( ) const

Returns the number of columns in the layout.

See Also: rowCount

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 (QCPLayoutElement::setMinimumSize, QCPLayoutElement::setMaximumSize), regardless of the stretch factor.

The default stretch factor of newly created rows/columns is 1.

See Also: setColumnStretchFactors, setRowStretchFactor

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 (QCPLayoutElement::setMinimumSize, QCPLayoutElement::setMaximumSize), regardless of the stretch factor.

The default stretch factor of newly created rows/columns is 1.

See Also: setColumnStretchFactor, setRowStretchFactors

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 (QCPLayoutElement::setMinimumSize, QCPLayoutElement::setMaximumSize), regardless of the stretch factor.

The default stretch factor of newly created rows/columns is 1.

See Also: setColumnStretchFactors, setRowStretchFactor

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 (QCPLayoutElement::setMinimumSize, QCPLayoutElement::setMaximumSize), regardless of the stretch factor.

The default stretch factor of newly created rows/columns is 1.

See Also: setRowStretchFactor, setColumnStretchFactors

void QCPLayoutGrid::setColumnSpacing ( int pixels )

Sets the gap that is left blank between columns to pixels.

See Also: setRowSpacing

void QCPLayoutGrid::setRowSpacing ( int pixels )

Sets the gap that is left blank between rows to pixels.

See Also: setColumnSpacing

void QCPLayoutGrid::updateLayout ( )

virtual

Subclasses reimplement this method to update the position and sizes of the child elements/cells via calling their QCPLayoutElement::setOuterRect. The default implementation does nothing.

The geometry used as a reference is the inner rect of this layout. Child elements should stay within that rect.

getSectionSizes may help with the reimplementation of this function.

See Also: update

Reimplemented from QCPLayout.

int QCPLayoutGrid::elementCount ( ) const

virtual

Returns the number of elements/cells in the layout.

See Also: elements, elementAt

Implements QCPLayout.

QCPLayoutElement * QCPLayoutGrid::elementAt ( int index ) const

virtual

Returns the element in the cell with the given index. If index is invalid, returns 0.

Note that even if index is valid, the respective cell may be empty in some layouts (e.g. QCPLayoutGrid), so this function may return 0 in those cases. You may use this function to check whether a cell is empty or not.

See Also: elements, elementCount, takeAt

Implements QCPLayout.

QCPLayoutElement * QCPLayoutGrid::takeAt ( int index )

virtual

Removes the element with the given index from the layout and returns it.

If the index is invalid or the cell with that index is empty, returns 0.

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.

See Also: elementAt, take

Implements QCPLayout.

bool QCPLayoutGrid::take ( QCPLayoutElement * element )

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.

See Also: takeAt

Implements QCPLayout.

QList< QCPLayoutElement * > QCPLayoutGrid::elements ( bool recursive ) const

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.

Warning: There may be entries with value 0 in the returned list. (For example, QCPLayoutGrid may have empty cells which yield 0 at the respective index.)

Reimplemented from QCPLayout.

void QCPLayoutGrid::simplify ( )

virtual

Simplifies the layout by collapsing rows and columns which only contain empty cells.

Reimplemented from QCPLayout.

QSize QCPLayoutGrid::minimumSizeHint ( ) const

virtual

Returns the minimum size this layout element (the inner rect) may be compressed to.

if a minimum size (setMinimumSize) was not set manually, parent layouts consult this function to determine the minimum allowed size of this layout element. (A manual minimum size is considered set if it is non-zero.)

Reimplemented from QCPLayoutElement.

QSize QCPLayoutGrid::maximumSizeHint ( ) const

virtual

Returns the maximum size this layout element (the inner rect) may be expanded to.

if a maximum size (setMaximumSize) was not set manually, parent layouts consult this function 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.)

Reimplemented from QCPLayoutElement.

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.

See Also: addElement, hasElement

bool QCPLayoutGrid::addElement	(	int	row,
		int	column,
		QCPLayoutElement *	element
	)

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.

See Also: element, hasElement, take, remove

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.

See Also: element

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.

See Also: simplify

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

See Also: insertColumn

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 row at the left) to rowCount (appends a row at the right).

See Also: insertRow

void QCPLayoutGrid::getMinimumRowColSizes	(	QVector< int > *	minColWidths,
		QVector< int > *	minRowHeights
	)		const

protected

Places the minimum column widths and row heights into minColWidths and minRowHeights respectively.

The minimum height of a row is the largest minimum height of any element in that row. The minimum width of a column is the largest minimum width of any element in that column.

This is a helper function for updateLayout.

See Also: getMaximumRowColSizes

void QCPLayoutGrid::getMaximumRowColSizes	(	QVector< int > *	maxColWidths,
		QVector< int > *	maxRowHeights
	)		const

protected

Places the maximum column widths and row heights into maxColWidths and maxRowHeights respectively.

The maximum height of a row is the smallest maximum height of any element in that row. The maximum width of a column is the smallest maximum width of any element in that column.

This is a helper function for updateLayout.

See Also: getMinimumRowColSizes

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

src/layout.h
src/layout.cpp

Public Functions

Protected Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation