/usr/include/kdiskfreespaceinfo.h is in kdelibs5-dev 4:4.13.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 | /*
* 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/QSharedDataPointer>
#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& );
/**
* Destructor
*/
~KDiskFreeSpaceInfo();
/**
* Assignment operator
*/
KDiskFreeSpaceInfo& operator=( const KDiskFreeSpaceInfo& );
/**
* \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
|