KVIrc 5.2.6
Developer APIs
KviConfigurationFile Class Reference

#include <KviConfigurationFile.h>

+ Inheritance diagram for KviConfigurationFile:

Public Types

enum  FileMode { Read = 1 , Write = 2 , ReadWrite = 3 }
 

Public Member Functions

void clear ()
 
void clearDirtyFlag ()
 
void clearGroup (const QString &szGroup)
 
void clearKey (const QString &szKey)
 
KviPointerHashTable< QString, KviConfigurationFileGroup > * dict ()
 
bool dirty ()
 
const QString & fileName ()
 
const QString & group ()
 
unsigned int groupsCount ()
 
bool hasGroup (const QString &szGroup)
 
bool hasKey (const QString &szKey)
 
 KviConfigurationFile (const char *filename, FileMode f, bool bLocal8Bit=false)
 
 KviConfigurationFile (const QString &filename, FileMode f, bool bLocal8Bit=false)
 
void preserveEmptyGroups (bool bPreserve)
 
bool readBoolEntry (const QString &szKey, bool bTrue)
 
char readCharEntry (const QString &szKey, char iDefault)
 
QColor readColorEntry (const QString &szKey, const QColor &clr)
 
QString readEntry (const QString &szKey, const QString &szDefault=QString())
 
QFont readFontEntry (const QString &szKey, const QFont &fnt)
 
int readIntEntry (const QString &szKey, int iDefault)
 
QList< int > readIntListEntry (const QString &, const QList< int > &list)
 
QString readKviCStringEntry (const QString &szKey, const KviCString &szDefault)
 
KviMessageTypeSettings readMsgTypeEntry (const QString &szKey, const KviMessageTypeSettings &msgDef)
 
bool readOnly ()
 
KviPixmap readPixmapEntry (const QString &szKey, const KviPixmap &pixDef)
 
QRect readRectEntry (const QString &szKey, const QRect &rct)
 
QStringList readStringListEntry (const QString &szKey, const QStringList &list=QStringList())
 
unsigned char readUCharEntry (const QString &szKey, unsigned char iDefault)
 
unsigned int readUIntEntry (const QString &szKey, unsigned int iDefault)
 
unsigned short int readUShortEntry (const QString &szKey, unsigned short int usDefault)
 
bool saveIfDirty ()
 
void setGroup (const QString &szGroup)
 
void setReadOnly (bool bReadOnly)
 
void setSavePath (const QString &savePath)
 
bool sync ()
 
void writeEntry (const QString &szKey, bool bTrue)
 
void writeEntry (const QString &szKey, char iValue)
 
void writeEntry (const QString &szKey, const char *szValue)
 
void writeEntry (const QString &szKey, const KviMessageTypeSettings &msg)
 
void writeEntry (const QString &szKey, const KviPixmap &pixmap)
 
void writeEntry (const QString &szKey, const QColor &clr)
 
void writeEntry (const QString &szKey, const QList< int > &list)
 
void writeEntry (const QString &szKey, const QRect &rct)
 
void writeEntry (const QString &szKey, const QString &szValue)
 
void writeEntry (const QString &szKey, const QStringList &list)
 
void writeEntry (const QString &szKey, int iValue)
 
void writeEntry (const QString &szKey, QFont &fnt)
 
void writeEntry (const QString &szKey, unsigned char iValue)
 
void writeEntry (const QString &szKey, unsigned int iValue)
 
void writeEntry (const QString &szKey, unsigned short int usValue)
 
 ~KviConfigurationFile ()
 

Static Public Member Functions

static void getFontProperties (KviCString &buffer, QFont *fnt)
 
static void setFontProperties (KviCString &str, QFont *fnt)
 

Private Member Functions

KviConfigurationFileGroupgetCurrentGroup ()
 
bool load ()
 
bool save ()
 

Private Attributes

bool m_bDirty
 
bool m_bLocal8Bit
 
bool m_bPreserveEmptyGroups
 
bool m_bReadOnly
 
KviPointerHashTable< QString, KviConfigurationFileGroup > * m_pDict
 
QString m_szFileName
 
QString m_szGroup
 
QString m_szStrBuffer
 

Member Enumeration Documentation

◆ FileMode

Enumerator
Read 
Write 
ReadWrite 

Constructor & Destructor Documentation

◆ KviConfigurationFile() [1/2]

KviConfigurationFile::KviConfigurationFile ( const QString & filename,
FileMode f,
bool bLocal8Bit = false )

◆ KviConfigurationFile() [2/2]

KviConfigurationFile::KviConfigurationFile ( const char * filename,
FileMode f,
bool bLocal8Bit = false )

◆ ~KviConfigurationFile()

KviConfigurationFile::~KviConfigurationFile ( )

References m_bDirty, m_pDict, and save().

Member Function Documentation

◆ clear()

◆ clearDirtyFlag()

void KviConfigurationFile::clearDirtyFlag ( )
inline

◆ clearGroup()

void KviConfigurationFile::clearGroup ( const QString & szGroup)

◆ clearKey()

void KviConfigurationFile::clearKey ( const QString & szKey)

◆ dict()

◆ dirty()

bool KviConfigurationFile::dirty ( )
inline

Referenced by config_kvs_cmd_close().

◆ fileName()

const QString & KviConfigurationFile::fileName ( )
inline

◆ getCurrentGroup()

◆ getFontProperties()

void KviConfigurationFile::getFontProperties ( KviCString & buffer,
QFont * fnt )
static

◆ group()

◆ groupsCount()

unsigned int KviConfigurationFile::groupsCount ( )
inline

◆ hasGroup()

◆ hasKey()

bool KviConfigurationFile::hasKey ( const QString & szKey)

◆ load()

◆ preserveEmptyGroups()

void KviConfigurationFile::preserveEmptyGroups ( bool bPreserve)
inline

◆ readBoolEntry()

◆ readCharEntry()

char KviConfigurationFile::readCharEntry ( const QString & szKey,
char iDefault )

◆ readColorEntry()

◆ readEntry()

◆ readFontEntry()

QFont KviConfigurationFile::readFontEntry ( const QString & szKey,
const QFont & fnt )

◆ readIntEntry()

◆ readIntListEntry()

◆ readKviCStringEntry()

QString KviConfigurationFile::readKviCStringEntry ( const QString & szKey,
const KviCString & szDefault )
inline

References KviCString::ptr().

◆ readMsgTypeEntry()

KviMessageTypeSettings KviConfigurationFile::readMsgTypeEntry ( const QString & szKey,
const KviMessageTypeSettings & msgDef )

◆ readOnly()

bool KviConfigurationFile::readOnly ( )
inline

◆ readPixmapEntry()

KviPixmap KviConfigurationFile::readPixmapEntry ( const QString & szKey,
const KviPixmap & pixDef )

◆ readRectEntry()

QRect KviConfigurationFile::readRectEntry ( const QString & szKey,
const QRect & rct )

◆ readStringListEntry()

QStringList KviConfigurationFile::readStringListEntry ( const QString & szKey,
const QStringList & list = QStringList() )

◆ readUCharEntry()

unsigned char KviConfigurationFile::readUCharEntry ( const QString & szKey,
unsigned char iDefault )

◆ readUIntEntry()

◆ readUShortEntry()

unsigned short int KviConfigurationFile::readUShortEntry ( const QString & szKey,
unsigned short int usDefault )

◆ save()

◆ saveIfDirty()

bool KviConfigurationFile::saveIfDirty ( )

References m_bDirty, and save().

Referenced by KviApplication::saveOptions().

◆ setFontProperties()

void KviConfigurationFile::setFontProperties ( KviCString & str,
QFont * fnt )
static

◆ setGroup()

void KviConfigurationFile::setGroup ( const QString & szGroup)

References getCurrentGroup(), hasGroup(), m_bDirty, m_bPreserveEmptyGroups, and m_szGroup.

Referenced by ConfigDialog::acceptbtn(), KviMainWindow::addWindow(), KviTheme::apply(), config_kvs_cmd_setsection(), config_set_section(), ConfigDialog::ConfigDialog(), KviMircServersIniImport::doImport(), ListWindow::exportList(), KviApplication::findLocalKvircDirectory(), KviIrcServerDataBase::importFromMircIni(), ListWindow::importList(), KviActionManager::load(), KviAvatarCache::load(), KviCustomToolBarManager::load(), KviIrcServerDataBase::load(), KviKvsAliasManager::load(), KviKvsPopupManager::load(), KviKvsScriptAddon::load(), KviMediaManager::load(), KviRegisteredUserDataBase::load(), KviSharedFilesManager::load(), KviStatusBar::load(), KviTextIconManager::load(), KviThemeInfo::load(), KviUserIdentityManager::load(), OptionsWidget_messageColors::load(), KviKvsEventManager::loadAppEvents(), ClassEditorWidget::loadNotBuiltClasses(), KviKvsEventManager::loadRawEvents(), KviActionManager::save(), KviAvatarCache::save(), KviCustomToolBarDescriptor::save(), KviCustomToolBarManager::save(), KviIrcServerDataBase::save(), KviKvsAliasManager::save(), KviKvsPopupManager::save(), KviKvsScriptAddon::save(), KviKvsScriptAddonManager::save(), KviKvsUserAction::save(), KviMediaManager::save(), KviRegisteredChannelDataBase::save(), KviRegisteredUserDataBase::save(), KviSharedFilesManager::save(), KviStatusBar::save(), KviTextIconManager::save(), KviTheme::save(), KviThemeInfo::save(), KviUserIdentity::save(), KviUserIdentityManager::save(), OptionsWidget_messageColors::save(), KviKvsEventManager::saveAppEvents(), KviApplication::saveKvircDirectory(), ClassEditorWidget::saveNotBuiltClasses(), KviKvsEventManager::saveRawEvents(), KviMainWindow::saveWindowProperties(), SetupWizard::SetupWizard(), and url_module_cleanup().

◆ setReadOnly()

void KviConfigurationFile::setReadOnly ( bool bReadOnly)
inline

◆ setSavePath()

void KviConfigurationFile::setSavePath ( const QString & savePath)
inline

Referenced by TipWindow::closeConfig().

◆ sync()

◆ writeEntry() [1/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
bool bTrue )

◆ writeEntry() [2/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
char iValue )

◆ writeEntry() [3/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
const char * szValue )
inline

◆ writeEntry() [4/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
const KviMessageTypeSettings & msg )

◆ writeEntry() [5/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
const KviPixmap & pixmap )

◆ writeEntry() [6/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
const QColor & clr )

◆ writeEntry() [7/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
const QList< int > & list )

◆ writeEntry() [8/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
const QRect & rct )

◆ writeEntry() [9/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
const QString & szValue )

References getCurrentGroup(), m_bDirty, and KviPointerHashTable< Key, T >::replace().

Referenced by ConfigDialog::acceptbtn(), addon_module_cleanup(), channelsjoin_module_cleanup(), config_kvs_cmd_write(), ListWindow::exportList(), TipWindow::nextTip(), TipWindow::prevTip(), KviAvatarCache::save(), KviCustomToolBarDescriptor::save(), KviCustomToolBarManager::save(), KviIdentityProfile::save(), KviIdentityProfileSet::save(), KviInputHistory::save(), KviIrcServer::save(), KviIrcServerDataBase::save(), KviKvsAliasManager::save(), KviKvsPopupMenu::save(), KviKvsScriptAddon::save(), KviKvsUserAction::save(), KviMediaManager::save(), KviNickServRule::save(), KviNickServRuleSet::save(), KviProxyDataBase::save(), KviRegisteredChannelDataBase::save(), KviRegisteredUserDataBase::save(), KviSharedFilesManager::save(), KviStatusBar::save(), KviTextIconManager::save(), KviTheme::save(), KviThemeInfo::save(), KviUserIdentity::save(), KviUserIdentityManager::save(), OptionsWidget_messageColors::save(), KviKvsEventManager::saveAppEvents(), BanFrame::saveBans(), KviDefaultScriptManager::saveInternal(), KviApplication::saveKvircDirectory(), ClassEditorWidget::saveNotBuiltClasses(), ScriptEditorImplementation::saveOptions(), ActionEditorWindow::saveProperties(), AliasEditorWidget::saveProperties(), ClassEditorWidget::saveProperties(), HelpWindow::saveProperties(), KviChannelWindow::saveProperties(), KviConsoleWindow::saveProperties(), KviDebugWindow::saveProperties(), KviQueryWindow::saveProperties(), KviWindow::saveProperties(), KviKvsEventManager::saveRawEvents(), KviApplication::saveRecentEntries(), KviStatusBarAwayIndicator::saveState(), KviStatusBarClock::saveState(), KviStatusBarConnectionTimer::saveState(), KviStatusBarUpdateIndicator::saveState(), KviMainWindow::saveWindowProperties(), theme_module_cleanup(), and toolbareditor_module_cleanup().

◆ writeEntry() [10/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
const QStringList & list )

◆ writeEntry() [11/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
int iValue )

◆ writeEntry() [12/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
QFont & fnt )

◆ writeEntry() [13/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
unsigned char iValue )

◆ writeEntry() [14/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
unsigned int iValue )

◆ writeEntry() [15/15]

void KviConfigurationFile::writeEntry ( const QString & szKey,
unsigned short int usValue )

Member Data Documentation

◆ m_bDirty

◆ m_bLocal8Bit

bool KviConfigurationFile::m_bLocal8Bit
private

◆ m_bPreserveEmptyGroups

bool KviConfigurationFile::m_bPreserveEmptyGroups
private

◆ m_bReadOnly

bool KviConfigurationFile::m_bReadOnly
private

◆ m_pDict

◆ m_szFileName

QString KviConfigurationFile::m_szFileName
private

◆ m_szGroup

QString KviConfigurationFile::m_szGroup
private

◆ m_szStrBuffer

QString KviConfigurationFile::m_szStrBuffer
private

Referenced by readEntry().


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