Home · All Classes · Main Classes · Deprecated
Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Properties

MSlider Class Reference

MSeekBar is a special type of MSlider used for displaying playback status for multimedia content. More...

Inheritance diagram for MSlider:
Inheritance graph
[legend]
Collaboration diagram for MSlider:
Collaboration graph
[legend]

List of all members.

Public Slots

void setMinimum (int minimum)
void setMaximum (int maximum)
void setRange (int minimum, int maximum)
void setSteps (int steps)
virtual void setValue (int value)

Signals

void valueChanged (int newValue)
void sliderPressed ()
void sliderReleased ()

Public Member Functions

 MSlider (QGraphicsItem *parent=0, const QString &viewType=QString())
virtual ~MSlider ()
int minimum () const
int maximum () const
int steps () const
int value () const
void setOrientation (Qt::Orientation direction)
Qt::Orientation orientation () const
void setMinLabelIconID (const QString &iconID)
void setMinLabelVisible (bool visible)
void setMinLabel (const QString &text)
void setMaxLabelIconID (const QString &iconID)
void setMaxLabelVisible (bool visible)
void setMaxLabel (const QString &text)
void setHandleLabelIconID (const QString &iconID)
void setHandleLabelVisible (bool visible)
void setHandleLabel (const QString &text)
QString minLabelIconID () const
QString minLabelText () const
QString maxLabelIconID () const
QString maxLabelText () const
QString handleLabelIconID () const
QString handleLabelText () const
bool isMinLabelVisible () const
bool isMaxLabelVisible () const
bool isHandleLabelVisible () const
void setState (MSliderModel::SliderState state)
MSliderModel::SliderState state () const

Protected Slots

virtual void updateData (const QList< const char * > &modifications)

Protected Member Functions

 MSlider (MSliderPrivate *dd, MSliderModel *model, QGraphicsItem *parent, const QString &viewType=QString())

Properties

MSliderModel::SliderState state
Qt::Orientation orientation
QString minLabelIconID
QString maxLabelIconID
QString handleLabelIconID
QString minLabelText
QString maxLabelText
QString handleLabelText
bool minLabelVisible
bool maxLabelVisible
bool handleLabelVisible
int minimum
int maximum
int steps
int value

Detailed Description

MSeekBar is a special type of MSlider used for displaying playback status for multimedia content.

MSlider is used for continuous set of values, among which user can choose one value.

Overview

Seekbar includes received and non-received parts to visualize e.g. streamed/buffered content.

Example codes

Seekbar load new content when seekbar value goes out of loadedcontent range:

            //connect outOfLoadedContentRange signal to playerOutOfLoadedContentRange local slot
            QObject::connect(playerSeekBar, SIGNAL(outOfLoadedContentRange()), this, SLOT(playerOutOfLoadedContentRange()));
            void SeekBarTesterPage::playerOutOfLoadedContentRange()
            {
                loadedContentMinimum = playerSeekBar->value();
                loadedContentMaximum = playerSeekBar->value();

                playerSeekBar->setLoadedContentMinimum(loadedContentMinimum);
                playerSeekBar->setLoadedContentMaximum(loadedContentMaximum);
            }
See also:
MSeekBarModel MSliderStyle

Overview

Slider defines a given value range from where user can choose one given value by moving the slider thumb to required position along the slider groove. Sliders are interactive elements.

MSliders can be oriented horizontally or vertically, and they support left-to-right or right-to-left UI direction.

Sliders have minimum and maximum labels located at the 2 endings of slider groove and thumb label located at thumb position.

Usage guidelines

MSliders allow setting and getting of minimum and maximum values (value range) and current value and setting of number of steps.

MSlider labels can be visible or hidden.

MSliders can have margins and paddings with thickness defined in CSS.

Example codes

Slider value displayed in handle indicator:

            //connect valueChanged signal to modifySliderValue local slot
            QObject::connect(slider, SIGNAL(valueChanged(int)), this, SLOT(modifySliderValue(int)));

            //modifySliderValue
            void SliderTesterPage::modifySliderValue(int newValue)
            {
                slider->setHandleLabel(QString::number(newValue));
            }
See also:
MSliderModel MSliderStyle

Definition at line 68 of file corelib/widgets/mslider.h.


Constructor & Destructor Documentation

MSlider::MSlider ( QGraphicsItem parent = 0,
const QString viewType = QString() 
) [explicit]

Constructs a slider.

Parameters:
parent Parent m widget
viewType Optional view type

Definition at line 59 of file mslider.cpp.

    : MWidgetController(new MSliderPrivate(), new MSliderModel, parent)
{
    setViewType(viewType);
}

Here is the call graph for this function:

MSlider::~MSlider (  )  [virtual]

Destructor.

Definition at line 71 of file mslider.cpp.

{
}

MSlider::MSlider ( MSliderPrivate *  dd,
MSliderModel model,
QGraphicsItem parent,
const QString viewType = QString() 
) [protected]

Constructs a slider with private class and model.

Parameters:
dd Private class instance
model Model instance
parent Parent m widget
viewType Optional view type

Definition at line 65 of file mslider.cpp.

    : MWidgetController(dd, model, parent)
{
    setViewType(viewType);
}

Here is the call graph for this function:


Member Function Documentation

QString MSlider::handleLabelIconID (  )  const

Gets handle indicator image identifier.

Returns:
handle indicator image identifier
QString MSlider::handleLabelText (  )  const

Gets handle indicator text.

Returns:
handle indicator text
bool MSlider::isHandleLabelVisible (  )  const

Returns true if handle indicator is visible and false if is not visible.

Returns:
handle indicator visibility

Definition at line 279 of file mslider.cpp.

{
    return model()->handleLabelVisible();
}

Here is the call graph for this function:

bool MSlider::isMaxLabelVisible (  )  const

Returns true if maximum indicator is visible and false if is not visible.

Returns:
maximum indicator visibility

Definition at line 274 of file mslider.cpp.

{
    return model()->maxLabelVisible();
}

Here is the call graph for this function:

bool MSlider::isMinLabelVisible (  )  const

Returns true if minimum indicator is visible and false if it is not visible.

Returns:
minimum indicator visibility

Definition at line 269 of file mslider.cpp.

{
    return model()->minLabelVisible();
}

Here is the call graph for this function:

int MSlider::maximum (  )  const

Gets maximum value in slider value range.

Returns:
maximum value in slider value range
QString MSlider::maxLabelIconID (  )  const

Gets maximum indicator image identifier.

Returns:
maximum indicator image identifier
QString MSlider::maxLabelText (  )  const

Gets maximum indicator text.

Returns:
maximum indicator text
int MSlider::minimum (  )  const

Gets minimum value in slider value range.

Returns:
minimum value in slider value range
QString MSlider::minLabelIconID (  )  const

Gets minimum indicator image identifier.

Returns:
minimum indicator image identifier
QString MSlider::minLabelText (  )  const

Gets minimum indicator text.

Returns:
minimum indicator text
Qt::Orientation MSlider::orientation (  )  const

Gets slider current orientation.

Returns:
current orientation of the slider (Qt::Horizontal for horizontal sliders,
Qt::Vertical for vertical sliders)
void MSlider::setHandleLabel ( const QString text  ) 

Sets handle indicator text.

Parameters:
text The text string

Definition at line 234 of file mslider.cpp.

{
    model()->setHandleLabelText(text);
}

Here is the call graph for this function:

void MSlider::setHandleLabelIconID ( const QString iconID  ) 

Sets thumb indicator image identifier.

Parameters:
iconID Image identifier

Definition at line 224 of file mslider.cpp.

{
    model()->setHandleLabelIcon(iconID);
}

Here is the call graph for this function:

void MSlider::setHandleLabelVisible ( bool  visible  ) 

Sets handle indicator visibility.

Parameters:
visible True to set handle indicator visible false to set it invisible

Definition at line 229 of file mslider.cpp.

{
    model()->setHandleLabelVisible(visible);
}

Here is the call graph for this function:

void MSlider::setMaximum ( int  maximum  )  [slot]

Sets the new maximum value for slider.

Parameters:
maximum value in slider value range

Definition at line 90 of file mslider.cpp.

{
    Q_D(MSlider);

    model()->setMaximum(maximum);

    int tmpValue = d->adjustValue(model()->minimum(),
                                  model()->value(),
                                  model()->maximum(),
                                  model()->steps());

    if (tmpValue != model()->value())
        model()->setValue(tmpValue);
}

Here is the call graph for this function:

void MSlider::setMaxLabel ( const QString text  ) 

Sets maximum indicator text.

Parameters:
text Maximum indicator text

Definition at line 219 of file mslider.cpp.

{
    model()->setMaxLabelText(text);
}

Here is the call graph for this function:

void MSlider::setMaxLabelIconID ( const QString iconID  ) 

Sets maximum indicator image identifier.

Parameters:
text Maximum indicator image identifier

Definition at line 209 of file mslider.cpp.

{
    model()->setMaxLabelIcon(iconID);
}

Here is the call graph for this function:

void MSlider::setMaxLabelVisible ( bool  visible  ) 

Sets maximum indicator visibility.

Parameters:
visible True if maximum indicator is visible false if it is not visible.

Definition at line 214 of file mslider.cpp.

{
    model()->setMaxLabelVisible(visible);
}

Here is the call graph for this function:

void MSlider::setMinimum ( int  minimum  )  [slot]

Sets the slider's minimum value.

Parameters:
minimum value in slider value range

Definition at line 75 of file mslider.cpp.

{
    Q_D(MSlider);

    model()->setMinimum(minimum);

    int tmpValue = d->adjustValue(model()->minimum(),
                                  model()->value(),
                                  model()->maximum(),
                                  model()->steps());

    if (tmpValue != model()->value())
        model()->setValue(tmpValue);
}

Here is the call graph for this function:

void MSlider::setMinLabel ( const QString text  ) 

Sets minimum indicator text.

Parameters:
text Minimum indicator text

Definition at line 204 of file mslider.cpp.

{
    model()->setMinLabelText(text);
}

Here is the call graph for this function:

void MSlider::setMinLabelIconID ( const QString iconID  ) 

Sets minimum indicator image identifier.

Parameters:
text Minimum indicator image identifier

Definition at line 194 of file mslider.cpp.

{
    model()->setMinLabelIcon(iconID);
}

Here is the call graph for this function:

void MSlider::setMinLabelVisible ( bool  visible  ) 

Sets minimum indicator visibility.

Parameters:
visible True if minimum indicator is visible false if it is not visible.

Definition at line 199 of file mslider.cpp.

{
    model()->setMinLabelVisible(visible);
}

Here is the call graph for this function:

void MSlider::setOrientation ( Qt::Orientation  direction  ) 

Sets slider orientation.

Parameters:
direction Slider orientation (Qt::Horizontal for horizontal sliders,
Qt::Vertical for vertical sliders)

Definition at line 184 of file mslider.cpp.

{
    model()->setOrientation(orientation);
}

Here is the call graph for this function:

void MSlider::setRange ( int  minimum,
int  maximum 
) [slot]

Sets the value range for slider.

Parameters:
minimum value in slider value range
maximum value in slider value range

Definition at line 105 of file mslider.cpp.

{
    Q_D(MSlider);

    setMaximum(maximum);
    setMinimum(minimum);

    int tmpValue = d->adjustValue(model()->minimum(),
                                  model()->value(),
                                  model()->maximum(),
                                  model()->steps());

    if (tmpValue != model()->value())
        model()->setValue(tmpValue);
}

Here is the call graph for this function:

void MSlider::setState ( MSliderModel::SliderState  state  ) 

Set slider state programmatically.

Parameters:
state going to be set

Definition at line 284 of file mslider.cpp.

{
    model()->setState(state);
    update();
}

Here is the call graph for this function:

void MSlider::setSteps ( int  steps  )  [slot]

Set number of value steps for slider.

Parameters:
value steps to be set (for 0 there will not be steps)
If there are steps slider values are limited to integer multiples of step values.

Definition at line 121 of file mslider.cpp.

{
    Q_D(MSlider);

    model()->setSteps(steps);

    int tmpValue = d->adjustValue(model()->minimum(),
                                  model()->value(),
                                  model()->maximum(),
                                  model()->steps());

    if (tmpValue != model()->value())
        model()->setValue(tmpValue);
}

Here is the call graph for this function:

void MSlider::setValue ( int  value  )  [virtual, slot]

Set a new value for slider.

Parameters:
value a value to be set (value is bounded into slider value range)

Reimplemented in MSeekBar.

Definition at line 136 of file mslider.cpp.

{
    Q_D(MSlider);
    int tmpValue = d->adjustValue(model()->minimum(),
                                  value,
                                  model()->maximum(),
                                  model()->steps());
    if (tmpValue != model()->value())
        model()->setValue(tmpValue);
}

Here is the call graph for this function:

void MSlider::sliderPressed (  )  [signal]

Emitted when the user presses the slider.

void MSlider::sliderReleased (  )  [signal]

Emitted when the user releases the slider.

MSliderModel::SliderState MSlider::state (  )  const

Returns slider state.

Returns:
slider state
int MSlider::steps (  )  const

Gets number of values steps.

Returns:
number of value steps
void MSlider::updateData ( const QList< const char * > &  modifications  )  [protected, virtual, slot]

Signal emitted when some.

See also:
MModel attribute is modified.

Reimplemented from MWidgetController.

Definition at line 147 of file mslider.cpp.

{
    MWidgetController::updateData(modifications);

    const char *member;
    foreach(member, modifications) {
        if (member == MSliderModel::Value) {
            emit valueChanged(model()->value());
        } else if (member == MSliderModel::State) {
            if (model()->state() == MSliderModel::Pressed)
                emit sliderPressed();
            else
                emit sliderReleased();
        }
    }
}

Here is the call graph for this function:

int MSlider::value (  )  const

Gets slider value.

Returns:
slider value
void MSlider::valueChanged ( int  newValue  )  [signal]

Signal emitted when slider value is changed.

Parameters:
newValue new value

Property Documentation

MSlider::handleLabelIconID [read, write]

Slider handle indicator image identifier.

See MSliderModel::handleLabelIcon for details.

Definition at line 111 of file corelib/widgets/mslider.h.

MSlider::handleLabelText [read, write]

Slider handle indicator text.

See MSliderModel::handleLabelText for details.

Definition at line 135 of file corelib/widgets/mslider.h.

MSlider::handleLabelVisible [read, write]

Slider handle indicator visibility, when slider is pressed (handle indicator is always hidden when slider is released).

See MSliderModel::handleLabelVisible for details.

Definition at line 159 of file corelib/widgets/mslider.h.

MSlider::maximum [read, write]

Maximum value in slider value range.

See MSliderModel::maximum for details.

Definition at line 175 of file corelib/widgets/mslider.h.

MSlider::maxLabelIconID [read, write]

Slider maximum indicator image identifier.

See MSliderModel::maxLabelIcon for details.

Definition at line 103 of file corelib/widgets/mslider.h.

MSlider::maxLabelText [read, write]

Slider maximum indicator text.

See MSliderModel::maxLabelText for details.

Definition at line 127 of file corelib/widgets/mslider.h.

MSlider::maxLabelVisible [read, write]

Slider maximum indicator visibility.

See MSliderModel::maxLabelVisible for details.

Definition at line 151 of file corelib/widgets/mslider.h.

MSlider::minimum [read, write]

Minimum value in slider value range.

See MSliderModel::minimum for details.

Definition at line 167 of file corelib/widgets/mslider.h.

MSlider::minLabelIconID [read, write]

Slider minimum indicator image identifier.

See MSliderModel::minLabelIcon for details.

Definition at line 95 of file corelib/widgets/mslider.h.

MSlider::minLabelText [read, write]

Slider minimum indicator text.

See MSliderModel::minLabelText for details.

Definition at line 119 of file corelib/widgets/mslider.h.

MSlider::minLabelVisible [read, write]

Slider minimum indicator visibility.

See MSliderModel::minLabelVisible for details.

Definition at line 143 of file corelib/widgets/mslider.h.

MSlider::orientation [read, write]

Slider orientation (horizontal or vertical).

See MSliderModel::orientation for details.

Definition at line 87 of file corelib/widgets/mslider.h.

MSlider::state [read, write]

Slider state (pressed or released).

See MSliderModel::state for details.

Definition at line 79 of file corelib/widgets/mslider.h.

MSlider::steps [read, write]

Values steps in slider value range.

See MSliderModel::steps for details.

Definition at line 183 of file corelib/widgets/mslider.h.

MSlider::value [read, write]

Slider value.

See MSliderModel::value for details.

Definition at line 191 of file corelib/widgets/mslider.h.


Copyright © 2010 Nokia Corporation Generated on Thu Nov 4 2010 18:14:26 (PDT)
Doxygen 1.7.1
MeeGo Touch