QwtPicker provides selections on a widget. More...

#include <qwt_picker.h>

Inheritance diagram for QwtPicker:

Collaboration diagram for QwtPicker:

Classes
class	PickerWidget
class	PrivateData
Public Types
enum	SelectionType { NoSelection = 0, PointSelection = 1, RectSelection = 2, PolygonSelection = 4 }
enum	RectSelectionType { CornerToCorner = 64, CenterToCorner = 128, CenterToRadius = 256 }
	Selection subtype for RectSelection This enum type describes the type of rectangle selections. It can be or'd with QwtPicker::RectSelectionType and QwtPicker::SelectionMode and passed to QwtPicker::setSelectionFlags(). CornerToCorner The first and the second selected point are the corners of the rectangle. CenterToCorner The first point is the center, the second a corner of the rectangle. CenterToRadius The first point is the center of a quadrat, calculated by the maximum of the x- and y-distance. More...
enum	SelectionMode { ClickSelection = 1024, DragSelection = 2048 }
enum	RubberBand { NoRubberBand = 0, HLineRubberBand, VLineRubberBand, CrossRubberBand, RectRubberBand, EllipseRubberBand, PolygonRubberBand, UserRubberBand = 100 }
enum	DisplayMode { AlwaysOff, AlwaysOn, ActiveOnly }
enum	ResizeMode { Stretch, KeepSize }
Signals
void	selected (const QwtPolygon &pa)
void	appended (const QPoint &pos)
void	moved (const QPoint &pos)
void	changed (const QwtPolygon &pa)
Public Member Functions
	QwtPicker (QWidget *parent)
	QwtPicker (int selectionFlags, RubberBand rubberBand, DisplayMode trackerMode, QWidget *)
virtual	~QwtPicker ()
	Destructor.
virtual void	setSelectionFlags (int)
int	selectionFlags () const
virtual void	setRubberBand (RubberBand)
RubberBand	rubberBand () const
virtual void	setTrackerMode (DisplayMode)
	Set the display mode of the tracker.
DisplayMode	trackerMode () const
virtual void	setResizeMode (ResizeMode)
	Set the resize mode.
ResizeMode	resizeMode () const
virtual void	setRubberBandPen (const QPen &)
QPen	rubberBandPen () const
virtual void	setTrackerPen (const QPen &)
QPen	trackerPen () const
virtual void	setTrackerFont (const QFont &)
QFont	trackerFont () const
bool	isEnabled () const
virtual void	setEnabled (bool)
	En/disable the picker.
bool	isActive () const
virtual bool	eventFilter (QObject , QEvent )
	Event filter.
QWidget *	parentWidget ()
	Return the parent widget, where the selection happens.
const QWidget *	parentWidget () const
	Return the parent widget, where the selection happens.
virtual QRect	pickRect () const
const QwtPolygon &	selection () const
	Return Selected points.
virtual void	drawRubberBand (QPainter *) const
virtual void	drawTracker (QPainter *) const
virtual QwtText	trackerText (const QPoint &pos) const
	Return the label for a position.
QPoint	trackerPosition () const
QRect	trackerRect (const QFont &) const
Protected Member Functions
virtual bool	accept (QwtPolygon &selection) const
	Validate and fixup the selection.
virtual void	transition (const QEvent *)
virtual void	begin ()
virtual void	append (const QPoint &)
virtual void	move (const QPoint &)
virtual bool	end (bool ok=true)
	Close a selection setting the state to inactive.
virtual void	reset ()
virtual void	widgetMousePressEvent (QMouseEvent *)
virtual void	widgetMouseReleaseEvent (QMouseEvent *)
virtual void	widgetMouseDoubleClickEvent (QMouseEvent *)
virtual void	widgetMouseMoveEvent (QMouseEvent *)
virtual void	widgetWheelEvent (QWheelEvent *)
virtual void	widgetKeyPressEvent (QKeyEvent *)
virtual void	widgetKeyReleaseEvent (QKeyEvent *)
virtual void	widgetLeaveEvent (QEvent *)
virtual void	stretchSelection (const QSize &oldSize, const QSize &newSize)
virtual QwtPickerMachine *	stateMachine (int) const
virtual void	updateDisplay ()
	Update the state of rubberband and tracker label.
const QWidget *	rubberBandWidget () const
const QWidget *	trackerWidget () const
Properties
int	selectionFlags
DisplayMode	trackerMode
QFont	trackerFont
RubberBand	rubberBand
ResizeMode	resizeMode
bool	isEnabled
QPen	trackerPen
QPen	rubberBandPen

Detailed Description

QwtPicker provides selections on a widget.

QwtPicker filters all mouse and keyboard events of a widget and translates them into an array of selected points. Depending on the QwtPicker::SelectionType the selection might be a single point, a rectangle or a polygon. The selection process is supported by optional rubberbands (rubberband selection) and position trackers.

QwtPicker is useful for widgets where the event handlers can't be overloaded, like for components of composite widgets. It offers alternative handlers for mouse and key events.

Example

#include <qwt_picker.h>

QwtPicker *picker = new QwtPicker(widget);
picker->setTrackerMode(QwtPicker::ActiveOnly);
connect(picker, SIGNAL(selected(const QwtPolygon &)), ...);

// emit the position of clicks on widget
picker->setSelectionFlags(QwtPicker::PointSelection | QwtPicker::ClickSelection);

    ...
    
// now select rectangles
picker->setSelectionFlags(QwtPicker::RectSelection | QwtPicker::DragSelection);
picker->setRubberBand(QwtPicker::RectRubberBand);

The selection process uses the commands begin(), append(), move() and end(). append() adds a new point to the selection, move() changes the position of the latest point.

The commands are initiated from a small state machine (QwtPickerMachine) that translates mouse and key events. There are a couple of predefined state machines for point, rect and polygon selections. The selectionFlags() control which one should be used. It is possible to use other machines by overloading stateMachine().

The picker is active (isActive()), between begin() and end(). In active state the rubberband is displayed, and the tracker is visible in case of trackerMode is ActiveOnly or AlwaysOn.

The cursor can be moved using the arrow keys. All selections can be aborted using the abort key. (QwtEventPattern::KeyPatternCode)

Warning:: In case of QWidget::NoFocus the focus policy of the observed widget is set to QWidget::WheelFocus and mouse tracking will be manipulated for ClickSelection while the picker is active, or if trackerMode() is AlwayOn.

Definition at line 80 of file qwt_picker.h.

Member Enumeration Documentation

enum QwtPicker::DisplayMode

AlwaysOff
Display never.
AlwaysOn
Display always.
ActiveOnly
Display only when the selection is active.

See also:: QwtPicker::setTrackerMode(), QwtPicker::trackerMode(), QwtPicker::isActive()

Enumerator:

AlwaysOff
AlwaysOn
ActiveOnly

Definition at line 217 of file qwt_picker.h.

    {
        AlwaysOff,
        AlwaysOn,
        ActiveOnly
    };

enum QwtPicker::RectSelectionType

Selection subtype for RectSelection This enum type describes the type of rectangle selections. It can be or'd with QwtPicker::RectSelectionType and QwtPicker::SelectionMode and passed to QwtPicker::setSelectionFlags().

CornerToCorner
The first and the second selected point are the corners of the rectangle.
CenterToCorner
The first point is the center, the second a corner of the rectangle.
CenterToRadius
The first point is the center of a quadrat, calculated by the maximum of the x- and y-distance.

The default value is CornerToCorner.

See also:: QwtPicker::setSelectionFlags(), QwtPicker::selectionFlags()

Enumerator:

CornerToCorner
CenterToCorner
CenterToRadius

Definition at line 143 of file qwt_picker.h.

    {
        CornerToCorner = 64,
        CenterToCorner = 128,
        CenterToRadius = 256
    };

enum QwtPicker::ResizeMode

Controls what to do with the selected points of an active selection when the observed widget is resized.

Stretch
All points are scaled according to the new size,
KeepSize
All points remain unchanged.

The default value is Stretch.

See also:: QwtPicker::setResizeMode(), QwtPicker::resize()

Enumerator:

Stretch
KeepSize

Definition at line 236 of file qwt_picker.h.

    {
        Stretch,
        KeepSize
    };

enum QwtPicker::RubberBand

Rubberband style

NoRubberBand
No rubberband.
HLineRubberBand & PointSelection
A horizontal line.
VLineRubberBand & PointSelection
A vertical line.
CrossRubberBand & PointSelection
A horizontal and a vertical line.
RectRubberBand & RectSelection
A rectangle.
EllipseRubberBand & RectSelection
An ellipse.
PolygonRubberBand &PolygonSelection
A polygon.
UserRubberBand
Values >= UserRubberBand can be used to define additional rubber bands.

The default value is NoRubberBand.

See also:: QwtPicker::setRubberBand(), QwtPicker::rubberBand()

Enumerator:

NoRubberBand
HLineRubberBand
VLineRubberBand
CrossRubberBand
RectRubberBand
EllipseRubberBand
PolygonRubberBand
UserRubberBand

Definition at line 187 of file qwt_picker.h.

    {
        NoRubberBand = 0,

        // Point
        HLineRubberBand,
        VLineRubberBand,
        CrossRubberBand,

        // Rect
        RectRubberBand,
        EllipseRubberBand,

        // Polygon
        PolygonRubberBand,

        UserRubberBand = 100
    };

enum QwtPicker::SelectionMode

Values of this enum type or'd together with a SelectionType value identifies which state machine should be used for the selection.

The default value is ClickSelection.

See also:: stateMachine()

Enumerator:

ClickSelection
DragSelection

Definition at line 157 of file qwt_picker.h.

    {
        ClickSelection = 1024,
        DragSelection = 2048
    };

enum QwtPicker::SelectionType

This enum type describes the type of a selection. It can be or'd with QwtPicker::RectSelectionType and QwtPicker::SelectionMode and passed to QwtPicker::setSelectionFlags()

NoSelection
Selection is disabled. Note this is different to the disabled state, as you might have a tracker.
PointSelection
Select a single point.
RectSelection
Select a rectangle.
PolygonSelection
Select a polygon.

The default value is NoSelection.

See also:: QwtPicker::setSelectionFlags(), QwtPicker::selectionFlags()

Enumerator:

NoSelection
PointSelection
RectSelection
PolygonSelection

Definition at line 117 of file qwt_picker.h.

    {
        NoSelection = 0,
        PointSelection = 1,
        RectSelection = 2,
        PolygonSelection = 4
    };

Constructor & Destructor Documentation

QwtPicker::QwtPicker ( QWidget * parent ) [explicit]

Constructor

Creates an picker that is enabled, but where selection flag is set to NoSelection, rubberband and tracker are disabled.

Parameters:

parent Parent widget, that will be observed

Definition at line 249 of file qwt_picker.cpp.

References AlwaysOff, NoRubberBand, and NoSelection.

                                   :
    QObject(parent)
{
    init(parent, NoSelection, NoRubberBand, AlwaysOff);
}

QwtPicker::QwtPicker	(	int	selectionFlags,
		RubberBand	rubberBand,
		DisplayMode	trackerMode,
		QWidget *	parent
	)		`[explicit]`

Constructor

Parameters:

selectionFlags	Or'd value of SelectionType, RectSelectionType and SelectionMode
rubberBand	Rubberband style
trackerMode	Tracker mode
parent	Parent widget, that will be observed

Definition at line 264 of file qwt_picker.cpp.

                                                 :
    QObject(parent)
{
    init(parent, selectionFlags, rubberBand, trackerMode);
}

QwtPicker::~QwtPicker ( ) [virtual]

Destructor.

Definition at line 272 of file qwt_picker.cpp.

References QwtPicker::PrivateData::rubberBandWidget, QwtPicker::PrivateData::stateMachine, and QwtPicker::PrivateData::trackerWidget.

{
    setMouseTracking(false);
    delete d_data->stateMachine;
    delete d_data->rubberBandWidget;
    delete d_data->trackerWidget;
    delete d_data;
}

Member Function Documentation

bool QwtPicker::accept ( QwtPolygon & selection ) const [protected, virtual]

Validate and fixup the selection.

Accepts all selections unmodified

Parameters:

selection Selection to validate and fixup

Returns:: true, when accepted, false otherwise

Reimplemented in QwtPlotZoomer.

Definition at line 1266 of file qwt_picker.cpp.

Referenced by end().

{
    return true;
}

void QwtPicker::append ( const QPoint & pos ) [protected, virtual]

Append a point to the selection and update rubberband and tracker. The appended() signal is emitted.

Parameters:

pos	Additional point

See also:: isActive(), begin(), end(), move(), appended()

Reimplemented in QwtPlotPicker.

Definition at line 1225 of file qwt_picker.cpp.

References appended(), QwtPicker::PrivateData::isActive, QwtPicker::PrivateData::selection, and updateDisplay().

Referenced by transition().

{
    if ( d_data->isActive )
    {
        const int idx = d_data->selection.count();
        d_data->selection.resize(idx + 1);
        d_data->selection[idx] = pos;

        updateDisplay();

        emit appended(pos);
    }
}

void QwtPicker::appended ( const QPoint & pos ) [signal]

A signal emitted when a point has been appended to the selection

Parameters:

pos	Position of the appended point.

See also:: append(). moved()

Referenced by append().

void QwtPicker::begin ( ) [protected, virtual]

Open a selection setting the state to active

See also:: isActive(), end(), append(), move()

Reimplemented in QwtPlotZoomer.

Definition at line 1146 of file qwt_picker.cpp.

References AlwaysOff, QwtPicker::PrivateData::isActive, parentWidget(), QwtPicker::PrivateData::selection, trackerMode(), QwtPicker::PrivateData::trackerPosition, and updateDisplay().

Referenced by transition().

{
    if ( d_data->isActive )
        return;

    d_data->selection.resize(0);
    d_data->isActive = true;

    if ( trackerMode() != AlwaysOff )
    {
        if ( d_data->trackerPosition.x() < 0 || d_data->trackerPosition.y() < 0 ) 
        {
            QWidget *w = parentWidget();
            if ( w )
                d_data->trackerPosition = w->mapFromGlobal(QCursor::pos());
        }
    }

    updateDisplay();
    setMouseTracking(true);
}

void QwtPicker::changed ( const QwtPolygon & pa ) [signal]

A signal emitted when the active selection has been changed. This might happen when the observed widget is resized.

Parameters:

pa	Changed selection

See also:: stretchSelection()

Referenced by stretchSelection().

void QwtPicker::drawRubberBand ( QPainter * painter ) const [virtual]

Draw a rubberband , depending on rubberBand() and selectionFlags()

Parameters:

painter Painter, initialized with clip rect

See also:: rubberBand(), RubberBand, selectionFlags()

Definition at line 654 of file qwt_picker.cpp.

References CenterToCorner, CenterToRadius, CrossRubberBand, QwtPainter::drawEllipse(), QwtPainter::drawLine(), QwtPainter::drawRect(), EllipseRubberBand, HLineRubberBand, int(), isActive(), NoRubberBand, pickRect(), PointSelection, PolygonRubberBand, PolygonSelection, qwtAbs, qwtMax, RectRubberBand, RectSelection, rubberBand(), rubberBandPen(), QwtPicker::PrivateData::selection, selectionFlags(), and VLineRubberBand.

{
    if ( !isActive() || rubberBand() == NoRubberBand || 
        rubberBandPen().style() == Qt::NoPen )
    {
        return;
    }

    const QRect &pRect = pickRect();
    const QwtPolygon &pa = d_data->selection;

    if ( selectionFlags() & PointSelection )
    {
        if ( pa.count() < 1 )
            return;

        const QPoint pos = pa[0];

        switch(rubberBand())
        {
            case VLineRubberBand:
                QwtPainter::drawLine(painter, pos.x(),
                    pRect.top(), pos.x(), pRect.bottom());
                break;

            case HLineRubberBand:
                QwtPainter::drawLine(painter, pRect.left(), 
                    pos.y(), pRect.right(), pos.y());
                break;

            case CrossRubberBand:
                QwtPainter::drawLine(painter, pos.x(),
                    pRect.top(), pos.x(), pRect.bottom());
                QwtPainter::drawLine(painter, pRect.left(), 
                    pos.y(), pRect.right(), pos.y());
                break;
            default:
                break;
        }
    }

    else if ( selectionFlags() & RectSelection )
    {
        if ( pa.count() < 2 )
            return;

        QPoint p1 = pa[0];
        QPoint p2 = pa[int(pa.count() - 1)];

        if ( selectionFlags() & CenterToCorner )
        {
            p1.setX(p1.x() - (p2.x() - p1.x()));
            p1.setY(p1.y() - (p2.y() - p1.y()));
        }
        else if ( selectionFlags() & CenterToRadius )
        {
            const int radius = qwtMax(qwtAbs(p2.x() - p1.x()), 
                qwtAbs(p2.y() - p1.y()));
            p2.setX(p1.x() + radius);
            p2.setY(p1.y() + radius);
            p1.setX(p1.x() - radius);
            p1.setY(p1.y() - radius);
        }

#if QT_VERSION < 0x040000
        const QRect rect = QRect(p1, p2).normalize();
#else
        const QRect rect = QRect(p1, p2).normalized();
#endif
        switch(rubberBand())
        {
            case EllipseRubberBand:
                QwtPainter::drawEllipse(painter, rect);
                break;
            case RectRubberBand:
                QwtPainter::drawRect(painter, rect);
                break;
            default:
                break;
        }
    }
    else if ( selectionFlags() & PolygonSelection )
    {
        if ( rubberBand() == PolygonRubberBand )
            painter->drawPolyline(pa);
    }
}

void QwtPicker::drawTracker ( QPainter * painter ) const [virtual]

Draw the tracker

Parameters:

painter Painter

See also:: trackerRect(), trackerText()

Definition at line 749 of file qwt_picker.cpp.

References QwtText::draw(), QwtText::isEmpty(), QwtText::setFont(), QwtPicker::PrivateData::trackerPosition, trackerRect(), trackerText(), and QwtText::usedFont().

{
    const QRect textRect = trackerRect(painter->font());
    if ( !textRect.isEmpty() )
    {
        QwtText label = trackerText(d_data->trackerPosition);
        if ( !label.isEmpty() )
        {
            painter->save();

#if defined(Q_WS_MAC)
            // Antialiased fonts are broken on the Mac.
#if QT_VERSION >= 0x040000 
            painter->setRenderHint(QPainter::TextAntialiasing, false);
#else
            QFont fnt = label.usedFont(painter->font());
            fnt.setStyleStrategy(QFont::NoAntialias);
            label.setFont(fnt);
#endif
#endif
            label.draw(painter, textRect);

            painter->restore();
        }
    }
}

bool QwtPicker::end ( bool ok = true ) [protected, virtual]

Close a selection setting the state to inactive.

The selection is validated and maybe fixed by QwtPicker::accept().

Parameters:

ok	If true, complete the selection and emit a selected signal otherwise discard the selection.

Returns:: true if the selection is accepted, false otherwise

See also:: isActive(), begin(), append(), move(), selected(), accept()

Reimplemented in QwtPlotPicker, and QwtPlotZoomer.

Definition at line 1178 of file qwt_picker.cpp.

References accept(), ActiveOnly, QwtPicker::PrivateData::isActive, selected(), QwtPicker::PrivateData::selection, trackerMode(), QwtPicker::PrivateData::trackerPosition, and updateDisplay().

Referenced by reset(), and transition().

{
    if ( d_data->isActive )
    {
        setMouseTracking(false);

        d_data->isActive = false;

        if ( trackerMode() == ActiveOnly )
            d_data->trackerPosition = QPoint(-1, -1);

        if ( ok )
            ok = accept(d_data->selection);

        if ( ok )
            emit selected(d_data->selection);
        else
            d_data->selection.resize(0);

        updateDisplay();
    }
    else
        ok = false;

    return ok;
}

bool QwtPicker::eventFilter	(	QObject *	o,
		QEvent *	e
	)		`[virtual]`

Event filter.

When isEnabled() == true all events of the observed widget are filtered. Mouse and keyboard events are translated into widgetMouse- and widgetKey- and widgetWheel-events. Paint and Resize events are handled to keep rubberband and tracker up to date.

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

Definition at line 862 of file qwt_picker.cpp.

References parentWidget(), QwtPicker::PrivateData::resizeMode, QwtPicker::PrivateData::rubberBandWidget, Stretch, stretchSelection(), QwtPicker::PrivateData::trackerWidget, widgetKeyPressEvent(), widgetKeyReleaseEvent(), widgetLeaveEvent(), widgetMouseDoubleClickEvent(), widgetMouseMoveEvent(), widgetMousePressEvent(), widgetMouseReleaseEvent(), and widgetWheelEvent().

{
    if ( o && o == parentWidget() )
    {
        switch(e->type())
        {
            case QEvent::Resize:
            {
                const QResizeEvent *re = (QResizeEvent *)e;
                if ( d_data->resizeMode == Stretch )
                    stretchSelection(re->oldSize(), re->size());

                if ( d_data->rubberBandWidget )
                    d_data->rubberBandWidget->resize(re->size());
             
                if ( d_data->trackerWidget )
                    d_data->trackerWidget->resize(re->size());
                break;
            }
            case QEvent::Leave:
                widgetLeaveEvent(e);
                break;
            case QEvent::MouseButtonPress:
                widgetMousePressEvent((QMouseEvent *)e);
                break;
            case QEvent::MouseButtonRelease:
                widgetMouseReleaseEvent((QMouseEvent *)e);
                break;
            case QEvent::MouseButtonDblClick:
                widgetMouseDoubleClickEvent((QMouseEvent *)e);
                break;
            case QEvent::MouseMove:
                widgetMouseMoveEvent((QMouseEvent *)e);
                break;
            case QEvent::KeyPress:
                widgetKeyPressEvent((QKeyEvent *)e);
                break;
            case QEvent::KeyRelease:
                widgetKeyReleaseEvent((QKeyEvent *)e);
                break;
            case QEvent::Wheel:
                widgetWheelEvent((QWheelEvent *)e);
                break;
            default:
                break;
        }
    }
    return false;
}

bool QwtPicker::isActive ( ) const

A picker is active between begin() and end().

Returns:: true if the selection is active.

Definition at line 1275 of file qwt_picker.cpp.

References QwtPicker::PrivateData::isActive.

Referenced by drawRubberBand(), reset(), trackerRect(), updateDisplay(), QwtPlotZoomer::widgetKeyPressEvent(), widgetLeaveEvent(), and widgetMouseMoveEvent().

{
    return d_data->isActive;
}

bool QwtPicker::isEnabled ( ) const

void QwtPicker::move ( const QPoint & pos ) [protected, virtual]

Move the last point of the selection The moved() signal is emitted.

Parameters:

pos	New position

See also:: isActive(), begin(), end(), append()

Reimplemented in QwtPlotPicker.

Definition at line 1247 of file qwt_picker.cpp.

References QwtPicker::PrivateData::isActive, moved(), QwtPicker::PrivateData::selection, and updateDisplay().

Referenced by transition().

{
    if ( d_data->isActive )
    {
        const int idx = d_data->selection.count() - 1;
        if ( idx >= 0 )
        {
            if ( d_data->selection[idx] != pos )
            {
                d_data->selection[idx] = pos;

                updateDisplay();

                emit moved(pos);
            }
        }
    }
}

void QwtPicker::moved ( const QPoint & pos ) [signal]

A signal emitted whenever the last appended point of the selection has been moved.

Parameters:

pos	Position of the moved last point of the selection.

See also:: move(), appended()

Referenced by move().

QWidget * QwtPicker::parentWidget ( )

Return the parent widget, where the selection happens.

Definition at line 375 of file qwt_picker.cpp.

Referenced by begin(), QwtPlotPicker::canvas(), eventFilter(), pickRect(), setEnabled(), transition(), updateDisplay(), QwtPicker::PickerWidget::updateMask(), and widgetKeyPressEvent().

{
    QObject *obj = parent();
    if ( obj && obj->isWidgetType() )
        return (QWidget *)obj;

    return NULL;
}

const QWidget * QwtPicker::parentWidget ( ) const

Return the parent widget, where the selection happens.

Definition at line 385 of file qwt_picker.cpp.

{
    QObject *obj = parent();
    if ( obj && obj->isWidgetType() )
        return (QWidget *)obj;

    return NULL;
}

QRect QwtPicker::pickRect ( ) const [virtual]

Find the area of the observed widget, where selection might happen.

Returns:: QFrame::contentsRect() if it is a QFrame, QWidget::rect() otherwise.

Definition at line 1354 of file qwt_picker.cpp.

References parentWidget().

Referenced by drawRubberBand(), trackerRect(), widgetKeyPressEvent(), widgetMouseMoveEvent(), and widgetWheelEvent().

{
    QRect rect;

    const QWidget *widget = parentWidget();
    if ( !widget )
        return rect;

    if ( widget->inherits("QFrame") )
        rect = ((QFrame *)widget)->contentsRect();
    else
        rect = widget->rect();

    return rect;
}

void QwtPicker::reset ( ) [protected, virtual]

Reset the state machine and terminate (end(false)) the selection

Definition at line 1208 of file qwt_picker.cpp.

References end(), isActive(), QwtPickerMachine::reset(), and QwtPicker::PrivateData::stateMachine.

Referenced by widgetKeyPressEvent().

{
    if ( d_data->stateMachine )
        d_data->stateMachine->reset();

    if (isActive())
        end(false);
}

ResizeMode QwtPicker::resizeMode ( ) const

RubberBand QwtPicker::rubberBand ( ) const

Referenced by drawRubberBand(), setRubberBand(), trackerRect(), QwtPlotPicker::trackerText(), trackerText(), and updateDisplay().

QPen QwtPicker::rubberBandPen ( ) const

Referenced by drawRubberBand(), and updateDisplay().

const QWidget * QwtPicker::rubberBandWidget ( ) const [protected]

Returns:: Widget displaying the rubberband

Definition at line 1431 of file qwt_picker.cpp.

References QwtPicker::PrivateData::rubberBandWidget.

{
    return d_data->rubberBandWidget;
}

void QwtPicker::selected ( const QwtPolygon & pa ) [signal]

A signal emitting the selected points, at the end of a selection.

Parameters:

pa	Selected points

Referenced by end().

const QwtPolygon & QwtPicker::selection ( ) const

Return Selected points.

Definition at line 1281 of file qwt_picker.cpp.

References QwtPicker::PrivateData::selection.

Referenced by QwtPlotZoomer::end(), and QwtPlotPicker::end().

{
    return d_data->selection;
}

int QwtPicker::selectionFlags ( ) const

Referenced by drawRubberBand(), and QwtPlotPicker::end().

void QwtPicker::setEnabled ( bool enabled ) [virtual]

En/disable the picker.

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

Parameters:

enabled true or false

See also:: isEnabled(), eventFilter()

Definition at line 513 of file qwt_picker.cpp.

References QwtPicker::PrivateData::enabled, parentWidget(), and updateDisplay().

{
    if ( d_data->enabled != enabled )
    {
        d_data->enabled = enabled;

        QWidget *w = parentWidget();
        if ( w )
        {
            if ( enabled )
                w->installEventFilter(this);
            else
                w->removeEventFilter(this);
        }

        updateDisplay();
    }
}

void QwtPicker::setResizeMode ( ResizeMode mode ) [virtual]

Set the resize mode.

The resize mode controls what to do with the selected points of an active selection when the observed widget is resized.

Stretch means the points are scaled according to the new size, KeepSize means the points remain unchanged.

The default mode is Stretch.

Parameters:

mode	Resize mode

See also:: resizeMode(), ResizeMode

Definition at line 489 of file qwt_picker.cpp.

References QwtPicker::PrivateData::resizeMode.

{
    d_data->resizeMode = mode;
}

void QwtPicker::setRubberBand ( RubberBand rubberBand ) [virtual]

Set the rubberband style

Parameters:

rubberBand Rubberband style The default value is NoRubberBand.

See also:: rubberBand(), RubberBand, setRubberBandPen()

Definition at line 427 of file qwt_picker.cpp.

References rubberBand(), and QwtPicker::PrivateData::rubberBand.

{
    d_data->rubberBand = rubberBand;
}

void QwtPicker::setRubberBandPen ( const QPen & pen ) [virtual]

Set the pen for the rubberband

Parameters:

pen	Rubberband pen

See also:: rubberBandPen(), setRubberBand()

Definition at line 597 of file qwt_picker.cpp.

References QwtPicker::PrivateData::rubberBandPen, and updateDisplay().

Referenced by QmitkHistogramWidget::InitializeZoomer().

{
    if ( pen != d_data->rubberBandPen )
    {
        d_data->rubberBandPen = pen;
        updateDisplay();
    }
}

void QwtPicker::setSelectionFlags ( int flags ) [virtual]

Set the selection flags

Parameters:

flags Or'd value of SelectionType, RectSelectionType and SelectionMode. The default value is NoSelection.

See also:: selectionFlags(), SelectionType, RectSelectionType, SelectionMode

Reimplemented in QwtPlotZoomer.

Definition at line 403 of file qwt_picker.cpp.

References QwtPicker::PrivateData::selectionFlags, and stateMachine().

{
    d_data->selectionFlags = flags;
    setStateMachine(stateMachine(flags));
}

void QwtPicker::setTrackerFont ( const QFont & font ) [virtual]

Set the font for the tracker

Parameters:

font	Tracker font

See also:: trackerFont(), setTrackerMode(), setTrackerPen()

Definition at line 548 of file qwt_picker.cpp.

References QwtPicker::PrivateData::trackerFont, and updateDisplay().

{
    if ( font != d_data->trackerFont )
    {
        d_data->trackerFont = font;
        updateDisplay();
    }
}

void QwtPicker::setTrackerMode ( DisplayMode mode ) [virtual]

Set the display mode of the tracker.

A tracker displays information about current position of the cursor as a string. The display mode controls if the tracker has to be displayed whenever the observed widget has focus and cursor (AlwaysOn), never (AlwaysOff), or only when the selection is active (ActiveOnly).

Parameters:

mode	Tracker display mode

Warning:: In case of AlwaysOn, mouseTracking will be enabled for the observed widget.

See also:: trackerMode(), DisplayMode

Definition at line 457 of file qwt_picker.cpp.

References AlwaysOn, and QwtPicker::PrivateData::trackerMode.

{   
    if ( d_data->trackerMode != mode )
    {
        d_data->trackerMode = mode;
        setMouseTracking(d_data->trackerMode == AlwaysOn);
    }
}

void QwtPicker::setTrackerPen ( const QPen & pen ) [virtual]

Set the pen for the tracker

Parameters:

pen	Tracker pen

See also:: trackerPen(), setTrackerMode(), setTrackerFont()

Definition at line 573 of file qwt_picker.cpp.

References QwtPicker::PrivateData::trackerPen, and updateDisplay().

Referenced by QmitkHistogramWidget::InitializeZoomer().

{
    if ( pen != d_data->trackerPen )
    {
        d_data->trackerPen = pen;
        updateDisplay();
    }
}

QwtPickerMachine * QwtPicker::stateMachine ( int flags ) const [protected, virtual]

Create a state machine depending on the selection flags.

PointSelection | ClickSelection
QwtPickerClickPointMachine()
PointSelection | DragSelection
QwtPickerDragPointMachine()
RectSelection | ClickSelection
QwtPickerClickRectMachine()
RectSelection | DragSelection
QwtPickerDragRectMachine()
PolygonSelection
QwtPickerPolygonMachine()

See also:: setSelectionFlags()

Definition at line 351 of file qwt_picker.cpp.

References ClickSelection, PointSelection, PolygonSelection, and RectSelection.

Referenced by setSelectionFlags().

{
    if ( flags & PointSelection )
    {
        if ( flags & ClickSelection )
            return new QwtPickerClickPointMachine;
        else
            return new QwtPickerDragPointMachine;
    }
    if ( flags & RectSelection )
    {
        if ( flags & ClickSelection )
            return new QwtPickerClickRectMachine;
        else
            return new QwtPickerDragRectMachine;
    }
    if ( flags & PolygonSelection )
    {
        return new QwtPickerPolygonMachine();
    }
    return NULL;
}

void QwtPicker::stretchSelection	(	const QSize &	oldSize,
		const QSize &	newSize
	)		`[protected, virtual]`

Scale the selection by the ratios of oldSize and newSize The changed() signal is emitted.

Parameters:

oldSize	Previous size
newSize	Current size

See also:: ResizeMode, setResizeMode(), resizeMode()

Definition at line 1295 of file qwt_picker.cpp.

References changed(), int(), and QwtPicker::PrivateData::selection.

Referenced by eventFilter().

{
    if ( oldSize.isEmpty() )
    {
        // avoid division by zero. But scaling for small sizes also 
        // doesn't make much sense, because of rounding losses. TODO ...
        return;
    }

    const double xRatio =
        double(newSize.width()) / double(oldSize.width());
    const double yRatio =
        double(newSize.height()) / double(oldSize.height());

    for ( int i = 0; i < int(d_data->selection.count()); i++ )
    {
        QPoint &p = d_data->selection[i];
        p.setX(qRound(p.x() * xRatio));
        p.setY(qRound(p.y() * yRatio));

        emit changed(d_data->selection);
    }
}

QFont QwtPicker::trackerFont ( ) const

DisplayMode QwtPicker::trackerMode ( ) const

Referenced by begin(), end(), trackerRect(), and updateDisplay().

QPen QwtPicker::trackerPen ( ) const

Referenced by updateDisplay().

QPoint QwtPicker::trackerPosition ( ) const

Returns:: Current position of the tracker

Definition at line 777 of file qwt_picker.cpp.

References QwtPicker::PrivateData::trackerPosition.

{
    return d_data->trackerPosition;
}

QRect QwtPicker::trackerRect ( const QFont & font ) const

Calculate the bounding rectangle for the tracker text from the current position of the tracker

Parameters:

font	Font of the tracker text

Returns:: Bounding rectangle of the tracker text

See also:: trackerPosition()

Definition at line 791 of file qwt_picker.cpp.

References ActiveOnly, AlwaysOff, int(), isActive(), QwtText::isEmpty(), NoRubberBand, pickRect(), qwtMax, qwtMin, rubberBand(), QwtPicker::PrivateData::selection, QwtText::textSize(), trackerMode(), QwtPicker::PrivateData::trackerPosition, and trackerText().

Referenced by drawTracker().

{
    if ( trackerMode() == AlwaysOff || 
        (trackerMode() == ActiveOnly && !isActive() ) )
    {
        return QRect();
    }

    if ( d_data->trackerPosition.x() < 0 || d_data->trackerPosition.y() < 0 )
        return QRect();

    QwtText text = trackerText(d_data->trackerPosition);
    if ( text.isEmpty() )
        return QRect();

    QRect textRect(QPoint(0, 0), text.textSize(font));

    const QPoint &pos = d_data->trackerPosition;

    int alignment = 0;
    if ( isActive() && d_data->selection.count() > 1 
        && rubberBand() != NoRubberBand )
    {
        const QPoint last = 
            d_data->selection[int(d_data->selection.count()) - 2];

        alignment |= (pos.x() >= last.x()) ? Qt::AlignRight : Qt::AlignLeft;
        alignment |= (pos.y() > last.y()) ? Qt::AlignBottom : Qt::AlignTop;
    }
    else
        alignment = Qt::AlignTop | Qt::AlignRight;

    const int margin = 5;

    int x = pos.x();
    if ( alignment & Qt::AlignLeft )
        x -= textRect.width() + margin;
    else if ( alignment & Qt::AlignRight )
        x += margin;

    int y = pos.y();
    if ( alignment & Qt::AlignBottom )
        y += margin;
    else if ( alignment & Qt::AlignTop )
        y -= textRect.height() + margin;
    
    textRect.moveTopLeft(QPoint(x, y));

    int right = qwtMin(textRect.right(), pickRect().right() - margin);
    int bottom = qwtMin(textRect.bottom(), pickRect().bottom() - margin);
    textRect.moveBottomRight(QPoint(right, bottom));

    int left = qwtMax(textRect.left(), pickRect().left() + margin);
    int top = qwtMax(textRect.top(), pickRect().top() + margin);
    textRect.moveTopLeft(QPoint(left, top));

    return textRect;
}

QwtText QwtPicker::trackerText ( const QPoint & pos ) const [virtual]

Return the label for a position.

In case of HLineRubberBand the label is the value of the y position, in case of VLineRubberBand the value of the x position. Otherwise the label contains x and y position separated by a ',' .

The format for the string conversion is "%d".

Parameters:

pos Position

Returns:: Converted position as string

Reimplemented in QwtPlotPicker.

Definition at line 628 of file qwt_picker.cpp.

References HLineRubberBand, rubberBand(), and VLineRubberBand.

Referenced by drawTracker(), and trackerRect().

{
    QString label;

    switch(rubberBand())
    {
        case HLineRubberBand:
            label.sprintf("%d", pos.y());
            break;
        case VLineRubberBand:
            label.sprintf("%d", pos.x());
            break;
        default:
            label.sprintf("%d, %d", pos.x(), pos.y());
    }
    return label;
}

const QWidget * QwtPicker::trackerWidget ( ) const [protected]

Returns:: Widget displaying the tracker text

Definition at line 1437 of file qwt_picker.cpp.

References QwtPicker::PrivateData::trackerWidget.

{
    return d_data->trackerWidget;
}

void QwtPicker::transition ( const QEvent * e ) [protected, virtual]

Passes an event to the state machine and executes the resulting commands. Append and Move commands use the current position of the cursor (QCursor::pos()).

Parameters:

e Event

Definition at line 1089 of file qwt_picker.cpp.

References append(), QwtPickerMachine::Append, begin(), QwtPickerMachine::Begin, end(), QwtPickerMachine::End, move(), QwtPickerMachine::Move, parentWidget(), QwtPicker::PrivateData::stateMachine, and QwtPickerMachine::transition().

Referenced by widgetKeyPressEvent(), widgetKeyReleaseEvent(), widgetMouseDoubleClickEvent(), widgetMouseMoveEvent(), widgetMousePressEvent(), widgetMouseReleaseEvent(), and widgetWheelEvent().

{
    if ( !d_data->stateMachine )
        return;

    QwtPickerMachine::CommandList commandList =
        d_data->stateMachine->transition(*this, e);

    QPoint pos;
    switch(e->type())
    {
        case QEvent::MouseButtonDblClick:
        case QEvent::MouseButtonPress:
        case QEvent::MouseButtonRelease:
        case QEvent::MouseMove:
        {
            const QMouseEvent *me = (QMouseEvent *)e;
            pos = me->pos();
            break;
        }
        default:
            pos = parentWidget()->mapFromGlobal(QCursor::pos());
    }

    for ( uint i = 0; i < (uint)commandList.count(); i++ )
    {
        switch(commandList[i])
        {
            case QwtPickerMachine::Begin:
            {
                begin();
                break;
            }
            case QwtPickerMachine::Append:
            {
                append(pos);
                break;
            }
            case QwtPickerMachine::Move:
            {
                move(pos);
                break;
            }
            case QwtPickerMachine::End:
            {
                end();
                break;
            }
        }
    }
}

void QwtPicker::updateDisplay ( ) [protected, virtual]

Update the state of rubberband and tracker label.

Definition at line 1371 of file qwt_picker.cpp.

References ActiveOnly, AlwaysOn, QwtPicker::PrivateData::enabled, isActive(), NoRubberBand, parentWidget(), QwtPicker::PickerWidget::RubberBand, rubberBand(), rubberBandPen(), QwtPicker::PrivateData::rubberBandWidget, QwtPicker::PickerWidget::Text, trackerMode(), trackerPen(), and QwtPicker::PrivateData::trackerWidget.

Referenced by append(), begin(), end(), move(), setEnabled(), setRubberBandPen(), setTrackerFont(), setTrackerPen(), widgetLeaveEvent(), widgetMouseMoveEvent(), and widgetWheelEvent().

{
    QWidget *w = parentWidget();

    bool showRubberband = false;
    bool showTracker = false;
    if ( w && w->isVisible() && d_data->enabled )
    {
        if ( rubberBand() != NoRubberBand && isActive() &&
            rubberBandPen().style() != Qt::NoPen )
        {
            showRubberband = true;
        }

        if ( trackerMode() == AlwaysOn ||
            (trackerMode() == ActiveOnly && isActive() ) )
        {
            if ( trackerPen() != Qt::NoPen )
                showTracker = true;
        }
    }

#if QT_VERSION < 0x040000
    QGuardedPtr<PickerWidget> &rw = d_data->rubberBandWidget;
#else
    QPointer<PickerWidget> &rw = d_data->rubberBandWidget;
#endif
    if ( showRubberband )
    {
        if ( rw.isNull() )
        {
            rw = new PickerWidget( this, w, PickerWidget::RubberBand);
            rw->resize(w->size());
        }
        rw->updateMask();
        rw->update(); // Needed, when the mask doesn't change
    }
    else
        delete rw;

#if QT_VERSION < 0x040000
    QGuardedPtr<PickerWidget> &tw = d_data->trackerWidget;
#else
    QPointer<PickerWidget> &tw = d_data->trackerWidget;
#endif
    if ( showTracker )
    {
        if ( tw.isNull() )
        {
            tw = new PickerWidget( this, w, PickerWidget::Text);
            tw->resize(w->size());
        }
        tw->updateMask();
        tw->update(); // Needed, when the mask doesn't change
    }
    else
        delete tw;
}

void QwtPicker::widgetKeyPressEvent ( QKeyEvent * ke ) [protected, virtual]

Handle a key press event for the observed widget.

Selections can be completely done by the keyboard. The arrow keys move the cursor, the abort key aborts a selection. All other keys are handled by the current state machine.

See also:: QwtPicker, selectionFlags(); eventFilter(), widgetMousePressEvent(), widgetMouseReleaseEvent(), widgetMouseDoubleClickEvent(), widgetMouseMoveEvent(), widgetWheelEvent(), widgetKeyReleaseEvent(), stateMachine(), QwtEventPattern::KeyPatternCode

Reimplemented in QwtPlotZoomer.

Definition at line 1027 of file qwt_picker.cpp.

References QwtEventPattern::KeyAbort, QwtEventPattern::KeyDown, QwtEventPattern::KeyLeft, QwtEventPattern::keyMatch(), QwtEventPattern::KeyRight, QwtEventPattern::KeyUp, parentWidget(), pickRect(), qwtMax, qwtMin, reset(), and transition().

Referenced by eventFilter().

{
    int dx = 0;
    int dy = 0;

    int offset = 1;
    if ( ke->isAutoRepeat() )
        offset = 5;

    if ( keyMatch(KeyLeft, ke) )
        dx = -offset;
    else if ( keyMatch(KeyRight, ke) )
        dx = offset;
    else if ( keyMatch(KeyUp, ke) )
        dy = -offset;
    else if ( keyMatch(KeyDown, ke) )
        dy = offset;
    else if ( keyMatch(KeyAbort, ke) )
    {
        reset();
    }
    else
        transition(ke);

    if ( dx != 0 || dy != 0 )
    {
        const QRect rect = pickRect();
        const QPoint pos = parentWidget()->mapFromGlobal(QCursor::pos());

        int x = pos.x() + dx;
        x = qwtMax(rect.left(), x);
        x = qwtMin(rect.right(), x);

        int y = pos.y() + dy;
        y = qwtMax(rect.top(), y);
        y = qwtMin(rect.bottom(), y);

        QCursor::setPos(parentWidget()->mapToGlobal(QPoint(x, y)));
    }
}

void QwtPicker::widgetKeyReleaseEvent ( QKeyEvent * ke ) [protected, virtual]

Handle a key release event for the observed widget.

Passes the event to the state machine.

See also:: eventFilter(), widgetMousePressEvent(), widgetMouseReleaseEvent(), widgetMouseDoubleClickEvent(), widgetMouseMoveEvent(), widgetWheelEvent(), widgetKeyPressEvent(), stateMachine()

Definition at line 1077 of file qwt_picker.cpp.

References transition().

Referenced by eventFilter().

{
    transition(ke);
}

void QwtPicker::widgetLeaveEvent ( QEvent * ) [protected, virtual]

Handle a leave event for the observed widget.

See also:: eventFilter(), widgetMousePressEvent(), widgetMouseReleaseEvent(), widgetMouseDoubleClickEvent(), widgetWheelEvent(), widgetKeyPressEvent(), widgetKeyReleaseEvent()

Definition at line 956 of file qwt_picker.cpp.

References isActive(), QwtPicker::PrivateData::trackerPosition, and updateDisplay().

Referenced by eventFilter().

{
    d_data->trackerPosition = QPoint(-1, -1);
    if ( !isActive() )
        updateDisplay();
}

void QwtPicker::widgetMouseDoubleClickEvent ( QMouseEvent * me ) [protected, virtual]

Handle mouse double click event for the observed widget.

Empty implementation, does nothing.

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

Definition at line 987 of file qwt_picker.cpp.

References transition().

Referenced by eventFilter().

{
    transition(me);
}

void QwtPicker::widgetMouseMoveEvent ( QMouseEvent * e ) [protected, virtual]

Handle a mouse move event for the observed widget.

Move the last point of the selection in case of isActive() == true

See also:: eventFilter(), widgetMousePressEvent(), widgetMouseReleaseEvent(), widgetMouseDoubleClickEvent(), widgetWheelEvent(), widgetKeyPressEvent(), widgetKeyReleaseEvent()

Definition at line 936 of file qwt_picker.cpp.

References isActive(), pickRect(), QwtPicker::PrivateData::trackerPosition, transition(), and updateDisplay().

Referenced by eventFilter().

{
    if ( pickRect().contains(e->pos()) )
        d_data->trackerPosition = e->pos();
    else
        d_data->trackerPosition = QPoint(-1, -1);

    if ( !isActive() )
        updateDisplay();

    transition(e);
}

void QwtPicker::widgetMousePressEvent ( QMouseEvent * e ) [protected, virtual]

Handle a mouse press event for the observed widget.

Begin and/or end a selection depending on the selection flags.

See also:: QwtPicker, selectionFlags(); eventFilter(), widgetMouseReleaseEvent(), widgetMouseDoubleClickEvent(), widgetMouseMoveEvent(), widgetWheelEvent(), widgetKeyPressEvent(), widgetKeyReleaseEvent()

Definition at line 922 of file qwt_picker.cpp.

References transition().

Referenced by eventFilter().

{
    transition(e);
}

void QwtPicker::widgetMouseReleaseEvent ( QMouseEvent * e ) [protected, virtual]

Handle a mouse relase event for the observed widget.

End a selection depending on the selection flags.

See also:: QwtPicker, selectionFlags(); eventFilter(), widgetMousePressEvent(), widgetMouseDoubleClickEvent(), widgetMouseMoveEvent(), widgetWheelEvent(), widgetKeyPressEvent(), widgetKeyReleaseEvent()

Reimplemented in QwtPlotZoomer.

Definition at line 973 of file qwt_picker.cpp.

References transition().

Referenced by eventFilter().

{
    transition(e);
}

void QwtPicker::widgetWheelEvent ( QWheelEvent * e ) [protected, virtual]

Handle a wheel event for the observed widget.

Move the last point of the selection in case of isActive() == true

See also:: eventFilter(), widgetMousePressEvent(), widgetMouseReleaseEvent(), widgetMouseDoubleClickEvent(), widgetMouseMoveEvent(), widgetKeyPressEvent(), widgetKeyReleaseEvent()

Definition at line 1002 of file qwt_picker.cpp.

References pickRect(), QwtPicker::PrivateData::trackerPosition, transition(), and updateDisplay().

Referenced by eventFilter().

{
    if ( pickRect().contains(e->pos()) )
        d_data->trackerPosition = e->pos();
    else
        d_data->trackerPosition = QPoint(-1, -1);

    updateDisplay();

    transition(e);
}