Qt Reference Documentation

# QDial Class Reference

The QDial class provides a rounded range control (like a speedometer or potentiometer). More...

     #include <QDial>

Inherits: QAbstractSlider.

- List of all members, including inherited members
- Qt 3 support members

## Properties

- notchSize : const int
- notchTarget : qreal
- notchesVisible : bool
- wrapping : bool

- 11 properties inherited from QAbstractSlider
- 58 properties inherited from QWidget
- 1 property inherited from QObject

## Public Functions

| QDial ( QWidget * parent = 0 )
| ~QDial ()
int | notchSize () const
qreal | notchTarget () const
bool | notchesVisible () const
void | setNotchTarget ( double target )
bool | wrapping () const

## Reimplemented Public Functions

virtual QSize | minimumSizeHint () const
virtual QSize | sizeHint () const

- 22 public functions inherited from QAbstractSlider
- 221 public functions inherited from QWidget
- 29 public functions inherited from QObject
- 13 public functions inherited from QPaintDevice

## Public Slots

void | setNotchesVisible ( bool visible )
void | setWrapping ( bool on )

- 2 public slots inherited from QAbstractSlider
- 19 public slots inherited from QWidget
- 1 public slot inherited from QObject

## Protected Functions

void | initStyleOption ( QStyleOptionSlider * option ) const

## Reimplemented Protected Functions

virtual bool | event ( QEvent * e )
virtual void | mouseMoveEvent ( QMouseEvent * e )
virtual void | mousePressEvent ( QMouseEvent * e )
virtual void | mouseReleaseEvent ( QMouseEvent * e )
virtual void | paintEvent ( QPaintEvent * pe )
virtual void | resizeEvent ( QResizeEvent * e )
virtual void | sliderChange ( SliderChange change )

- 8 protected functions inherited from QAbstractSlider
- 37 protected functions inherited from QWidget
- 8 protected functions inherited from QObject
- 1 protected function inherited from QPaintDevice

### Additional Inherited Members

- 6 signals inherited from QAbstractSlider
- 1 signal inherited from QWidget
- 1 signal inherited from QObject
- 4 static public members inherited from QWidget
- 7 static public members inherited from QObject
- 1 protected slot inherited from QWidget

## Detailed Description

The QDial class provides a rounded range control (like a speedometer or potentiometer).

QDial is used when the user needs to control a value within a program-definable range, and the range either wraps around (for example, with angles measured from 0 to 359 degrees) or the dialog layout needs a square widget.

Since QDial inherits from QAbstractSlider, the dial behaves in a similar way to a slider. When wrapping() is false (the default setting) there is no real difference between a slider and a dial. They both share the same signals, slots and member functions. Which one you use depends on the expectations of your users and on the type of application.

The dial initially emits valueChanged() signals continuously while the slider is being moved; you can make it emit the signal less often by disabling the tracking property. The sliderMoved() signal is emitted continuously even when tracking is disabled.

The dial also emits sliderPressed() and sliderReleased() signals when the mouse button is pressed and released. Note that the dial's value can change without these signals being emitted since the keyboard and wheel can also be used to change the value.

Unlike the slider, QDial attempts to draw a "nice" number of notches rather than one per line step. If possible, the number of notches drawn is one per line step, but if there aren't enough pixels to draw every one, QDial will skip notches to try and draw a uniform set (e.g. by drawing every second or third notch).

Like the slider, the dial makes the QAbstractSlider functions setValue(), addLine(), subtractLine(), addPage() and subtractPage() available as slots.

The dial's keyboard interface is fairly simple: The left/up and right/down arrow keys adjust the dial's value by the defined singleStep, Page Up and Page Down by the defined pageStep, and the Home and End keys set the value to the defined minimum and maximum values.

If you are using the mouse wheel to adjust the dial, the increment value is determined by the lesser value of wheelScrollLines multipled by singleStep, and pageStep.

Dials shown in various widget styles (from left to right): Plastique, Windows XP, Macintosh.

See also QScrollBar, QSpinBox, QSlider, GUI Design Handbook: Slider, and Sliders Example.

## Property Documentation

### notchSize : const int

This property holds the current notch size.

The notch size is in range control units, not pixels, and if possible it is a multiple of singleStep() that results in an on-screen notch size near notchTarget().

By default, this property has a value of 1.

Access functions:

int | notchSize () const

See also notchTarget() and singleStep().

### notchTarget : qreal

This property holds the target number of pixels between notches.

The notch target is the number of pixels QDial attempts to put between each notch.

The actual size may differ from the target size.

The default notch target is 3.7 pixels.

Access functions:

qreal | notchTarget () const
void | setNotchTarget ( double target )

### notchesVisible : bool

This property holds whether the notches are shown.

If the property is true, a series of notches are drawn around the dial to indicate the range of values available; otherwise no notches are shown.

By default, this property is disabled.

Access functions:

bool | notchesVisible () const
void | setNotchesVisible ( bool visible )

### wrapping : bool

This property holds whether wrapping is enabled.

If true, wrapping is enabled; otherwise some space is inserted at the bottom of the dial to separate the ends of the range of valid values.

If enabled, the arrow can be oriented at any angle on the dial. If disabled, the arrow will be restricted to the upper part of the dial; if it is rotated into the space at the bottom of the dial, it will be clamped to the closest end of the valid range of values.

By default this property is false.

Access functions:

bool | wrapping () const
void | setWrapping ( bool on )

## Member Function Documentation

### QDial::QDial ( QWidget * parent = 0 )

Constructs a dial.

The parent argument is sent to the QAbstractSlider constructor.

### QDial::~QDial ()

Destroys the dial.

### bool QDial::event ( QEvent * e )`[virtual protected]`

Reimplemented from QObject::event().

### void QDial::initStyleOption ( QStyleOptionSlider * option ) const`[protected]`

Initialize option with the values from this QDial. This method is useful for subclasses when they need a QStyleOptionSlider, but don't want to fill in all the information themselves.

See also QStyleOption::initFrom().

### QSize QDial::minimumSizeHint () const`[virtual]`

Reimplemented from QWidget::minimumSizeHint().

### void QDial::mouseMoveEvent ( QMouseEvent * e )`[virtual protected]`

Reimplemented from QWidget::mouseMoveEvent().

### void QDial::mousePressEvent ( QMouseEvent * e )`[virtual protected]`

Reimplemented from QWidget::mousePressEvent().

### void QDial::mouseReleaseEvent ( QMouseEvent * e )`[virtual protected]`

Reimplemented from QWidget::mouseReleaseEvent().

### void QDial::paintEvent ( QPaintEvent * pe )`[virtual protected]`

Reimplemented from QWidget::paintEvent().

### void QDial::resizeEvent ( QResizeEvent * e )`[virtual protected]`

Reimplemented from QWidget::resizeEvent().

### QSize QDial::sizeHint () const`[virtual]`

Reimplemented from QWidget::sizeHint().

### void QDial::sliderChange ( SliderChange change )`[virtual protected]`

Reimplemented from QAbstractSlider::sliderChange().