A layout element displaying a plot title text. More...

#include <qcustomplot.h>

Inheritance diagram for QCPPlotTitle:

Signals
void	selectionChanged (bool selected)
	This signal is emitted when the selection state has changed to selected, either by user interaction or by a direct call to setSelected. More...

void	selectableChanged (bool selectable)

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)
	This signal is emitted when the layer of this layerable changes, i.e. More...

Public Member Functions
	QCPPlotTitle (QCustomPlot *parentPlot)
	Creates a new QCPPlotTitle instance and sets default values. More...

	QCPPlotTitle (QCustomPlot *parentPlot, const QString &text)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Creates a new QCPPlotTitle instance and sets default values. More...

QString	text () const

QFont	font () const

QColor	textColor () const

QFont	selectedFont () const

QColor	selectedTextColor () const

bool	selectable () const

bool	selected () const

void	setText (const QString &text)
	Sets the text that will be displayed to text. More...

void	setFont (const QFont &font)
	Sets the font of the title text. More...

void	setTextColor (const QColor &color)
	Sets the color of the title text. More...

void	setSelectedFont (const QFont &font)
	Sets the font of the title text that will be used if the plot title is selected (setSelected). More...

void	setSelectedTextColor (const QColor &color)
	Sets the color of the title text that will be used if the plot title is selected (setSelected). More...

Q_SLOT void	setSelectable (bool selectable)
	Sets whether the user may select this plot title to selectable. More...

Q_SLOT void	setSelected (bool selected)
	Sets the selection state of this plot title to selected. More...

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
	Layout elements are sensitive to events inside their outer rect. More...

Public Member Functions inherited from QCPLayoutElement
	QCPLayoutElement (QCustomPlot *parentPlot=0)
	Creates an instance of QCPLayoutElement and sets default values. More...

virtual	~QCPLayoutElement ()

QCPLayout *	layout () const
	Returns the parent layout of this layout element. More...

QRect	rect () const
	Returns the inner rect of this layout element. More...

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)
	Sets the outer rect of this layout element. More...

void	setMargins (const QMargins &margins)
	Sets the margins of this layout element. More...

void	setMinimumMargins (const QMargins &margins)
	If setAutoMargins is enabled on some or all margins, this function is used to provide minimum values for those margins. More...

void	setAutoMargins (QCP::MarginSides sides)
	Sets on which sides the margin shall be calculated automatically. More...

void	setMinimumSize (const QSize &size)
	Sets the minimum size for the inner rect of this layout element. More...

void	setMinimumSize (int width, int height)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the minimum size for the inner rect of this layout element. More...

void	setMaximumSize (const QSize &size)
	Sets the maximum size for the inner rect of this layout element. More...

void	setMaximumSize (int width, int height)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the maximum size for the inner rect of this layout element. More...

void	setMarginGroup (QCP::MarginSides sides, QCPMarginGroup *group)
	Sets the margin group of the specified margin sides. More...

virtual void	update (UpdatePhase phase)
	Updates the layout element and sub-elements. More...

virtual QList< QCPLayoutElement * >	elements (bool recursive) const
	Returns a list of all child elements in this layout element. More...

Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot plot, QString targetLayer="", QCPLayerable parentLayerable=0)
	Creates a new QCPLayerable instance. More...

	~QCPLayerable ()

bool	visible () const

QCustomPlot *	parentPlot () const

QCPLayerable *	parentLayerable () const
	Returns the parent layerable of this layerable. More...

QCPLayer *	layer () const

bool	antialiased () const

void	setVisible (bool on)
	Sets the visibility of this layerable object. More...

Q_SLOT bool	setLayer (QCPLayer *layer)
	Sets the layer of this layerable object. More...

bool	setLayer (const QString &layerName)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets the layer of this layerable object by name. More...

void	setAntialiased (bool enabled)
	Sets whether this object will be drawn antialiased or not. More...

bool	realVisibility () const
	Returns whether this layerable is visible, taking the visibility of the layerable parent and the visibility of the layer this layerable is on into account. More...

Protected Member Functions
virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const

virtual void	draw (QCPPainter *painter)

virtual QSize	minimumSizeHint () const
	Returns the minimum size this layout element (the inner rect) may be compressed to. More...

virtual QSize	maximumSizeHint () const
	Returns the maximum size this layout element (the inner rect) may be expanded to. More...

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

virtual void	deselectEvent (bool *selectionStateChanged)

QFont	mainFont () const

QColor	mainTextColor () const

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

virtual void	mousePressEvent (QMouseEvent *event)
	This event is called, if the mouse was pressed while being inside the outer rect of this layout element. More...

virtual void	mouseMoveEvent (QMouseEvent *event)
	This event is called, if the mouse is moved inside the outer rect of this layout element. More...

virtual void	mouseReleaseEvent (QMouseEvent *event)
	This event is called, if the mouse was previously pressed inside the outer rect of this layout element and is now released. More...

virtual void	mouseDoubleClickEvent (QMouseEvent *event)
	This event is called, if the mouse is double-clicked inside the outer rect of this layout element. More...

virtual void	wheelEvent (QWheelEvent *event)
	This event is called, if the mouse wheel is scrolled while the cursor is inside the rect of this layout element. More...

virtual void	parentPlotInitialized (QCustomPlot *parentPlot)

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

virtual QRect	clipRect () const

void	initializeParentPlot (QCustomPlot *parentPlot)

void	setParentLayerable (QCPLayerable *parentLayerable)

bool	moveToLayer (QCPLayer *layer, bool prepend)

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

Protected Attributes
QString	mText

QFont	mFont

QColor	mTextColor

QFont	mSelectedFont

QColor	mSelectedTextColor

QRect	mTextBoundingRect

bool	mSelectable

bool	mSelected

Protected Attributes inherited from QCPLayoutElement
QCPLayout *	mParentLayout

QSize	mMinimumSize

QSize	mMaximumSize

QRect	mRect

QRect	mOuterRect

QMargins	mMargins

QMargins	mMinimumMargins

QCP::MarginSides	mAutoMargins

QHash< QCP::MarginSide, QCPMarginGroup * >	mMarginGroups

Protected Attributes inherited from QCPLayerable
bool	mVisible

QCustomPlot *	mParentPlot

QPointer< QCPLayerable >	mParentLayerable

QCPLayer *	mLayer

bool	mAntialiased

Additional Inherited Members
Public Types inherited from QCPLayoutElement
enum	UpdatePhase { upPreparation , upMargins , upLayout }
	Defines the phases of the update process, that happens just before a replot. More...

Detailed Description

A layout element displaying a plot title text.

The text may be specified with setText, theformatting can be controlled with setFont and setTextColor.

A plot title can be added as follows:

customPlot->plotLayout()->insertRow(0); // inserts an empty row above the default axis rect

customPlot->plotLayout()->addElement(0, 0, new QCPPlotTitle(customPlot, "Your Plot Title"));

QCPPlotTitle::QCPPlotTitle

QCPPlotTitle(QCustomPlot *parentPlot)

Creates a new QCPPlotTitle instance and sets default values.

Definition: qcustomplot.cpp:13527

Since a plot title is a common requirement, QCustomPlot offers specialized selection signals for easy interaction with QCPPlotTitle. If a layout element of type QCPPlotTitle is clicked, the signal QCustomPlot::titleClick is emitted. A double click emits the QCustomPlot::titleDoubleClick signal.

Definition at line 2269 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPPlotTitle() [1/2]

QCPPlotTitle::QCPPlotTitle ( QCustomPlot * parentPlot )

explicit

Creates a new QCPPlotTitle instance and sets default values.

The initial text is empty (setText).

To set the title text in the constructor, rather use QCPPlotTitle(QCustomPlot *parentPlot, const QString &text).

Definition at line 13527 of file qcustomplot.cpp.

◆ QCPPlotTitle() [2/2]

QCPPlotTitle::QCPPlotTitle	(	QCustomPlot *	parentPlot,
		const QString &	text
	)

explicit

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Creates a new QCPPlotTitle instance and sets default values.

The initial text is set to text.

Definition at line 13549 of file qcustomplot.cpp.

Member Function Documentation

◆ applyDefaultAntialiasingHint()

void QCPPlotTitle::applyDefaultAntialiasingHint ( QCPPainter * painter ) const

protectedvirtual

Reimplemented from QCPLayoutElement.

Definition at line 13645 of file qcustomplot.cpp.

◆ deselectEvent()

void QCPPlotTitle::deselectEvent ( bool * selectionStateChanged )

protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 13693 of file qcustomplot.cpp.

◆ draw()

void QCPPlotTitle::draw ( QCPPainter * painter )

protectedvirtual

Reimplemented from QCPLayoutElement.

Definition at line 13651 of file qcustomplot.cpp.

◆ font()

QFont QCPPlotTitle::font ( ) const

inline

Definition at line 2287 of file qcustomplot.h.

◆ mainFont()

QFont QCPPlotTitle::mainFont ( ) const

protected

Definition at line 13722 of file qcustomplot.cpp.

◆ mainTextColor()

QColor QCPPlotTitle::mainTextColor ( ) const

protected

Definition at line 13732 of file qcustomplot.cpp.

◆ maximumSizeHint()

QSize QCPPlotTitle::maximumSizeHint ( ) const

protectedvirtual

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.

Definition at line 13669 of file qcustomplot.cpp.

◆ minimumSizeHint()

QSize QCPPlotTitle::minimumSizeHint ( ) const

protectedvirtual

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.

Definition at line 13659 of file qcustomplot.cpp.

◆ selectable()

bool QCPPlotTitle::selectable ( ) const

inline

Definition at line 2291 of file qcustomplot.h.

◆ selectableChanged

void QCPPlotTitle::selectableChanged ( bool selectable )

signal

◆ selected()

bool QCPPlotTitle::selected ( ) const

inline

Definition at line 2292 of file qcustomplot.h.

◆ selectedFont()

QFont QCPPlotTitle::selectedFont ( ) const

inline

Definition at line 2289 of file qcustomplot.h.

◆ selectedTextColor()

QColor QCPPlotTitle::selectedTextColor ( ) const

inline

Definition at line 2290 of file qcustomplot.h.

◆ selectEvent()

void QCPPlotTitle::selectEvent	(	QMouseEvent *	event,
		bool	additive,
		const QVariant &	details,
		bool *	selectionStateChanged
	)

protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 13679 of file qcustomplot.cpp.

◆ selectionChanged

void QCPPlotTitle::selectionChanged ( bool selected )

signal

This signal is emitted when the selection state has changed to selected, either by user interaction or by a direct call to setSelected.

See also: setSelected, setSelectable

◆ selectTest()

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

virtual

Layout elements are sensitive to events inside their outer rect.

If pos is within the outer rect, this method returns a value corresponding to 0.99 times the parent plot's selection tolerance. However, layout elements are not selectable by default. So if onlySelectable is true, -1.0 is returned.

See QCPLayerable::selectTest for a general explanation of this virtual method.

QCPLayoutElement subclasses may reimplement this method to provide more specific selection test behaviour.

Reimplemented from QCPLayoutElement.

Definition at line 13705 of file qcustomplot.cpp.

◆ setFont()

void QCPPlotTitle::setFont ( const QFont & font )

Sets the font of the title text.

See also: setTextColor, setSelectedFont

Definition at line 13578 of file qcustomplot.cpp.

◆ setSelectable()

void QCPPlotTitle::setSelectable ( bool selectable )

Sets whether the user may select this plot title to selectable.

Note that even when selectable is set to false, the selection state may be changed programmatically via setSelected.

Definition at line 13619 of file qcustomplot.cpp.

◆ setSelected()

void QCPPlotTitle::setSelected ( bool selected )

Sets the selection state of this plot title to selected.

If the selection has changed, selectionChanged is emitted.

Note that this function can change the selection state independently of the current setSelectable state.

Definition at line 13635 of file qcustomplot.cpp.

◆ setSelectedFont()

void QCPPlotTitle::setSelectedFont ( const QFont & font )

Sets the font of the title text that will be used if the plot title is selected (setSelected).

See also: setFont

Definition at line 13598 of file qcustomplot.cpp.

◆ setSelectedTextColor()

void QCPPlotTitle::setSelectedTextColor ( const QColor & color )

Sets the color of the title text that will be used if the plot title is selected (setSelected).

See also: setTextColor

Definition at line 13608 of file qcustomplot.cpp.

◆ setText()

void QCPPlotTitle::setText ( const QString & text )

Sets the text that will be displayed to text.

Multiple lines can be created by insertion of "\n".

See also: setFont, setTextColor

Definition at line 13568 of file qcustomplot.cpp.

◆ setTextColor()

void QCPPlotTitle::setTextColor ( const QColor & color )

Sets the color of the title text.

See also: setFont, setSelectedTextColor

Definition at line 13588 of file qcustomplot.cpp.

◆ text()

QString QCPPlotTitle::text ( ) const

inline

Definition at line 2286 of file qcustomplot.h.

◆ textColor()

QColor QCPPlotTitle::textColor ( ) const

inline

Definition at line 2288 of file qcustomplot.h.

Member Data Documentation

◆ mFont

QFont QCPPlotTitle::mFont

protected

Definition at line 2313 of file qcustomplot.h.

◆ mSelectable

bool QCPPlotTitle::mSelectable

protected

Definition at line 2318 of file qcustomplot.h.

◆ mSelected

bool QCPPlotTitle::mSelected

protected

Definition at line 2318 of file qcustomplot.h.

◆ mSelectedFont

QFont QCPPlotTitle::mSelectedFont

protected

Definition at line 2315 of file qcustomplot.h.

◆ mSelectedTextColor

QColor QCPPlotTitle::mSelectedTextColor

protected

Definition at line 2316 of file qcustomplot.h.

◆ mText

QString QCPPlotTitle::mText

protected

Definition at line 2312 of file qcustomplot.h.

◆ mTextBoundingRect

QRect QCPPlotTitle::mTextBoundingRect

protected

Definition at line 2317 of file qcustomplot.h.

◆ mTextColor

QColor QCPPlotTitle::mTextColor

protected

Definition at line 2314 of file qcustomplot.h.

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

icub-main/src/tools/skinManagerGui/qcustomplot.h
icub-main/src/tools/skinManagerGui/qcustomplot.cpp

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QCPPlotTitle() [1/2]

◆ QCPPlotTitle() [2/2]

Member Function Documentation

◆ applyDefaultAntialiasingHint()

◆ deselectEvent()

◆ draw()

◆ font()

◆ mainFont()

◆ mainTextColor()

◆ maximumSizeHint()

◆ minimumSizeHint()

◆ selectable()

◆ selectableChanged

◆ selected()

◆ selectedFont()

◆ selectedTextColor()

◆ selectEvent()

◆ selectionChanged

◆ selectTest()

◆ setFont()

◆ setSelectable()

◆ setSelected()

◆ setSelectedFont()

◆ setSelectedTextColor()

◆ setText()

◆ setTextColor()

◆ text()

◆ textColor()

Member Data Documentation

◆ mFont

◆ mSelectable

◆ mSelected

◆ mSelectedFont

◆ mSelectedTextColor

◆ mText

◆ mTextBoundingRect

◆ mTextColor