KVIrc 5.2.4
Developer APIs
Public Member Functions | List of all members
KviFile Class Reference

KVIrc File class. More...

#include <KviFile.h>

+ Inheritance diagram for KviFile:

Public Member Functions

 KviFile ()
 Constructs file object.
 
 KviFile (const QString &szName)
 Constructs file object.
 
bool load (kvi_i16_t &file)
 Loads a file.
 
bool load (kvi_i32_t &file)
 Loads a file.
 
bool load (kvi_i64_t &file)
 Loads a file.
 
bool load (kvi_i8_t &file)
 Loads a file.
 
bool load (kvi_u16_t &file)
 Loads a file.
 
bool load (kvi_u32_t &file)
 Loads a file.
 
bool load (kvi_u64_t &file)
 Loads a file.
 
bool load (kvi_u8_t &file)
 Loads a file.
 
bool load (KviCString &szData)
 Loads a file.
 
bool load (KviPointerList< KviCString > *pData)
 Loads a file from a list.
 
bool load (QByteArray &data)
 Loads a file.
 
bool load (QString &szData)
 Loads a file.
 
bool save (const KviCString &szData)
 Saves a file.
 
bool save (const QByteArray &data)
 Saves a file.
 
bool save (const QString &szData)
 Saves a file.
 
bool save (kvi_i16_t file)
 Saves a file.
 
bool save (kvi_i32_t file)
 Saves a file.
 
bool save (kvi_i64_t file)
 Saves a file.
 
bool save (kvi_i8_t file)
 Saves a file.
 
bool save (kvi_u16_t file)
 Saves a file.
 
bool save (kvi_u32_t file)
 Saves a file.
 
bool save (kvi_u64_t file)
 Saves a file.
 
bool save (kvi_u8_t file)
 Saves a file.
 
bool save (KviPointerList< KviCString > *pData)
 Saves a file to a list.
 
bool skipFirst (char t, unsigned int uMaxDist=0xffffffff)
 Skips the first occurrence of the given char for a given dimension.
 
bool skipFirst (const KviCString &szText, unsigned int uMaxDist=0xffffffff)
 Skips the first occurrence of the given string for a given dimension.
 
 ~KviFile ()
 Destroys file object.
 

Detailed Description

KVIrc File class.

Constructor & Destructor Documentation

◆ KviFile() [1/2]

KviFile::KviFile ( )

Constructs file object.

Returns
KviFile

◆ KviFile() [2/2]

KviFile::KviFile ( const QString &  szName)

Constructs file object.

Parameters
szNameThe name of the file
Returns
KviFile

◆ ~KviFile()

KviFile::~KviFile ( )
default

Destroys file object.

Member Function Documentation

◆ load() [1/12]

bool KviFile::load ( kvi_i16_t &  file)
inline

Loads a file.

Parameters
fileThe file to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References load().

Referenced by load().

◆ load() [2/12]

bool KviFile::load ( kvi_i32_t &  file)
inline

Loads a file.

Parameters
fileThe file to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References load().

Referenced by load().

◆ load() [3/12]

bool KviFile::load ( kvi_i64_t file)
inline

Loads a file.

Parameters
fileThe file to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References load().

Referenced by load().

◆ load() [4/12]

bool KviFile::load ( kvi_i8_t file)
inline

Loads a file.

Parameters
fileThe file to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References load().

Referenced by load().

◆ load() [5/12]

bool KviFile::load ( kvi_u16_t &  file)

Loads a file.

Parameters
fileThe file to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References KviByteOrder::littleEndianToLocalCpu16(), and t.

◆ load() [6/12]

bool KviFile::load ( kvi_u32_t &  file)

Loads a file.

Parameters
fileThe file to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References KviByteOrder::littleEndianToLocalCpu32(), and t.

◆ load() [7/12]

bool KviFile::load ( kvi_u64_t file)

Loads a file.

Parameters
fileThe file to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References KviByteOrder::littleEndianToLocalCpu32(), and t.

Referenced by load(), load(), load(), load(), KviPackageReader::readHeaderInternal(), and KviPackageReader::unpackFile().

◆ load() [8/12]

bool KviFile::load ( kvi_u8_t file)

Loads a file.

Parameters
fileThe file to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References t.

◆ load() [9/12]

bool KviFile::load ( KviCString szData)

Loads a file.

Parameters
szDataThe file to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References load(), KviCString::ptr(), and KviCString::setLen().

◆ load() [10/12]

bool KviFile::load ( KviPointerList< KviCString > *  pData)

Loads a file from a list.

Parameters
pDataThe list of files to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References KviPointerList< T >::append(), KviPointerList< T >::clear(), i, load(), and s.

◆ load() [11/12]

bool KviFile::load ( QByteArray &  data)

Loads a file.

Parameters
dataThe file to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References load().

◆ load() [12/12]

bool KviFile::load ( QString &  szData)

Loads a file.

Parameters
szDataThe file to load
Warning
This function loads LITTLE ENDIAN DATA!
Returns
bool

References load().

◆ save() [1/12]

bool KviFile::save ( const KviCString szData)

Saves a file.

Parameters
szDataThe file to save
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References KviCString::len(), KviCString::ptr(), and save().

◆ save() [2/12]

bool KviFile::save ( const QByteArray &  data)

Saves a file.

Parameters
dataThe file to save
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References save().

◆ save() [3/12]

bool KviFile::save ( const QString &  szData)

Saves a file.

Parameters
szDataThe file to save
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References save().

◆ save() [4/12]

bool KviFile::save ( kvi_i16_t  file)
inline

Saves a file.

Parameters
fileThe file to save
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References save().

Referenced by save().

◆ save() [5/12]

bool KviFile::save ( kvi_i32_t  file)
inline

Saves a file.

Parameters
fileThe file to save
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References save().

Referenced by save().

◆ save() [6/12]

bool KviFile::save ( kvi_i64_t  file)
inline

Saves a file.

Parameters
fileThe file to save
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References save().

Referenced by save().

◆ save() [7/12]

bool KviFile::save ( kvi_i8_t  file)
inline

Saves a file.

Parameters
fileThe file to save
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References save().

Referenced by save().

◆ save() [8/12]

bool KviFile::save ( kvi_u16_t  file)

Saves a file.

Parameters
fileThe file to save
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References KviByteOrder::localCpuToLittleEndian16(), and t.

◆ save() [9/12]

bool KviFile::save ( kvi_u32_t  file)

Saves a file.

Parameters
fileThe file to save
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References KviByteOrder::localCpuToLittleEndian32(), and t.

◆ save() [10/12]

bool KviFile::save ( kvi_u64_t  file)

Saves a file.

Parameters
fileThe file to save
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References KviByteOrder::localCpuToLittleEndian64(), and t.

Referenced by KviPackageWriter::packFile(), save(), save(), save(), and save().

◆ save() [11/12]

bool KviFile::save ( kvi_u8_t  file)

Saves a file.

Parameters
fileThe file to save
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References t.

◆ save() [12/12]

bool KviFile::save ( KviPointerList< KviCString > *  pData)

Saves a file to a list.

Parameters
pDataThe list where file to save is
Warning
This function saves LITTLE ENDIAN DATA!
Returns
bool

References KviPointerList< T >::count(), KviPointerList< T >::first(), KviPointerList< T >::next(), s, and save().

◆ skipFirst() [1/2]

bool KviFile::skipFirst ( char  t,
unsigned int  uMaxDist = 0xffffffff 
)

Skips the first occurrence of the given char for a given dimension.

Parameters
tThe char to find and skip
uMaxDistThe dimension of the search field
Returns
bool

References t.

◆ skipFirst() [2/2]

bool KviFile::skipFirst ( const KviCString szText,
unsigned int  uMaxDist = 0xffffffff 
)

Skips the first occurrence of the given string for a given dimension.

Parameters
szTextThe string to find and skip
uMaxDistThe dimension of the search field
Returns
bool

References KviCString::ptr().


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