Visual Class Reference

The Visual class provides the base interface class of visualizations. More...

#include <visual.h>

List of all members.

Signals

void closedByUser ()

Public Member Functions

 Visual (QWidget *parent)
virtual ~Visual ()
virtual void add (unsigned char *data, qint64 size, int chan)=0
virtual void clear ()=0
QMutex * mutex ()

Static Public Member Functions

static QList< VisualFactory * > * factories ()
static QString file (VisualFactory *factory)
static void setEnabled (VisualFactory *factory, bool enable=true)
static bool isEnabled (VisualFactory *factory)
static void add (Visual *visual)
static void remove (Visual *)
static void initialize (QWidget *parent, QObject *receiver=0, const char *member=0)
static QList< Visual * > * visuals ()
static void showSettings (VisualFactory *factory, QWidget *parent)

Protected Member Functions

virtual void closeEvent (QCloseEvent *event)


Detailed Description

The Visual class provides the base interface class of visualizations.

Author:
Ilya Kotov <forkotov02@hotmail.ru>

Constructor & Destructor Documentation

Visual ( QWidget *  parent  ) 

Object contsructor.

Parameters:
parent Parent object.

virtual ~Visual (  )  [virtual]

Destructor.


Member Function Documentation

static void add ( Visual visual  )  [static]

Adds external visualization visual.

virtual void add ( unsigned char *  data,
qint64  size,
int  chan 
) [pure virtual]

Adds data for visualization. Subclass should reimplement this function.

Parameters:
data Audio data.
size Size of audio data.
chan Number of channels.

virtual void clear (  )  [pure virtual]

Resets visual plugin buffers and widgets. Subclass should reimplement this function.

void closedByUser (  )  [signal]

Emitted when visual widget is closed by user.

virtual void closeEvent ( QCloseEvent *  event  )  [protected, virtual]

QWidget's close event. Reimplementation should call base function.

Parameters:
event QCloseEvent insatance.

static QList<VisualFactory*>* factories (  )  [static]

Returns a list of visual factories.

static QString file ( VisualFactory factory  )  [static]

Returns plugin file path.

Parameters:
factory Visual plugin factory.

static void initialize ( QWidget *  parent,
QObject *  receiver = 0,
const char *  member = 0 
) [static]

Prepares visual plugins for usage.

Parameters:
parent Parent widget.
receiver Receiver object.
member A slot to receive changes of active visualizations list.

static bool isEnabled ( VisualFactory factory  )  [static]

Returns true if visual plugin is enabled, otherwise returns false

Parameters:
factory Effect plugin factory.

QMutex* mutex (  ) 

Returns mutex pointer.

static void remove ( Visual  )  [static]

Removes external visualization visual.

static void setEnabled ( VisualFactory factory,
bool  enable = true 
) [static]

Sets whether the visual plugin is enabled.

Parameters:
factory Visual plugin factory.
enable Plugin enable state (true - enable, false - disable)

static void showSettings ( VisualFactory factory,
QWidget *  parent 
) [static]

Shows configuration dialog and updates settings automatically.

Parameters:
factory Visual plugin factory.
parent Parent widget.

static QList<Visual *>* visuals (  )  [static]

Returns a pointer to a list of created visual objects.


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

Generated on Thu Nov 10 20:39:11 2011 for Qmmp by  doxygen 1.5.9