org.kde.koala

Class KConfigINIBackEnd

public class KConfigINIBackEnd extends KConfigBackEnd

Class for KDE INI-style configuration file loading/saving.

Author: Preston Brown , Matthias Kalle Dalheimer

UNKNOWN: Class for KDE INI-style configuration file loading/saving.

Constructor Summary
protected KConfigINIBackEnd(Class dummy)
KConfigINIBackEnd(KConfigBase _config, String _fileName, String _resType, boolean _useKDEGlobals)
Constructs an ini-style configuration back end.
KConfigINIBackEnd(KConfigBase _config, String _fileName, String _resType)
Method Summary
voiddispose()
Delete the wrapped C++ instance ahead of finalize()
protected voidfinalize()
Deletes the wrapped C++ instance
booleanisDisposed()
Has the wrapped C++ instance been deleted?
booleanparseConfigFiles()
Parses all INI-style configuration files for a config object.
protected voidparseSingleConfigFile(QFile rFile)
Parses one configuration file.
voidsync(boolean bMerge)
Writes configuration data to file(s).
voidsync()
protected booleanwriteConfigFile(String filename, boolean bGlobal, boolean bMerge)
Writes configuration file back.
protected booleanwriteConfigFile(String filename, boolean bGlobal)
protected booleanwriteConfigFile(String filename)

Constructor Detail

KConfigINIBackEnd

protected KConfigINIBackEnd(Class dummy)

KConfigINIBackEnd

public KConfigINIBackEnd(KConfigBase _config, String _fileName, String _resType, boolean _useKDEGlobals)
Constructs an ini-style configuration back end.

Parameters: _config Specifies the configuration object which values will be passed to as they are read, or from where values to be written to will be obtained from. _fileName The name of the file in which config data is stored. All registered configuration directories will be looked in in order of decreasing relevance. _resType the resource type of the fileName specified, _if_ it is not an absolute path (otherwise this parameter is ignored). _useKDEGlobals If true, the user's system-wide kdeglobals file will be imported into the config object. If false, only the filename specified will be dealt with.

UNKNOWN: Constructs an ini-style configuration back end.

KConfigINIBackEnd

public KConfigINIBackEnd(KConfigBase _config, String _fileName, String _resType)

Method Detail

dispose

public void dispose()
Delete the wrapped C++ instance ahead of finalize()

finalize

protected void finalize()
Deletes the wrapped C++ instance

isDisposed

public boolean isDisposed()
Has the wrapped C++ instance been deleted?

parseConfigFiles

public boolean parseConfigFiles()
Parses all INI-style configuration files for a config object.

Returns: Whether or not parsing was successful.

UNKNOWN: Parses all INI-style configuration files for a config object.

parseSingleConfigFile

protected void parseSingleConfigFile(QFile rFile)
Parses one configuration file.

Parameters: rFile The configuration file to parse pWriteBackMap If specified, points to a KEntryMap where the data read from the file should be stored, instead of inserting them directly into the configuration object. Use this area as a "scratchpad" when you need to know what is on disk but don't want to effect the configuration object. bGlobal Specifies whether entries should be marked as belonging to the global KDE configuration file rather than the application-specific KDE configuration file(s). bDefault Specifies whether entries should be marked as being default values.

UNKNOWN: Parses one configuration file.

sync

public void sync(boolean bMerge)
Writes configuration data to file(s).

Parameters: bMerge Specifies whether the old config file already on disk should be merged in with the data in memory. If true, data is read off the disk and merged. If false, the on-disk file is removed and only in-memory data is written out.

UNKNOWN: Writes configuration data to file(s).

sync

public void sync()

writeConfigFile

protected boolean writeConfigFile(String filename, boolean bGlobal, boolean bMerge)
Writes configuration file back.

Parameters: filename The name of the file to write. bGlobal Specifies whether to write only entries which are marked as belonging to the global KDE config file. If this is false, it skips those entries. bMerge Specifies whether the old config file already on disk should be merged in with the data in memory. If true, data is read off the disk and merged. If false, the on-disk file is removed and only in-memory data is written out.

Returns: Whether some entries are left to be written to other files.

UNKNOWN: Writes configuration file back.

writeConfigFile

protected boolean writeConfigFile(String filename, boolean bGlobal)

writeConfigFile

protected boolean writeConfigFile(String filename)