CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
CFxUIFile Class Reference

#include <FxUIFile.h>

Public Types

enum  FxUIPermission {
  ReadOwner = 0x4000 , WriteOwner = 0x2000 , ExeOwner = 0x1000 , ReadUser = 0x0400 ,
  WriteUser = 0x0200 , ExeUser = 0x0100 , ReadGroup = 0x0040 , WriteGroup = 0x0020 ,
  ExeGroup = 0x0010 , ReadOther = 0x0004 , WriteOther = 0x0002 , ExeOther = 0x0001
}
 
enum  FxUIOpenMode {
  NotOpen = 0x0000 , ReadOnly = 0x0001 , WriteOnly = 0x0002 , ReadWrite = ReadOnly | WriteOnly ,
  Append = 0x0004 , Truncate = 0x0008 , Text = 0x0010 , Unbuffered = 0x0020 ,
  NewOnly = 0x0040 , ExistingOnly = 0x0080
}
 

Public Member Functions

 CFxUIFile ()
 
 CFxUIFile (const CFxUIString &name)
 
 CFxUIFile (const CFxUIFile &file)
 
 CFxUIFile (const QFile &file)
 
 ~CFxUIFile ()
 
CFxUIFileoperator= (const CFxUIFile &file)
 
 operator const QFile & () const
 
void close ()
 
bool exists () const
 
bool open (FxUIOpenMode mode)
 
int permissions () const
 
CFxUIByteArray readAll ()
 
bool remove ()
 
bool setPermissions (int permissionSpec)
 
int write (const CFxUIByteArray &data)
 
void copy (const CFxUIString &destinationFileName)
 

Static Public Member Functions

static bool exists (const CFxUIString &fileName)
 

Protected Attributes

CFxUIFileImpl * m_pImpl
 

Detailed Description

Definition at line 30 of file FxUIFile.h.

Member Enumeration Documentation

◆ FxUIOpenMode

Enumerator
NotOpen 
ReadOnly 
WriteOnly 
ReadWrite 
Append 
Truncate 
Text 
Unbuffered 
NewOnly 
ExistingOnly 

Definition at line 49 of file FxUIFile.h.

◆ FxUIPermission

Enumerator
ReadOwner 
WriteOwner 
ExeOwner 
ReadUser 
WriteUser 
ExeUser 
ReadGroup 
WriteGroup 
ExeGroup 
ReadOther 
WriteOther 
ExeOther 

Definition at line 33 of file FxUIFile.h.

Constructor & Destructor Documentation

◆ CFxUIFile() [1/4]

CFxUIFile::CFxUIFile ( )

Constructor

◆ CFxUIFile() [2/4]

CFxUIFile::CFxUIFile ( const CFxUIString & name)

Parameterized Constructor

◆ CFxUIFile() [3/4]

CFxUIFile::CFxUIFile ( const CFxUIFile & file)

Copy Constructor

◆ CFxUIFile() [4/4]

CFxUIFile::CFxUIFile ( const QFile & file)

◆ ~CFxUIFile()

CFxUIFile::~CFxUIFile ( )

Destructor

Member Function Documentation

◆ close()

void CFxUIFile::close ( )

Close the file.

◆ copy()

void CFxUIFile::copy ( const CFxUIString & destinationFileName)

Copy the file to the destination.

Parameters
filenameas CFxUIString

◆ exists() [1/2]

bool CFxUIFile::exists ( ) const

Returns true if the file specified by fileName exists, otherwise returns false.

Returns
bool

◆ exists() [2/2]

static bool CFxUIFile::exists ( const CFxUIString & fileName)
static

Returns true if the file specified by fileName exists, otherwise returns false.

Parameters
filenameas CFxUIString
Returns
bool

◆ open()

bool CFxUIFile::open ( FxUIOpenMode mode)

Opens the file using OpenMode mode, returning true if successful, otherwise false.

Parameters
CFxUIFile::FxUIOpenMode
Returns
bool

◆ operator const QFile &()

CFxUIFile::operator const QFile & ( ) const

◆ operator=()

CFxUIFile & CFxUIFile::operator= ( const CFxUIFile & file)

Assignment operator

◆ permissions()

int CFxUIFile::permissions ( ) const

Returns all the permissions for the file.

Returns
Permission

◆ readAll()

CFxUIByteArray CFxUIFile::readAll ( )

Reads all data from the device, and returns it as a byte array.

Returns
CFxUIByteArray

◆ remove()

bool CFxUIFile::remove ( )

Returns true if the file specified by fileName removed, otherwise returns false.

Returns
bool

◆ setPermissions()

bool CFxUIFile::setPermissions ( int permissionSpec)

Sets all the permissions for the file.

Parameters
Permission
Returns
bool

◆ write()

int CFxUIFile::write ( const CFxUIByteArray & data)

Writes the data to the file. Returns the the number of bytes actually written.

Parameters
dataas CFxUIByteArray
Returns
int

Member Data Documentation

◆ m_pImpl

CFxUIFileImpl* CFxUIFile::m_pImpl
protected

Definition at line 159 of file FxUIFile.h.


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