mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-24 10:52:49 +00:00
131 lines
3.5 KiB
C++
131 lines
3.5 KiB
C++
/*
|
|
* kdiskfreespaceinfo.h
|
|
*
|
|
* Copyright 2008 Sebastian Trug <trueg@kde.org>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License version 2 as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public License
|
|
* along with this library; see the file COPYING.LIB. If not, write to
|
|
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef _KDISK_FREE_SPACE_INFO_H_
|
|
#define _KDISK_FREE_SPACE_INFO_H_
|
|
|
|
#include <QtCore/qshareddata.h>
|
|
#include <QtCore/QString>
|
|
|
|
#include <kio/kio_export.h>
|
|
#include <kio/global.h>
|
|
|
|
/**
|
|
* \class KDiskFreeSpaceInfo kdiskfreespaceinfo.h KDiskFreeSpaceInfo
|
|
*
|
|
* \brief Determine the space left on an arbitrary partition.
|
|
*
|
|
* This class determines the free space left on the partition that holds a given
|
|
* path. This path can be the mount point or any file or directory on the
|
|
* partition.
|
|
*
|
|
* To find how much space is available on the partition containing @p path,
|
|
* simply do the following:
|
|
*
|
|
* \code
|
|
* KDiskFreeSpaceInfo info = KDiskFreeSpaceInfo::freeSpaceInfo( path );
|
|
* if( info.isValid() )
|
|
* doSomething( info.available() );
|
|
* \code
|
|
*
|
|
* \author Sebastian Trueg <trueg@kde.org>
|
|
*
|
|
* \since 4.2
|
|
*/
|
|
class KIO_EXPORT KDiskFreeSpaceInfo
|
|
{
|
|
public:
|
|
/**
|
|
* Copy constructor
|
|
*/
|
|
KDiskFreeSpaceInfo(const KDiskFreeSpaceInfo &other);
|
|
|
|
/**
|
|
* Destructor
|
|
*/
|
|
~KDiskFreeSpaceInfo();
|
|
|
|
/**
|
|
* Assignment operator
|
|
*/
|
|
KDiskFreeSpaceInfo& operator=(const KDiskFreeSpaceInfo &other);
|
|
|
|
/**
|
|
* \return \p true if the available disk space was successfully
|
|
* determined and the values from mountPoint(), size(), available(),
|
|
* and used() are valid. \p false otherwise.
|
|
*/
|
|
bool isValid() const;
|
|
|
|
/**
|
|
* The mount point of the partition the requested path points to
|
|
*
|
|
* Only valid if isValid() returns \p true.
|
|
*/
|
|
QString mountPoint() const;
|
|
|
|
/**
|
|
* The total size of the partition mounted at mountPoint()
|
|
*
|
|
* Only valid if isValid() returns \p true.
|
|
*
|
|
* \return Total size of the requested partition in bytes.
|
|
*/
|
|
KIO::filesize_t size() const;
|
|
|
|
/**
|
|
* The available space in the partition mounted at mountPoint()
|
|
*
|
|
* Only valid if isValid() returns \p true.
|
|
*
|
|
* \return Available space left on the requested partition in bytes.
|
|
*/
|
|
KIO::filesize_t available() const;
|
|
|
|
/**
|
|
* The used space in the partition mounted at mountPoint()
|
|
*
|
|
* Only valid if isValid() returns \p true.
|
|
*
|
|
* \return Used space on the requested partition in bytes.
|
|
*/
|
|
KIO::filesize_t used() const;
|
|
|
|
/**
|
|
* Static method used to determine the free disk space.
|
|
*
|
|
* \param path An arbitrary path. The available space will be
|
|
* determined for the partition containing path.
|
|
*
|
|
* Check isValid() to see if the process was successful. Then
|
|
* use mountPoint(), size(), available(), and used() to access
|
|
* the requested values.
|
|
*/
|
|
static KDiskFreeSpaceInfo freeSpaceInfo(const QString &path);
|
|
|
|
private:
|
|
KDiskFreeSpaceInfo();
|
|
|
|
class Private;
|
|
QSharedDataPointer<Private> d;
|
|
};
|
|
|
|
#endif
|
|
|