KVIrc 5.2.4
Developer APIs
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
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()

void KviConfigurationFile::clear ( )

◆ clearDirtyFlag()

void KviConfigurationFile::clearDirtyFlag ( )
inline

◆ clearGroup()

void KviConfigurationFile::clearGroup ( const QString &  szGroup)

◆ clearKey()

void KviConfigurationFile::clearKey ( const QString &  szKey)

◆ dict()

KviPointerHashTable< QString, KviConfigurationFileGroup > * KviConfigurationFile::dict ( )
inline

◆ dirty()

bool KviConfigurationFile::dirty ( )
inline

Referenced by config_kvs_cmd_close().

◆ fileName()

const QString & KviConfigurationFile::fileName ( )
inline

◆ getCurrentGroup()

KviConfigurationFileGroup * KviConfigurationFile::getCurrentGroup ( )
private

◆ getFontProperties()

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

◆ group()

const QString & KviConfigurationFile::group ( )
inline

◆ groupsCount()

unsigned int KviConfigurationFile::groupsCount ( )
inline

◆ hasGroup()

bool KviConfigurationFile::hasGroup ( const QString &  szGroup)

◆ hasKey()

bool KviConfigurationFile::hasKey ( const QString &  szKey)

◆ load()

bool KviConfigurationFile::load ( )
private

◆ preserveEmptyGroups()

void KviConfigurationFile::preserveEmptyGroups ( bool  bPreserve)
inline

◆ readBoolEntry()

bool KviConfigurationFile::readBoolEntry ( const QString &  szKey,
bool  bTrue 
)

◆ readCharEntry()

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

◆ readColorEntry()

QColor KviConfigurationFile::readColorEntry ( const QString &  szKey,
const QColor &  clr 
)

◆ readEntry()

QString KviConfigurationFile::readEntry ( const QString &  szKey,
const QString &  szDefault = QString() 
)

◆ readFontEntry()

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

◆ readIntEntry()

int KviConfigurationFile::readIntEntry ( const QString &  szKey,
int  iDefault 
)

◆ readIntListEntry()

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

◆ 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()

unsigned int KviConfigurationFile::readUIntEntry ( const QString &  szKey,
unsigned int  iDefault 
)

◆ readUShortEntry()

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

◆ save()

bool KviConfigurationFile::save ( )
private

◆ 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(), KviStatusBar::load(), OptionsWidget_messageColors::load(), KviRegisteredUserDataBase::load(), KviSharedFilesManager::load(), KviKvsAliasManager::load(), KviKvsPopupManager::load(), KviThemeInfo::load(), KviMediaManager::load(), KviAvatarCache::load(), KviIrcServerDataBase::load(), KviUserIdentityManager::load(), KviActionManager::load(), KviCustomToolBarManager::load(), KviTextIconManager::load(), KviKvsScriptAddon::load(), KviKvsEventManager::loadAppEvents(), ClassEditorWidget::loadNotBuiltClasses(), KviKvsEventManager::loadRawEvents(), KviStatusBar::save(), OptionsWidget_messageColors::save(), KviRegisteredUserDataBase::save(), KviSharedFilesManager::save(), KviKvsAliasManager::save(), KviKvsPopupManager::save(), KviMediaManager::save(), KviRegisteredChannelDataBase::save(), KviAvatarCache::save(), KviIrcServerDataBase::save(), KviUserIdentityManager::save(), KviActionManager::save(), KviCustomToolBarManager::save(), KviTextIconManager::save(), KviKvsScriptAddonManager::save(), KviThemeInfo::save(), KviUserIdentity::save(), KviCustomToolBarDescriptor::save(), KviKvsScriptAddon::save(), KviKvsUserAction::save(), KviTheme::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()

bool KviConfigurationFile::sync ( )
inline

◆ 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(), KviStatusBar::save(), OptionsWidget_messageColors::save(), KviProxyDataBase::save(), KviRegisteredUserDataBase::save(), KviSharedFilesManager::save(), KviKvsAliasManager::save(), KviKvsPopupMenu::save(), KviMediaManager::save(), KviRegisteredChannelDataBase::save(), KviAvatarCache::save(), KviIrcServerDataBase::save(), KviUserIdentityManager::save(), KviCustomToolBarManager::save(), KviTextIconManager::save(), KviInputHistory::save(), KviThemeInfo::save(), KviUserIdentity::save(), KviCustomToolBarDescriptor::save(), KviKvsScriptAddon::save(), KviNickServRule::save(), KviNickServRuleSet::save(), KviKvsUserAction::save(), KviIdentityProfile::save(), KviIdentityProfileSet::save(), KviIrcServer::save(), KviTheme::save(), KviKvsEventManager::saveAppEvents(), BanFrame::saveBans(), KviDefaultScriptManager::saveInternal(), KviApplication::saveKvircDirectory(), ClassEditorWidget::saveNotBuiltClasses(), ScriptEditorImplementation::saveOptions(), AliasEditorWidget::saveProperties(), ActionEditorWindow::saveProperties(), KviConsoleWindow::saveProperties(), KviDebugWindow::saveProperties(), HelpWindow::saveProperties(), KviWindow::saveProperties(), ClassEditorWidget::saveProperties(), KviChannelWindow::saveProperties(), KviQueryWindow::saveProperties(), KviKvsEventManager::saveRawEvents(), KviApplication::saveRecentEntries(), 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

bool KviConfigurationFile::m_bDirty
private

◆ m_bLocal8Bit

bool KviConfigurationFile::m_bLocal8Bit
private

◆ m_bPreserveEmptyGroups

bool KviConfigurationFile::m_bPreserveEmptyGroups
private

◆ m_bReadOnly

bool KviConfigurationFile::m_bReadOnly
private

◆ m_pDict

KviPointerHashTable<QString, KviConfigurationFileGroup>* KviConfigurationFile::m_pDict
private

◆ 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: