QwtMagnifier provides zooming by magnifying in steps. More...

#include <qwt_magnifier.h>

Inheritance diagram for QwtMagnifier:

Classes
class	PrivateData

Public Member Functions
	QwtMagnifier (QWidget *)
	Constructor.

QWidget *	parentWidget ()
	Return the parent widget where the rescaling happens.

const QWidget *	parentWidget () const
	Return the parent widget where the rescaling happens.

void	setEnabled (bool)
	En/disable the magnifier.

bool	isEnabled () const
	Return whether the magnifier is enabled.

void	setMouseFactor (double)
	Change the mouse factor.

double	mouseFactor () const
	Return the mouse factor.

void	setMouseButton (Qt::MouseButton, Qt::KeyboardModifiers=Qt::NoModifier)
	Assign the mouse button that is used for zooming in/out.

void	getMouseButton (Qt::MouseButton &, Qt::KeyboardModifiers &) const
	Get the mouse button and modifiers used for zooming.

void	setWheelFactor (double)
	Change the wheel factor.

double	wheelFactor () const
	Return the wheel factor.

void	setWheelModifiers (Qt::KeyboardModifiers)
	Assign keyboard modifiers for zooming in/out using the wheel.

Qt::KeyboardModifiers	wheelModifiers () const
	Return the wheel modifiers.

void	setKeyFactor (double)
	Change the key factor.

double	keyFactor () const
	Return the key factor.

void	setZoomInKey (int key, Qt::KeyboardModifiers=Qt::NoModifier)
	Assign the key that is used for zooming in.

void	getZoomInKey (int &key, Qt::KeyboardModifiers &) const
	Retrieve the settings of the zoom in key.

void	setZoomOutKey (int key, Qt::KeyboardModifiers=Qt::NoModifier)
	Assign the key that is used for zooming out.

void	getZoomOutKey (int &key, Qt::KeyboardModifiers &) const
	Retrieve the settings of the zoom out key.

virtual bool	eventFilter (QObject , QEvent ) override
	Event filter.

Protected Member Functions
virtual void	rescale (double factor)=0

virtual void	widgetMousePressEvent (QMouseEvent *)
	Handle a mouse press event for the observed widget.

virtual void	widgetMouseReleaseEvent (QMouseEvent *)
	Handle a mouse release event for the observed widget.

virtual void	widgetMouseMoveEvent (QMouseEvent *)
	Handle a mouse move event for the observed widget.

virtual void	widgetWheelEvent (QWheelEvent *)
	Handle a wheel event for the observed widget.

virtual void	widgetKeyPressEvent (QKeyEvent *)
	Handle a key press event for the observed widget.

virtual void	widgetKeyReleaseEvent (QKeyEvent *)
	Handle a key release event for the observed widget.

Detailed Description

QwtMagnifier provides zooming by magnifying in steps.

Using QwtMagnifier a plot can be zoomed in/out in steps using keys, the mouse wheel or moving a mouse button in vertical direction.

Constructor & Destructor Documentation

◆ QwtMagnifier()

QwtMagnifier::QwtMagnifier ( QWidget * parent )

explicit

Constructor.

Parameters

[in] parent Widget to be magnified

Destructor

Member Function Documentation

◆ eventFilter()

bool QwtMagnifier::eventFilter	(	QObject *	object,
		QEvent *	event
	)

overridevirtual

Event filter.

When isEnabled() is true, the mouse events of the observed widget are filtered.

Parameters

[in]	object	Object to be filtered
[in]	event	Event

Returns: Forwarded to QObject::eventFilter()

See also: widgetMousePressEvent(), widgetMouseReleaseEvent(), widgetMouseMoveEvent(), widgetWheelEvent(), widgetKeyPressEvent(), widgetKeyReleaseEvent()

◆ getMouseButton()

void QwtMagnifier::getMouseButton	(	Qt::MouseButton &	button,
		Qt::KeyboardModifiers &	modifiers
	)		const

Get the mouse button and modifiers used for zooming.

Parameters

[out]	button	Mouse button used for zooming
[out]	modifiers	Keyboard modifiers used for zooming

See also: setMouseButton()

◆ getZoomInKey()

void QwtMagnifier::getZoomInKey	(	int &	key,
		Qt::KeyboardModifiers &	modifiers
	)		const

Retrieve the settings of the zoom in key.

Parameters

[out]	key	Key code, see Qt::Key
[out]	modifiers	Keyboard modifiers

See also: setZoomInKey()

◆ getZoomOutKey()

void QwtMagnifier::getZoomOutKey	(	int &	key,
		Qt::KeyboardModifiers &	modifiers
	)		const

Retrieve the settings of the zoom out key.

Parameters

[out]	key	Key code, see Qt::Key
[out]	modifiers	Keyboard modifiers

See also: setZoomOutKey()

◆ isEnabled()

bool QwtMagnifier::isEnabled ( ) const

Return whether the magnifier is enabled.

Returns: true when enabled, false otherwise

See also: setEnabled(), eventFilter()

◆ keyFactor()

double QwtMagnifier::keyFactor ( ) const

Return the key factor.

Returns: Key factor

See also: setKeyFactor()

◆ mouseFactor()

double QwtMagnifier::mouseFactor ( ) const

Return the mouse factor.

Returns: Mouse factor

See also: setMouseFactor()

◆ parentWidget() [1/2]

QWidget * QwtMagnifier::parentWidget ( )

Return the parent widget where the rescaling happens.

Returns: Parent widget

◆ parentWidget() [2/2]

const QWidget * QwtMagnifier::parentWidget ( ) const

Return the parent widget where the rescaling happens.

Returns: Parent widget (const)

◆ setEnabled()

void QwtMagnifier::setEnabled ( bool on )

En/disable the magnifier.

When enabled is true an event filter is installed for the observed widget, otherwise the event filter is removed.

Parameters

[in] on true or false

See also: isEnabled(), eventFilter()

◆ setKeyFactor()

void QwtMagnifier::setKeyFactor ( double factor )

Change the key factor.

The key factor defines the ratio between the current range on the parent widget and the zoomed range for each key press of the zoom in/out keys. The default value is 0.9.

Parameters

[in] factor Key factor

See also: keyFactor(), setZoomInKey(), setZoomOutKey(), setWheelFactor(), setMouseFactor()

◆ setMouseButton()

void QwtMagnifier::setMouseButton	(	Qt::MouseButton	button,
		Qt::KeyboardModifiers	modifiers = `Qt::NoModifier`
	)

Assign the mouse button that is used for zooming in/out.

The default value is Qt::RightButton.

Parameters

[in]	button	Button
[in]	modifiers	Keyboard modifiers

See also: getMouseButton()

◆ setMouseFactor()

void QwtMagnifier::setMouseFactor ( double factor )

Change the mouse factor.

The mouse factor defines the ratio between the current range on the parent widget and the zoomed range for each vertical mouse movement. The default value is 0.95.

Parameters

[in] factor Mouse factor

See also: mouseFactor(), setMouseButton(), setWheelFactor(), setKeyFactor()

◆ setWheelFactor()

void QwtMagnifier::setWheelFactor ( double factor )

Change the wheel factor.

The wheel factor defines the ratio between the current range on the parent widget and the zoomed range for each step of the wheel. Use values > 1 for magnification (i.e. 2.0) and values < 1 for scaling down (i.e. 1/2.0 = 0.5). You can use this feature for inverting the direction of the wheel. The default value is 0.9.

Parameters

[in] factor Wheel factor

See also: wheelFactor(), setWheelButtonState(), setMouseFactor(), setKeyFactor()

◆ setWheelModifiers()

void QwtMagnifier::setWheelModifiers ( Qt::KeyboardModifiers modifiers )

Assign keyboard modifiers for zooming in/out using the wheel.

The default modifiers are Qt::NoModifiers.

Parameters

[in] modifiers Keyboard modifiers

See also: wheelModifiers()

◆ setZoomInKey()

void QwtMagnifier::setZoomInKey	(	int	key,
		Qt::KeyboardModifiers	modifiers = `Qt::NoModifier`
	)

Assign the key that is used for zooming in.

The default combination is Qt::Key_Plus + Qt::NoModifier.

Parameters

[in]	key	Key code
[in]	modifiers	Keyboard modifiers

See also: getZoomInKey(), setZoomOutKey()

◆ setZoomOutKey()

void QwtMagnifier::setZoomOutKey	(	int	key,
		Qt::KeyboardModifiers	modifiers = `Qt::NoModifier`
	)

Assign the key that is used for zooming out.

The default combination is Qt::Key_Minus + Qt::NoModifier.

Parameters

[in]	key	Key code
[in]	modifiers	Keyboard modifiers

See also: getZoomOutKey(), setZoomInKey()

◆ wheelFactor()

double QwtMagnifier::wheelFactor ( ) const

Return the wheel factor.

Returns: Wheel factor

See also: setWheelFactor()

◆ wheelModifiers()

Qt::KeyboardModifiers QwtMagnifier::wheelModifiers ( ) const

Return the wheel modifiers.

Returns: Wheel modifiers

See also: setWheelModifiers()

◆ widgetKeyPressEvent()

void QwtMagnifier::widgetKeyPressEvent ( QKeyEvent * keyEvent )

protectedvirtual

Handle a key press event for the observed widget.

Parameters

keyEvent Key event

See also: eventFilter(), widgetKeyReleaseEvent()

Reimplemented in QwtPolarMagnifier.

◆ widgetKeyReleaseEvent()

void QwtMagnifier::widgetKeyReleaseEvent ( QKeyEvent * keyEvent )

protectedvirtual

Handle a key release event for the observed widget.

Parameters

keyEvent Key event

See also: eventFilter(), widgetKeyReleaseEvent()

◆ widgetMouseMoveEvent()

void QwtMagnifier::widgetMouseMoveEvent ( QMouseEvent * mouseEvent )

protectedvirtual

Handle a mouse move event for the observed widget.

Parameters

mouseEvent Mouse event

See also: eventFilter(), widgetMousePressEvent(), widgetMouseReleaseEvent(),

◆ widgetMousePressEvent()

void QwtMagnifier::widgetMousePressEvent ( QMouseEvent * mouseEvent )

protectedvirtual

Handle a mouse press event for the observed widget.

Parameters

mouseEvent Mouse event

See also: eventFilter(), widgetMouseReleaseEvent(), widgetMouseMoveEvent()

◆ widgetMouseReleaseEvent()

void QwtMagnifier::widgetMouseReleaseEvent ( QMouseEvent * mouseEvent )

protectedvirtual

Handle a mouse release event for the observed widget.

Parameters

mouseEvent Mouse event

See also: eventFilter(), widgetMousePressEvent(), widgetMouseMoveEvent(),

◆ widgetWheelEvent()

void QwtMagnifier::widgetWheelEvent ( QWheelEvent * wheelEvent )

protectedvirtual

Handle a wheel event for the observed widget.

Parameters

wheelEvent Wheel event

See also: eventFilter()

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

/home/runner/work/QWT/QWT/src/plot/qwt_magnifier.h
/home/runner/work/QWT/QWT/src/plot/qwt_magnifier.cpp

Classes

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QwtMagnifier()

Member Function Documentation

◆ eventFilter()

◆ getMouseButton()

◆ getZoomInKey()

◆ getZoomOutKey()

◆ isEnabled()

◆ keyFactor()

◆ mouseFactor()

◆ parentWidget() [1/2]

◆ parentWidget() [2/2]

◆ setEnabled()

◆ setKeyFactor()

◆ setMouseButton()

◆ setMouseFactor()

◆ setWheelFactor()

◆ setWheelModifiers()

◆ setZoomInKey()

◆ setZoomOutKey()

◆ wheelFactor()

◆ wheelModifiers()

◆ widgetKeyPressEvent()

◆ widgetKeyReleaseEvent()

◆ widgetMouseMoveEvent()

◆ widgetMousePressEvent()

◆ widgetMouseReleaseEvent()

◆ widgetWheelEvent()