Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXSettings

FX::FXSettings Class Reference

The Settings class manages a key-value database. More...

#include <FXSettings.h>

Inheritance diagram for FX::FXSettings:

FX::FXDict FX::FXObject FX::FXRegistry

List of all members.

Public Member Functions

 FXSettings ()
 FXSettings (const FXSettings &orig)
FXSettings & operator= (const FXSettings &orig)
FXbool isModified () const
void setModified (FXbool mdfy=true)
FXbool parseFile (const FXString &filename, FXbool mark)
FXbool unparseFile (const FXString &filename)
FXStringDict * find (const FXchar *section) const
FXStringDict * find (const FXString &section) const
FXStringDict * data (FXint pos) const
FXint readFormatEntry (const FXchar *section, const FXchar *name, const FXchar *fmt,...) const FX_SCANF(4
FXint FXint readFormatEntry (const FXString &section, const FXchar *name, const FXchar *fmt,...) const FX_SCANF(4
FXint FXint FXint readFormatEntry (const FXString &section, const FXString &name, const FXchar *fmt,...) const FX_SCANF(4
FXint FXint FXint FXint writeFormatEntry (const FXchar *section, const FXchar *name, const FXchar *fmt,...) FX_PRINTF(4
FXint FXint FXint FXint FXint writeFormatEntry (const FXString &section, const FXchar *name, const FXchar *fmt,...) FX_PRINTF(4
FXint FXint FXint FXint FXint FXint writeFormatEntry (const FXString &section, const FXString &name, const FXchar *fmt,...) FX_PRINTF(4
FXint FXint FXint FXint FXint
FXint const FXchar * 		readStringEntry (const FXchar *section, const FXchar *name, const FXchar *def=NULL) const
const FXchar * readStringEntry (const FXString &section, const FXchar *name, const FXchar *def=NULL) const
const FXchar * readStringEntry (const FXString &section, const FXString &name, const FXchar *def=NULL) const
FXbool writeStringEntry (const FXchar *section, const FXchar *name, const FXchar *val)
FXbool writeStringEntry (const FXString &section, const FXchar *name, const FXchar *val)
FXbool writeStringEntry (const FXString &section, const FXString &name, const FXchar *val)
FXint readIntEntry (const FXchar *section, const FXchar *name, FXint def=0) const
FXint readIntEntry (const FXString &section, const FXchar *name, FXint def=0) const
FXint readIntEntry (const FXString &section, const FXString &name, FXint def=0) const
FXbool writeIntEntry (const FXchar *section, const FXchar *name, FXint val)
FXbool writeIntEntry (const FXString &section, const FXchar *name, FXint val)
FXbool writeIntEntry (const FXString &section, const FXString &name, FXint val)
FXuint readUIntEntry (const FXchar *section, const FXchar *name, FXuint def=0) const
FXuint readUIntEntry (const FXString &section, const FXchar *name, FXuint def=0) const
FXuint readUIntEntry (const FXString &section, const FXString &name, FXuint def=0) const
FXbool writeUIntEntry (const FXchar *section, const FXchar *name, FXuint val)
FXbool writeUIntEntry (const FXString &section, const FXchar *name, FXuint val)
FXbool writeUIntEntry (const FXString &section, const FXString &name, FXuint val)
FXlong readLongEntry (const FXchar *section, const FXchar *name, FXlong def=0) const
FXlong readLongEntry (const FXString &section, const FXchar *name, FXlong def=0) const
FXlong readLongEntry (const FXString &section, const FXString &name, FXlong def=0) const
FXbool writeLongEntry (const FXchar *section, const FXchar *name, FXlong val)
FXbool writeLongEntry (const FXString &section, const FXchar *name, FXlong val)
FXbool writeLongEntry (const FXString &section, const FXString &name, FXlong val)
FXulong readULongEntry (const FXchar *section, const FXchar *name, FXulong def=0) const
FXulong readULongEntry (const FXString &section, const FXchar *name, FXulong def=0) const
FXulong readULongEntry (const FXString &section, const FXString &name, FXulong def=0) const
FXbool writeULongEntry (const FXchar *section, const FXchar *name, FXulong val)
FXbool writeULongEntry (const FXString &section, const FXchar *name, FXulong val)
FXbool writeULongEntry (const FXString &section, const FXString &name, FXulong val)
FXdouble readRealEntry (const FXchar *section, const FXchar *name, FXdouble def=0.0) const
FXdouble readRealEntry (const FXString &section, const FXchar *name, FXdouble def=0.0) const
FXdouble readRealEntry (const FXString &section, const FXString &name, FXdouble def=0.0) const
FXbool writeRealEntry (const FXchar *section, const FXchar *name, FXdouble val)
FXbool writeRealEntry (const FXString &section, const FXchar *name, FXdouble val)
FXbool writeRealEntry (const FXString &section, const FXString &name, FXdouble val)
FXColor readColorEntry (const FXchar *section, const FXchar *name, FXColor def=0) const
FXColor readColorEntry (const FXString &section, const FXchar *name, FXColor def=0) const
FXColor readColorEntry (const FXString &section, const FXString &name, FXColor def=0) const
FXbool writeColorEntry (const FXchar *section, const FXchar *name, FXColor val)
FXbool writeColorEntry (const FXString &section, const FXchar *name, FXColor val)
FXbool writeColorEntry (const FXString &section, const FXString &name, FXColor val)
FXbool readBoolEntry (const FXchar *section, const FXchar *name, FXbool def=false) const
FXbool readBoolEntry (const FXString &section, const FXchar *name, FXbool def=false) const
FXbool readBoolEntry (const FXString &section, const FXString &name, FXbool def=false) const
FXbool writeBoolEntry (const FXchar *section, const FXchar *name, FXbool val)
FXbool writeBoolEntry (const FXString &section, const FXchar *name, FXbool val)
FXbool writeBoolEntry (const FXString &section, const FXString &name, FXbool val)
FXbool existingEntry (const FXchar *section, const FXchar *name) const
FXbool existingEntry (const FXString &section, const FXchar *name) const
FXbool existingEntry (const FXString &section, const FXString &name) const
FXbool deleteEntry (const FXchar *section, const FXchar *name)
FXbool deleteEntry (const FXString &section, const FXchar *name)
FXbool deleteEntry (const FXString &section, const FXString &name)
FXbool existingSection (const FXchar *section) const
FXbool existingSection (const FXString &section) const
FXbool deleteSection (const FXchar *section)
FXbool deleteSection (const FXString &section)
FXbool clear ()
virtual ~FXSettings ()

Detailed Description

The Settings class manages a key-value database.

This is normally used as part of Registry, but can also be used separately in applications that need to maintain a key-value database in a file of their own. String values can contain any character, and will be escaped when written to the file.

Constructor & Destructor Documentation

FX::FXSettings::FXSettings (  ) 

Construct settings database.

FX::FXSettings::FXSettings ( const FXSettings &  orig  ) 

Construct copy of existing database.

virtual FX::FXSettings::~FXSettings (  )  [virtual]

Cleanup.

Member Function Documentation

FXSettings& FX::FXSettings::operator= ( const FXSettings &  orig  ) 

Assignment operator.

FXbool FX::FXSettings::isModified (  )  const [inline]

Is it modified.

void FX::FXSettings::setModified ( FXbool  mdfy = true  )  [inline]

Mark as changed.

FXbool FX::FXSettings::parseFile ( const FXString &  filename,
FXbool  mark 
)

Parse a file containing a settings database.

FXbool FX::FXSettings::unparseFile ( const FXString &  filename  ) 

Unparse settings database into given file.

FXStringDict* FX::FXSettings::find ( const FXchar *  section  )  const [inline]

Find string dictionary for the given section; may be NULL.

Reimplemented from FX::FXDict.

FXStringDict* FX::FXSettings::find ( const FXString &  section  )  const [inline]

FXStringDict* FX::FXSettings::data ( FXint  pos  )  const [inline]

Obtain the string dictionary for the given section.

Reimplemented from FX::FXDict.

FXint FX::FXSettings::readFormatEntry ( const FXchar *  section,
const FXchar *  name,
const FXchar *  fmt,
  ... 
) const

Read a formatted registry entry, using scanf-style format.

FXint FXint FX::FXSettings::readFormatEntry ( const FXString &  section,
const FXchar *  name,
const FXchar *  fmt,
  ... 
) const

FXint FXint FXint FX::FXSettings::readFormatEntry ( const FXString &  section,
const FXString &  name,
const FXchar *  fmt,
  ... 
) const

FXint FXint FXint FXint FX::FXSettings::writeFormatEntry ( const FXchar *  section,
const FXchar *  name,
const FXchar *  fmt,
  ... 
)

Write a formatted registry entry, using printf-style format.

FXint FXint FXint FXint FXint FX::FXSettings::writeFormatEntry ( const FXString &  section,
const FXchar *  name,
const FXchar *  fmt,
  ... 
)

FXint FXint FXint FXint FXint FXint FX::FXSettings::writeFormatEntry ( const FXString &  section,
const FXString &  name,
const FXchar *  fmt,
  ... 
)

FXint FXint FXint FXint FXint FXint const FXchar* FX::FXSettings::readStringEntry ( const FXchar *  section,
const FXchar *  name,
const FXchar *  def = NULL 
) const

Read a string registry entry; if no value is found, the default value def is returned.

const FXchar* FX::FXSettings::readStringEntry ( const FXString &  section,
const FXchar *  name,
const FXchar *  def = NULL 
) const

const FXchar* FX::FXSettings::readStringEntry ( const FXString &  section,
const FXString &  name,
const FXchar *  def = NULL 
) const

FXbool FX::FXSettings::writeStringEntry ( const FXchar *  section,
const FXchar *  name,
const FXchar *  val 
)

Write a string registry entry.

FXbool FX::FXSettings::writeStringEntry ( const FXString &  section,
const FXchar *  name,
const FXchar *  val 
)

FXbool FX::FXSettings::writeStringEntry ( const FXString &  section,
const FXString &  name,
const FXchar *  val 
)

FXint FX::FXSettings::readIntEntry ( const FXchar *  section,
const FXchar *  name,
FXint  def = 0 
) const

Read a integer registry entry; if no value is found, the default value def is returned.

FXint FX::FXSettings::readIntEntry ( const FXString &  section,
const FXchar *  name,
FXint  def = 0 
) const

FXint FX::FXSettings::readIntEntry ( const FXString &  section,
const FXString &  name,
FXint  def = 0 
) const

FXbool FX::FXSettings::writeIntEntry ( const FXchar *  section,
const FXchar *  name,
FXint  val 
)

Write a integer registry entry.

FXbool FX::FXSettings::writeIntEntry ( const FXString &  section,
const FXchar *  name,
FXint  val 
)

FXbool FX::FXSettings::writeIntEntry ( const FXString &  section,
const FXString &  name,
FXint  val 
)

FXuint FX::FXSettings::readUIntEntry ( const FXchar *  section,
const FXchar *  name,
FXuint  def = 0 
) const

Read a unsigned integer registry entry; if no value is found, the default value def is returned.

FXuint FX::FXSettings::readUIntEntry ( const FXString &  section,
const FXchar *  name,
FXuint  def = 0 
) const

FXuint FX::FXSettings::readUIntEntry ( const FXString &  section,
const FXString &  name,
FXuint  def = 0 
) const

FXbool FX::FXSettings::writeUIntEntry ( const FXchar *  section,
const FXchar *  name,
FXuint  val 
)

Write a unsigned integer registry entry.

FXbool FX::FXSettings::writeUIntEntry ( const FXString &  section,
const FXchar *  name,
FXuint  val 
)

FXbool FX::FXSettings::writeUIntEntry ( const FXString &  section,
const FXString &  name,
FXuint  val 
)

FXlong FX::FXSettings::readLongEntry ( const FXchar *  section,
const FXchar *  name,
FXlong  def = 0 
) const

Read a 64-bit long integer registry entry; if no value is found, the default value def is returned.

FXlong FX::FXSettings::readLongEntry ( const FXString &  section,
const FXchar *  name,
FXlong  def = 0 
) const

FXlong FX::FXSettings::readLongEntry ( const FXString &  section,
const FXString &  name,
FXlong  def = 0 
) const

FXbool FX::FXSettings::writeLongEntry ( const FXchar *  section,
const FXchar *  name,
FXlong  val 
)

Write a 64-bit long integer registry entry.

FXbool FX::FXSettings::writeLongEntry ( const FXString &  section,
const FXchar *  name,
FXlong  val 
)

FXbool FX::FXSettings::writeLongEntry ( const FXString &  section,
const FXString &  name,
FXlong  val 
)

FXulong FX::FXSettings::readULongEntry ( const FXchar *  section,
const FXchar *  name,
FXulong  def = 0 
) const

Read a 64-bit unsigned long integer registry entry; if no value is found, the default value def is returned.

FXulong FX::FXSettings::readULongEntry ( const FXString &  section,
const FXchar *  name,
FXulong  def = 0 
) const

FXulong FX::FXSettings::readULongEntry ( const FXString &  section,
const FXString &  name,
FXulong  def = 0 
) const

FXbool FX::FXSettings::writeULongEntry ( const FXchar *  section,
const FXchar *  name,
FXulong  val 
)

Write a 64-bit unsigned long integer registry entry.

FXbool FX::FXSettings::writeULongEntry ( const FXString &  section,
const FXchar *  name,
FXulong  val 
)

FXbool FX::FXSettings::writeULongEntry ( const FXString &  section,
const FXString &  name,
FXulong  val 
)

FXdouble FX::FXSettings::readRealEntry ( const FXchar *  section,
const FXchar *  name,
FXdouble  def = 0.0 
) const

Read a double-precision floating point registry entry; if no value is found, the default value def is returned.

FXdouble FX::FXSettings::readRealEntry ( const FXString &  section,
const FXchar *  name,
FXdouble  def = 0.0 
) const

FXdouble FX::FXSettings::readRealEntry ( const FXString &  section,
const FXString &  name,
FXdouble  def = 0.0 
) const

FXbool FX::FXSettings::writeRealEntry ( const FXchar *  section,
const FXchar *  name,
FXdouble  val 
)

Write a double-precision floating point registry entry.

FXbool FX::FXSettings::writeRealEntry ( const FXString &  section,
const FXchar *  name,
FXdouble  val 
)

FXbool FX::FXSettings::writeRealEntry ( const FXString &  section,
const FXString &  name,
FXdouble  val 
)

FXColor FX::FXSettings::readColorEntry ( const FXchar *  section,
const FXchar *  name,
FXColor  def = 0 
) const

Read a color value registry entry; if no value is found, the default value def is returned.

FXColor FX::FXSettings::readColorEntry ( const FXString &  section,
const FXchar *  name,
FXColor  def = 0 
) const

FXColor FX::FXSettings::readColorEntry ( const FXString &  section,
const FXString &  name,
FXColor  def = 0 
) const

FXbool FX::FXSettings::writeColorEntry ( const FXchar *  section,
const FXchar *  name,
FXColor  val 
)

Write a color value entry.

FXbool FX::FXSettings::writeColorEntry ( const FXString &  section,
const FXchar *  name,
FXColor  val 
)

FXbool FX::FXSettings::writeColorEntry ( const FXString &  section,
const FXString &  name,
FXColor  val 
)

FXbool FX::FXSettings::readBoolEntry ( const FXchar *  section,
const FXchar *  name,
FXbool  def = false 
) const

Read a boolean registry entry.

FXbool FX::FXSettings::readBoolEntry ( const FXString &  section,
const FXchar *  name,
FXbool  def = false 
) const

FXbool FX::FXSettings::readBoolEntry ( const FXString &  section,
const FXString &  name,
FXbool  def = false 
) const

FXbool FX::FXSettings::writeBoolEntry ( const FXchar *  section,
const FXchar *  name,
FXbool  val 
)

Write a boolean value entry.

FXbool FX::FXSettings::writeBoolEntry ( const FXString &  section,
const FXchar *  name,
FXbool  val 
)

FXbool FX::FXSettings::writeBoolEntry ( const FXString &  section,
const FXString &  name,
FXbool  val 
)

FXbool FX::FXSettings::existingEntry ( const FXchar *  section,
const FXchar *  name 
) const

See if entry exists.

FXbool FX::FXSettings::existingEntry ( const FXString &  section,
const FXchar *  name 
) const

FXbool FX::FXSettings::existingEntry ( const FXString &  section,
const FXString &  name 
) const

FXbool FX::FXSettings::deleteEntry ( const FXchar *  section,
const FXchar *  name 
)

Delete a registry entry.

FXbool FX::FXSettings::deleteEntry ( const FXString &  section,
const FXchar *  name 
)

FXbool FX::FXSettings::deleteEntry ( const FXString &  section,
const FXString &  name 
)

FXbool FX::FXSettings::existingSection ( const FXchar *  section  )  const

See if section exists.

FXbool FX::FXSettings::existingSection ( const FXString &  section  )  const

FXbool FX::FXSettings::deleteSection ( const FXchar *  section  ) 

Delete section.

FXbool FX::FXSettings::deleteSection ( const FXString &  section  ) 

FXbool FX::FXSettings::clear (  ) 

Clear all sections.

Reimplemented from FX::FXDict.

Copyright © 1997-2010 Jeroen van der Zijp