FxUIFile.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "../FxCommonFramework.h"
#include "../UI/FxUIObject.h"

 
class CFxUIFileImpl;
class CFxUIByteArray;
class QFile;
 
class COMMONUI_API CFxUIFile 
{
public:
    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:

    CFxUIFile();

    CFxUIFile( const CFxUIString& name );

    CFxUIFile( const CFxUIFile& file );
    CFxUIFile( const QFile& file );

    ~CFxUIFile();

    CFxUIFile& operator=( 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 bool exists( const CFxUIString& fileName );
 
protected:
    CFxUIFileImpl* m_pImpl;
};