VlcModuleDescription Class Reference

VLC module description. More...

#include <VLCQtCore/ModuleDescription.h>

Public Types

enum  Type { AudioFilter, VideoFilter }
 Module type.
 

Public Member Functions

 VlcModuleDescription (Type type, const QString &name)
 Basic constructor. More...
 
 ~VlcModuleDescription ()
 VlcModuleDescription destructor.
 
Type type () const
 Get module type. More...
 
QString name () const
 Get module name. More...
 
QString shortName () const
 Get short module readable name. More...
 
void setShortName (const QString &name)
 Set short module readable name. More...
 
QString longName () const
 Get long module readable name. More...
 
void setLongName (const QString &name)
 Set long module readable name. More...
 
QString help () const
 Get module help. More...
 
void setHelp (const QString &help)
 Set module help. More...
 

Detailed Description

VLC module description.

Constructor & Destructor Documentation

VlcModuleDescription::VlcModuleDescription ( Type  type,
const QString &  name 
)
explicit

Basic constructor.

Parameters
typemodule type
namemodule name

Member Function Documentation

QString VlcModuleDescription::help ( ) const
inline

Get module help.

Returns
module help
QString VlcModuleDescription::longName ( ) const
inline

Get long module readable name.

Returns
long module human readable name
QString VlcModuleDescription::name ( ) const
inline

Get module name.

Returns
module name
void VlcModuleDescription::setHelp ( const QString &  help)

Set module help.

Parameters
helpnew module help
void VlcModuleDescription::setLongName ( const QString &  name)

Set long module readable name.

Parameters
namelong module human readable name
void VlcModuleDescription::setShortName ( const QString &  name)

Set short module readable name.

Parameters
nameshort module human readable name
QString VlcModuleDescription::shortName ( ) const
inline

Get short module readable name.

Returns
short module human readable name
Type VlcModuleDescription::type ( ) const
inline

Get module type.

Returns
module type

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