CKlearAppConfig Class Reference

The configuration backend class Stores local configuration variables, but also saves and restores the written config files. This is the backend for the KlearConfigDialog. More...

#include <CKlearAppConfig.h>

Public Member Functions
	CKlearAppConfig ()
	Constructor.
	~CKlearAppConfig ()
	Destructor.
void	ReadConfig ()
	Read the current configuration from file.
bool	WriteConfig ()
	Write configurationdata to disk.
void	StoreServiceID (QString ChannelName)
	Stores ServiceID for given ChannelName to configuration file.
void	PrintSettings ()
	Shows all configuration data in object. Debugging function.
bool	CheckConfigfileRevision ()
	checks if the current saved configfile is usable for the currently used klear version
void	CreateNewConfigfile ()
	creates a new plain Klear configfile
QString	getKlearConfigPath () const
	Get the path to the Klear configfile.
QString	getKlearSchedulerDatafile () const
	gets the name of the schedulerdata file
QString	getKlearChannelsConf () const
	Gets the name of the channels.conf file.
QString	getDVBAdapter () const
	Gets the name of the DVB adapter device.
QString	getDVBDvr () const
	Gets the name of the DVB dvr device.
QString	getDVBDemux () const
	Gets the name of the DVB demux device.
QString	getDVBFrontend () const
	Gets the name of the DVB frontend device.
QString	getDVBMode () const
	Gets the DVB Mode (satellite, terrestric or cable).
QString	getPlaybackEngine () const
	gets current Playback engine for stream
void	setDVBAdapter (QString setDVBAdapter)
	sets the DVB Adapter to a new value
void	setDVBDvr (QString setDVBDvr)
	sets the DVB dvr to a new value
void	setDVBDemux (QString setDVBDemux)
	sets the DVB demux to a new value
void	setDVBFrontend (QString setDVBFrontend)
	sets the DVB frontend to a new value
void	setDVBMode (QString setDVBMode)
	sets the DVB mode (satellite, cable, terrestric) to a new value
void	setPlaybackEngine (QString setPlaybackEngine)
	sets current Playback engine for stream
QString	getScreenshotDir () const
	get directory where screenshot are stored
QString	getScreenshotName () const
	get the name-prefix of the screenshots
QString	getScreenshotFormat () const
	gets the screenshot format (png or bmp)
void	setScreenshotDir (QString setScreenshotDir)
	set new path to screenshot directory
void	setScreenshotName (QString setScreenshotName)
	set a new value for the screenshot directory
void	setScreenshotFormat (QString setScreenshotFormat)
	sets format of screenshot to new value (png or bmp)
QString	getRecordingDir () const
	returns the current directory where all recordings are stored
QString	getRecordingName () const
	gets the current name-prefix of recordings
QString	getRecordingFormat () const
	gets the current recording format (TS or PES)
void	setRecordingDir (QString setRecordingDir)
	set new recording directory
void	setRecordingName (QString setRecordingName)
	sets new recording name-prefix
void	setRecordingFormat (QString setRecordingFormat)
	set new value for recording format (TS or PES)
int	getApid () const
	gets current AudioPID of tuned channel
int	getVpid () const
	gets current VideoPID of tuned channel
void	setApid (int setApid)
	set the AudioPID to a new value
void	setVpid (int setVpid)
	set the VideoPID to a new value
QString	getCurrentChannel () const
	gets the current channelname
void	setCurrentChannel (QString setCurrentChannel)
	sets a new channelname
u_int	getServiceID () const
	gets the current ServiceID for current channel
int	getCurrentVolume () const
	return the current volume
void	setCurrentVolume (int setCurrentVolume)
	set a new volume
bool	getMuteSystray () const
	tells if user wants klear to mute when docked in systray
void	setMuteSystray (bool isMuteSystray)
	sets systray-muting
QString	getTimeShiftName () const
	gets the current TimeShiftrecord filename
void	setTimeShiftName (QString TimeShiftName)
	sets the current TimeShiftrecord filename
void	setWindowSize (QSize size)
	sets the current window size
QSize	getWindowSize ()
	returns the current window size
void	setMenuAlignment (QString alignment)
	sets the menu alignment to either left or right
QString	getMenuAlignment () const
	returns the current menu alignment
bool	getAutoShowOsd () const
	returns true or false depending on weater showing osd on channelswitching is on or off
void	setAutoShowOsd (bool isOsdAutoShown)
	sets showing of osd on channelswitching to ether on or off

---

Detailed Description

The configuration backend class Stores local configuration variables, but also saves and restores the written config files. This is the backend for the KlearConfigDialog.

Author:

Klear.org

---

Constructor & Destructor Documentation

CKlearAppConfig::CKlearAppConfig (   )

Constructor. Author: Marco Kraus <marco@klear.org> Exceptions: CKlearAppException

CKlearAppConfig::~CKlearAppConfig (   )

Destructor. Author: Marco Kraus <marco@klear.org>

---

Member Function Documentation

bool CKlearAppConfig::CheckConfigfileRevision (   )

checks if the current saved configfile is usable for the currently used klear version Author: Marco Kraus <marco@klear.org> Return values: bool  true if current configfile version matches for current klear version

void CKlearAppConfig::CreateNewConfigfile (   )

creates a new plain Klear configfile Author: Marco Kraus <marco@klear.org> Return values: void  no retval Exceptions: CKlearAppException

int CKlearAppConfig::getApid (   )  const

gets current AudioPID of tuned channel Author: Marco Kraus <marco@klear.org> Return values: int  current AudioPID

bool CKlearAppConfig::getAutoShowOsd (   )  const

returns true or false depending on weater showing osd on channelswitching is on or off Author: Manuel Habermann <manuel@klear.org> Return values: bool  true or false depending on weater showing osd on channelswitching is on or off

QString CKlearAppConfig::getCurrentChannel (   )  const

gets the current channelname Author: Marco Kraus <marco@klear.org> Return values: QString  current channelname

int CKlearAppConfig::getCurrentVolume (   )  const

return the current volume Author: Marco Kraus <marco@klear.org> Return values: int  current volume

void CKlearAppConfig::getDVBAdapter (   )  const

Gets the name of the DVB adapter device. Author: Marco Kraus <marco@klear.org> Return values: QString  Name of the DVBAdapter device

void CKlearAppConfig::getDVBDemux (   )  const

Gets the name of the DVB demux device. Author: Marco Kraus <marco@klear.org> Return values: QString  the name of the DVB demux device

void CKlearAppConfig::getDVBDvr (   )  const

Gets the name of the DVB dvr device. Author: Marco Kraus <marco@klear.org> Return values: Qstring  the name of the DVB dvr device

void CKlearAppConfig::getDVBFrontend (   )  const

Gets the name of the DVB frontend device. Author: Marco Kraus <marco@klear.org> Return values: QString  the name of the DVB frontend device

void CKlearAppConfig::getDVBMode (   )  const

Gets the DVB Mode (satellite, terrestric or cable). Author: Marco Kraus <marco@klear.org> Return values: QString  The DVB Mode (satellite, terrestric or cable)

void CKlearAppConfig::getKlearChannelsConf (   )  const

Gets the name of the channels.conf file. Author: Marco Kraus <marco@klear.org> Return values: QString  the name of the channels.conf file

void CKlearAppConfig::getKlearConfigPath (   )  const

Get the path to the Klear configfile. Author: Marco Kraus <marco@klear.org> Return values: QString  path to configfile

void CKlearAppConfig::getKlearSchedulerDatafile (   )  const

gets the name of the schedulerdata file Author: Marco Kraus <marco@klear.org> Return values: QString  the name of the schedulerdata file

QString CKlearAppConfig::getMenuAlignment (   )  const

returns the current menu alignment Author: Manuel Habermann <manuel@klear.org> Return values: QString  the current menu alignment

bool CKlearAppConfig::getMuteSystray (   )  const

tells if user wants klear to mute when docked in systray Author: Marco Kraus <marco@klear.org> Return values: bool  if muting in systray is wanted

void CKlearAppConfig::getPlaybackEngine (   )  const

gets current Playback engine for stream Author: Marco Kraus <marco@klear.org> Return values: QString  Playback engine name (xine, klear, mplayer, ...)

void CKlearAppConfig::getRecordingDir (   )  const

returns the current directory where all recordings are stored Author: Marco Kraus <marco@klear.org> Return values: QString  returns the current directory where all recordings are stored

void CKlearAppConfig::getRecordingFormat (   )  const

gets the current recording format (TS or PES) Author: Marco Kraus <marco@klear.org> Return values: QString  the current recording format (ts or PES)

void CKlearAppConfig::getRecordingName (   )  const

gets the current name-prefix of recordings Author: Marco Kraus <marco@klear.org> Return values: QString  current name-prefix of recordings

void CKlearAppConfig::getScreenshotDir (   )  const

get directory where screenshot are stored Author: Marco Kraus <marco@klear.org> Return values: QString  directory where screenshot are stored

void CKlearAppConfig::getScreenshotFormat (   )  const

gets the screenshot format (png or bmp) Author: Marco Kraus <marco@klear.org> Return values: QString  the screenshot format (png or bmp)

void CKlearAppConfig::getScreenshotName (   )  const

get the name-prefix of the screenshots Author: Marco Kraus <marco@klear.org> Return values: QString  the name-prefix of the screenshots

u_int CKlearAppConfig::getServiceID (   )  const

gets the current ServiceID for current channel Author: Marco Kraus <marco@klear.org> Return values: QString  current ServiceID

QString CKlearAppConfig::getTimeShiftName (   )  const

gets the current TimeShiftrecord filename Author: Manuel Habermann <manuel@klear.org>, Patric Sherif <patric@klear.org> Return values: QString  current TimeShiftName

int CKlearAppConfig::getVpid (   )  const

gets current VideoPID of tuned channel Author: Marco Kraus <marco@klear.org> Return values: int  current VideoPID of tuned channel

QSize CKlearAppConfig::getWindowSize (   )

returns the current window size Author: Manuel Habermann <manuel@klear.org>, Patric Sherif <patric@klear.org> Return values: QSize  current window size

void CKlearAppConfig::PrintSettings (   )

Shows all configuration data in object. Debugging function. Author: Marco Kraus <marco@klear.org> Return values: void  no return value

void CKlearAppConfig::ReadConfig (   )

Read the current configuration from file. Author: Marco Kraus <marco@klear.org> Return values: void  no retval Exceptions: CKlearAppException

void CKlearAppConfig::setApid (  int  setApid  )

set the AudioPID to a new value Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setApid  new AudioPID

void CKlearAppConfig::setAutoShowOsd (  bool  isOsdAutoShown  )

sets showing of osd on channelswitching to ether on or off Author: Manuel Habermann <manuel@klear.org> Return values: void  no return value Parameters: isOsdAutoShown  true or false enables or disables showing osd on channelswitching

void CKlearAppConfig::setCurrentChannel (  QString  setCurrentChannel  )

sets a new channelname Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setCurrentChannel  set the channelname to new value

void CKlearAppConfig::setCurrentVolume (  int  setCurrentVolume  )

set a new volume Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setCurrentVolume  new volume

void CKlearAppConfig::setDVBAdapter (  QString  setDVBAdapter  )

sets the DVB Adapter to a new value Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setDVBAdapter  name of the new adapter device

void CKlearAppConfig::setDVBDemux (  QString  setDVBDemux  )

sets the DVB demux to a new value Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setDVBDemux  name of the new demux device

void CKlearAppConfig::setDVBDvr (  QString  setDVBDvr  )

sets the DVB dvr to a new value Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setDVBDvr  name of the new DVR device

void CKlearAppConfig::setDVBFrontend (  QString  setDVBFrontend  )

sets the DVB frontend to a new value Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setDVBFrontend  name of the new frontend device

void CKlearAppConfig::setDVBMode (  QString  setDVBMode  )

sets the DVB mode (satellite, cable, terrestric) to a new value Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setDVBMode  name of the DVB mode

void CKlearAppConfig::setMenuAlignment (  QString  alignment  )

sets the menu alignment to either left or right Author: Manuel Habermann <manuel@klear.org> Return values: void  no return value Parameters: alignment  the new alignment

void CKlearAppConfig::setMuteSystray (  bool  isMuteSystray  )

sets systray-muting Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: isMuteSystray  if systray-mute is enabled

void CKlearAppConfig::setPlaybackEngine (  QString  setPlaybackEngine  )

sets current Playback engine for stream Author: Marco Kraus <marco@klear.org> Return values: void  no retval

void CKlearAppConfig::setRecordingDir (  QString  setRecordingDir  )

set new recording directory Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setRecordingDir  ne wvalue for recording directory

void CKlearAppConfig::setRecordingFormat (  QString  setRecordingFormat  )

set new value for recording format (TS or PES) Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setRecordingFormat  sets new value for recording format (TS or PES)

void CKlearAppConfig::setRecordingName (  QString  setRecordingName  )

sets new recording name-prefix Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setRecordingName  set new value for recording name-prefix

void CKlearAppConfig::setScreenshotDir (  QString  setScreenshotDir  )

set new path to screenshot directory Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setScreenshotDir  set new path to screenshot directory

void CKlearAppConfig::setScreenshotFormat (  QString  setScreenshotFormat  )

sets format of screenshot to new value (png or bmp) Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setScreenshotFormat  sets format of screenshot to new value (png or bmp)

void CKlearAppConfig::setScreenshotName (  QString  setScreenshotName  )

set a new value for the screenshot directory Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setScreenshotName  new Value for directoryname

void CKlearAppConfig::setTimeShiftName (  QString  TimeShiftName  )

sets the current TimeShiftrecord filename Author: Manuel Habermann <manuel@klear.org>, Patric Sherif <patric@klear.org> Return values: void  no return value Parameters: TimeShiftName  set the TimeShiftName to new value

void CKlearAppConfig::setVpid (  int  setVpid  )

set the VideoPID to a new value Author: Marco Kraus <marco@klear.org> Return values: void  no return value Parameters: setVpid  new VideoPID

void CKlearAppConfig::setWindowSize (  QSize  size  )

sets the current window size Author: Manuel Habermann <manuel@klear.org>, Patric Sherif <patric@klear.org> Return values: void  no return value Parameters: size  the new window size value

void CKlearAppConfig::StoreServiceID (  QString  ChannelName  )

Stores ServiceID for given ChannelName to configuration file. Author: Marco Kraus <marco@klear.org> Return values: void  no return value Exceptions: CKlearAppErrorException

void CKlearAppConfig::WriteConfig (   )

Write configurationdata to disk. Author: Marco Kraus <marco@klear.org> Return values: void  no return value Exceptions: CKlearAppException

---

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

• cvs/klear/src/App/CKlearAppConfig.h

---