VlcWidgetVolumeSlider Class Reference

Volume slider widget. More...

#include <VLCQtWidgets/WidgetVolumeSlider.h>

Public Slots

bool mute () const
 Mute status. More...
 
void setMute (bool enabled)
 Toggle mute. More...
 
void setVolume (int volume)
 Set volume for current media. More...
 
int volume () const
 Get volume for current media. More...
 
void volumeControl (bool up)
 Decreases or increases volume for 1, depending on the parameter. More...
 
void volumeDown ()
 Decreases volume for 1. More...
 
void volumeUp ()
 Increases volume for 1. More...
 

Signals

void newVolume (int volume)
 Signal for new volume. More...
 

Public Member Functions

 VlcWidgetVolumeSlider (VlcMediaPlayer *player, QWidget *parent=0)
 VlcWidgetVolumeSlider constructor. More...
 
 VlcWidgetVolumeSlider (QWidget *parent=0)
 VlcWidgetVolumeSlider constructor. More...
 
 ~VlcWidgetVolumeSlider ()
 VlcWidgetVolumeSlider destructor.
 
void setMediaPlayer (VlcMediaPlayer *player)
 Set media player if initialised without it. More...
 

Protected Member Functions

void mousePressEvent (QMouseEvent *event)
 Mouse press event override. More...
 
void mouseReleaseEvent (QMouseEvent *event)
 Mouse release event override. More...
 

Detailed Description

Volume slider widget.

This is one of VLC-Qt GUI classes. It provides graphical volume control and also visual display of current volume.

Constructor & Destructor Documentation

VlcWidgetVolumeSlider::VlcWidgetVolumeSlider ( VlcMediaPlayer player,
QWidget *  parent = 0 
)
explicit

VlcWidgetVolumeSlider constructor.

Parameters
playermedia player
parentvolume slider's parent GUI widget
VlcWidgetVolumeSlider::VlcWidgetVolumeSlider ( QWidget *  parent = 0)
explicit

VlcWidgetVolumeSlider constructor.

Parameters
parentvolume slider's parent GUI widget

Member Function Documentation

void VlcWidgetVolumeSlider::mousePressEvent ( QMouseEvent *  event)
protected

Mouse press event override.

Parameters
eventmouse event
void VlcWidgetVolumeSlider::mouseReleaseEvent ( QMouseEvent *  event)
protected

Mouse release event override.

Parameters
eventmouse event
bool VlcWidgetVolumeSlider::mute ( ) const
slot

Mute status.

Returns
bool current mute status
void VlcWidgetVolumeSlider::newVolume ( int  volume)
signal

Signal for new volume.

Parameters
volumenew volume
void VlcWidgetVolumeSlider::setMediaPlayer ( VlcMediaPlayer player)

Set media player if initialised without it.

Parameters
playermedia player
void VlcWidgetVolumeSlider::setMute ( bool  enabled)
slot

Toggle mute.

Parameters
enablednew mutte status
void VlcWidgetVolumeSlider::setVolume ( int  volume)
slot

Set volume for current media.

Parameters
volumenumber from 0 to 200
int VlcWidgetVolumeSlider::volume ( ) const
slot

Get volume for current media.

Returns
volume number from 0 to 200
void VlcWidgetVolumeSlider::volumeControl ( bool  up)
slot

Decreases or increases volume for 1, depending on the parameter.

Limits from 0 to 200 apply to this function.

Parameters
upif true increases the volume
void VlcWidgetVolumeSlider::volumeDown ( )
inlineslot

Decreases volume for 1.

This function is provided for convenience.

See also
volumeControl()
void VlcWidgetVolumeSlider::volumeUp ( )
inlineslot

Increases volume for 1.

This function is provided for convenience.

See also
volumeControl()

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