Peter M. Groen / openbr

.TH "QwtMagnifier" 3 "Sat Jan 26 2013" "Version 6.1-rc3" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtMagnifier \- 
.PP
\fBQwtMagnifier\fP provides zooming, by magnifying in steps\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_magnifier\&.h>\fP
.PP
Inherits QObject\&.
.PP
Inherited by \fBQwtPlotMagnifier\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtMagnifier\fP (QWidget *)"
.br
.ti -1c
.RI "virtual \fB~QwtMagnifier\fP ()"
.br
.RI "\fIDestructor\&. \fP"
.ti -1c
.RI "QWidget * \fBparentWidget\fP ()"
.br
.ti -1c
.RI "const QWidget * \fBparentWidget\fP () const "
.br
.ti -1c
.RI "void \fBsetEnabled\fP (bool)"
.br
.RI "\fIEn/disable the magnifier\&. \fP"
.ti -1c
.RI "bool \fBisEnabled\fP () const "
.br
.ti -1c
.RI "void \fBsetMouseFactor\fP (double)"
.br
.RI "\fIChange the mouse factor\&. \fP"
.ti -1c
.RI "double \fBmouseFactor\fP () const "
.br
.ti -1c
.RI "void \fBsetMouseButton\fP (Qt::MouseButton, Qt::KeyboardModifiers=Qt::NoModifier)"
.br
.ti -1c
.RI "void \fBgetMouseButton\fP (Qt::MouseButton &, Qt::KeyboardModifiers &) const "
.br
.ti -1c
.RI "void \fBsetWheelFactor\fP (double)"
.br
.RI "\fIChange the wheel factor\&. \fP"
.ti -1c
.RI "double \fBwheelFactor\fP () const "
.br
.ti -1c
.RI "void \fBsetWheelModifiers\fP (Qt::KeyboardModifiers)"
.br
.ti -1c
.RI "Qt::KeyboardModifiers \fBwheelModifiers\fP () const "
.br
.ti -1c
.RI "void \fBsetKeyFactor\fP (double)"
.br
.RI "\fIChange the key factor\&. \fP"
.ti -1c
.RI "double \fBkeyFactor\fP () const "
.br
.ti -1c
.RI "void \fBsetZoomInKey\fP (int key, Qt::KeyboardModifiers=Qt::NoModifier)"
.br
.ti -1c
.RI "void \fBgetZoomInKey\fP (int &key, Qt::KeyboardModifiers &) const "
.br
.ti -1c
.RI "void \fBsetZoomOutKey\fP (int key, Qt::KeyboardModifiers=Qt::NoModifier)"
.br
.ti -1c
.RI "void \fBgetZoomOutKey\fP (int &key, Qt::KeyboardModifiers &) const "
.br
.ti -1c
.RI "virtual bool \fBeventFilter\fP (QObject *, QEvent *)"
.br
.RI "\fIEvent filter\&. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBrescale\fP (double factor)=0"
.br
.ti -1c
.RI "virtual void \fBwidgetMousePressEvent\fP (QMouseEvent *)"
.br
.ti -1c
.RI "virtual void \fBwidgetMouseReleaseEvent\fP (QMouseEvent *)"
.br
.ti -1c
.RI "virtual void \fBwidgetMouseMoveEvent\fP (QMouseEvent *)"
.br
.ti -1c
.RI "virtual void \fBwidgetWheelEvent\fP (QWheelEvent *)"
.br
.ti -1c
.RI "virtual void \fBwidgetKeyPressEvent\fP (QKeyEvent *)"
.br
.ti -1c
.RI "virtual void \fBwidgetKeyReleaseEvent\fP (QKeyEvent *)"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBQwtMagnifier\fP provides zooming, by magnifying in steps\&. 

Using \fBQwtMagnifier\fP a plot can be zoomed in/out in steps using keys, the mouse wheel or moving a mouse button in vertical direction\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "QwtMagnifier::QwtMagnifier (QWidget *parent)\fC [explicit]\fP"
Constructor 
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP Widget to be magnified 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "bool QwtMagnifier::eventFilter (QObject *object, QEvent *event)\fC [virtual]\fP"

.PP
Event filter\&. When \fBisEnabled()\fP is true, the mouse events of the observed widget are filtered\&.
.PP
\fBParameters:\fP
.RS 4
\fIobject\fP Object to be filtered 
.br
\fIevent\fP Event
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBwidgetMousePressEvent()\fP, \fBwidgetMouseReleaseEvent()\fP, \fBwidgetMouseMoveEvent()\fP, \fBwidgetWheelEvent()\fP, \fBwidgetKeyPressEvent()\fP \fBwidgetKeyReleaseEvent()\fP 
.RE
.PP

.SS "void QwtMagnifier::getMouseButton (Qt::MouseButton &button, Qt::KeyboardModifiers &modifiers) const"
\fBSee Also:\fP
.RS 4
\fBsetMouseButton()\fP 
.RE
.PP

.SS "void QwtMagnifier::getZoomInKey (int &key, Qt::KeyboardModifiers &modifiers) const"
\fBSee Also:\fP
.RS 4
\fBsetZoomInKey()\fP 
.RE
.PP

.SS "void QwtMagnifier::getZoomOutKey (int &key, Qt::KeyboardModifiers &modifiers) const"
\fBSee Also:\fP
.RS 4
\fBsetZoomOutKey()\fP 
.RE
.PP

.SS "bool QwtMagnifier::isEnabled () const"
\fBReturns:\fP
.RS 4
true when enabled, false otherwise 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetEnabled()\fP, \fBeventFilter()\fP 
.RE
.PP

.SS "double QwtMagnifier::keyFactor () const"
\fBReturns:\fP
.RS 4
Key factor 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetKeyFactor()\fP 
.RE
.PP

.SS "double QwtMagnifier::mouseFactor () const"
\fBReturns:\fP
.RS 4
Mouse factor 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetMouseFactor()\fP 
.RE
.PP

.SS "QWidget * QwtMagnifier::parentWidget ()"
\fBReturns:\fP
.RS 4
Parent widget, where the rescaling happens 
.RE
.PP

.SS "const QWidget * QwtMagnifier::parentWidget () const"
\fBReturns:\fP
.RS 4
Parent widget, where the rescaling happens 
.RE
.PP

.SS "virtual void QwtMagnifier::rescale (doublefactor)\fC [protected]\fP, \fC [pure virtual]\fP"
Rescale the parent widget 
.PP
\fBParameters:\fP
.RS 4
\fIfactor\fP Scale factor 
.RE
.PP

.PP
Implemented in \fBQwtPlotMagnifier\fP\&.
.SS "void QwtMagnifier::setEnabled (boolon)"

.PP
En/disable the magnifier\&. When enabled is true an event filter is installed for the observed widget, otherwise the event filter is removed\&.
.PP
\fBParameters:\fP
.RS 4
\fIon\fP true or false 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBisEnabled()\fP, \fBeventFilter()\fP 
.RE
.PP

.SS "void QwtMagnifier::setKeyFactor (doublefactor)"

.PP
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\&.
.PP
\fBParameters:\fP
.RS 4
\fIfactor\fP Key factor 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBkeyFactor()\fP, \fBsetZoomInKey()\fP, \fBsetZoomOutKey()\fP, \fBsetWheelFactor\fP, \fBsetMouseFactor()\fP 
.RE
.PP

.SS "void QwtMagnifier::setMouseButton (Qt::MouseButtonbutton, Qt::KeyboardModifiersmodifiers = \fCQt::NoModifier\fP)"
Assign the mouse button, that is used for zooming in/out\&. The default value is Qt::RightButton\&.
.PP
\fBParameters:\fP
.RS 4
\fIbutton\fP Button 
.br
\fImodifiers\fP Keyboard modifiers
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBgetMouseButton()\fP 
.RE
.PP

.SS "void QwtMagnifier::setMouseFactor (doublefactor)"

.PP
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\&.
.PP
\fBParameters:\fP
.RS 4
\fIfactor\fP Wheel factor 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBmouseFactor()\fP, \fBsetMouseButton()\fP, \fBsetWheelFactor()\fP, \fBsetKeyFactor()\fP 
.RE
.PP

.SS "void QwtMagnifier::setWheelFactor (doublefactor)"

.PP
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\&.
.PP
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\&.
.PP
The default value is 0\&.9\&.
.PP
\fBParameters:\fP
.RS 4
\fIfactor\fP Wheel factor 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBwheelFactor()\fP, setWheelButtonState(), \fBsetMouseFactor()\fP, \fBsetKeyFactor()\fP 
.RE
.PP

.SS "void QwtMagnifier::setWheelModifiers (Qt::KeyboardModifiersmodifiers)"
Assign keyboard modifiers for zooming in/out using the wheel\&. The default modifiers are Qt::NoModifiers\&.
.PP
\fBParameters:\fP
.RS 4
\fImodifiers\fP Keyboard modifiers 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBwheelModifiers()\fP 
.RE
.PP

.SS "void QwtMagnifier::setZoomInKey (intkey, Qt::KeyboardModifiersmodifiers = \fCQt::NoModifier\fP)"
Assign the key, that is used for zooming in\&. The default combination is Qt::Key_Plus + Qt::NoModifier\&.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP 
.br
\fImodifiers\fP 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBgetZoomInKey()\fP, \fBsetZoomOutKey()\fP 
.RE
.PP

.SS "void QwtMagnifier::setZoomOutKey (intkey, Qt::KeyboardModifiersmodifiers = \fCQt::NoModifier\fP)"
Assign the key, that is used for zooming out\&. The default combination is Qt::Key_Minus + Qt::NoModifier\&.
.PP
\fBParameters:\fP
.RS 4
\fIkey\fP 
.br
\fImodifiers\fP 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBgetZoomOutKey()\fP, \fBsetZoomOutKey()\fP 
.RE
.PP

.SS "double QwtMagnifier::wheelFactor () const"
\fBReturns:\fP
.RS 4
Wheel factor 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetWheelFactor()\fP 
.RE
.PP

.SS "Qt::KeyboardModifiers QwtMagnifier::wheelModifiers () const"
\fBReturns:\fP
.RS 4
Wheel modifiers 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetWheelModifiers()\fP 
.RE
.PP

.SS "void QwtMagnifier::widgetKeyPressEvent (QKeyEvent *keyEvent)\fC [protected]\fP, \fC [virtual]\fP"
Handle a key press event for the observed widget\&.
.PP
\fBParameters:\fP
.RS 4
\fIkeyEvent\fP Key event 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBeventFilter()\fP, \fBwidgetKeyReleaseEvent()\fP 
.RE
.PP

.SS "void QwtMagnifier::widgetKeyReleaseEvent (QKeyEvent *keyEvent)\fC [protected]\fP, \fC [virtual]\fP"
Handle a key release event for the observed widget\&.
.PP
\fBParameters:\fP
.RS 4
\fIkeyEvent\fP Key event 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBeventFilter()\fP, \fBwidgetKeyReleaseEvent()\fP 
.RE
.PP

.SS "void QwtMagnifier::widgetMouseMoveEvent (QMouseEvent *mouseEvent)\fC [protected]\fP, \fC [virtual]\fP"
Handle a mouse move event for the observed widget\&.
.PP
\fBParameters:\fP
.RS 4
\fImouseEvent\fP Mouse event 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBeventFilter()\fP, \fBwidgetMousePressEvent()\fP, \fBwidgetMouseReleaseEvent()\fP, 
.RE
.PP

.SS "void QwtMagnifier::widgetMousePressEvent (QMouseEvent *mouseEvent)\fC [protected]\fP, \fC [virtual]\fP"
Handle a mouse press event for the observed widget\&.
.PP
\fBParameters:\fP
.RS 4
\fImouseEvent\fP Mouse event 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBeventFilter()\fP, \fBwidgetMouseReleaseEvent()\fP, \fBwidgetMouseMoveEvent()\fP 
.RE
.PP

.SS "void QwtMagnifier::widgetMouseReleaseEvent (QMouseEvent *mouseEvent)\fC [protected]\fP, \fC [virtual]\fP"
Handle a mouse release event for the observed widget\&.
.PP
\fBParameters:\fP
.RS 4
\fImouseEvent\fP Mouse event
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBeventFilter()\fP, \fBwidgetMousePressEvent()\fP, \fBwidgetMouseMoveEvent()\fP, 
.RE
.PP

.SS "void QwtMagnifier::widgetWheelEvent (QWheelEvent *wheelEvent)\fC [protected]\fP, \fC [virtual]\fP"
Handle a wheel event for the observed widget\&.
.PP
\fBParameters:\fP
.RS 4
\fIwheelEvent\fP Wheel event 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBeventFilter()\fP 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for Qwt User's Guide from the source code\&.