CopperSpice API  1.7.2
QUrlInfo Class Reference

Stores information about URLs. More...

Public Types

enum  PermissionSpec
 

Public Methods

 QUrlInfo ()
 
 QUrlInfo (const QString &name, int permissions, const QString &owner, const QString &group, qint64 size, const QDateTime &lastModified, const QDateTime &lastRead, bool isDir, bool isFile, bool isSymLink, bool isWritable, bool isReadable, bool isExecutable)
 
 QUrlInfo (const QUrl &url, int permissions, const QString &owner, const QString &group, qint64 size, const QDateTime &lastModified, const QDateTime &lastRead, bool isDir, bool isFile, bool isSymLink, bool isWritable, bool isReadable, bool isExecutable)
 
 QUrlInfo (const QUrlInfo &other)
 
virtual ~QUrlInfo ()
 
QString group () const
 
bool isDir () const
 
bool isExecutable () const
 
bool isFile () const
 
bool isReadable () const
 
bool isSymLink () const
 
bool isValid () const
 
bool isWritable () const
 
QDateTime lastModified () const
 
QDateTime lastRead () const
 
QString name () const
 
bool operator!= (const QUrlInfo &other) const
 
QUrlInfo & operator= (const QUrlInfo &other)
 
bool operator== (const QUrlInfo &other) const
 
QString owner () const
 
int permissions () const
 
virtual void setDir (bool b)
 
virtual void setFile (bool b)
 
virtual void setGroup (const QString &s)
 
virtual void setLastModified (const QDateTime &dt)
 
void setLastRead (const QDateTime &dt)
 
virtual void setName (const QString &name)
 
virtual void setOwner (const QString &s)
 
virtual void setPermissions (int p)
 
virtual void setReadable (bool b)
 
virtual void setSize (qint64 size)
 
virtual void setSymLink (bool b)
 
virtual void setWritable (bool b)
 
qint64 size () const
 

Static Public Methods

static bool equal (const QUrlInfo &i1, const QUrlInfo &i2, int sortBy)
 
static bool greaterThan (const QUrlInfo &i1, const QUrlInfo &i2, int sortBy)
 
static bool lessThan (const QUrlInfo &i1, const QUrlInfo &i2, int sortBy)
 

Detailed Description

The QUrlInfo class stores information about URLs. The information about a URL that can be retrieved includes name(), permissions(), owner(), group(), size(), lastModified(), lastRead(), isDir(), isFile(), isSymLink(), isWritable(), isReadable() and isExecutable().

You can create your own QUrlInfo objects passing in all the relevant information in the constructor, and you can modify a QUrlInfo, for each getter mentioned above there is an equivalent setter. Note that setting values does not affect the underlying resource that the QUrlInfo provides information about, for example if you call setWritable(true) on a read-only resource the only thing changed is the QUrlInfo object, not the resource.

See also
QUrl

Member Enumeration Documentation

This enum is used by the permissions() function to report the permissions of a file.

ConstantValueDescription
QUrlInfo::ReadOwner00400File is readable by the owner of the file.
QUrlInfo::WriteOwner00200File is writable by the owner of the file.
QUrlInfo::ExeOwner00100File is executable by the owner of the file.
QUrlInfo::ReadGroup00040File is readable by the group.
QUrlInfo::WriteGroup00020File is writable by the group.
QUrlInfo::ExeGroup00010File is executable by the group.
QUrlInfo::ReadOther00004File is readable by anyone.
QUrlInfo::WriteOther00002File is writable by anyone.
QUrlInfo::ExeOther00001File is executable by anyone.

Constructor & Destructor Documentation

QUrlInfo::QUrlInfo ( )

Constructs an invalid QUrlInfo object with default values.

See also
isValid()
QUrlInfo::QUrlInfo ( const QString name,
int  permissions,
const QString owner,
const QString group,
qint64  size,
const QDateTime lastModified,
const QDateTime lastRead,
bool  isDir,
bool  isFile,
bool  isSymLink,
bool  isWritable,
bool  isReadable,
bool  isExecutable 
)

Constructs a QUrlInfo object by specifying all the URL's information.

The information that is passed is the name, file permissions, owner and group and the file's size. Also passed is the lastModified date/time and the lastRead date/time.

Flags are also passed, specifically isDir, isFile, isSymLink, isWritable, isReadable and isExecutable.

QUrlInfo::QUrlInfo ( const QUrl url,
int  permissions,
const QString owner,
const QString group,
qint64  size,
const QDateTime lastModified,
const QDateTime lastRead,
bool  isDir,
bool  isFile,
bool  isSymLink,
bool  isWritable,
bool  isReadable,
bool  isExecutable 
)

Constructs a QUrlInfo object by specifying all the URL's information.

The information that is passed is the url, file permissions, owner and group and the file's size. Also passed is the lastModified date/time and the lastRead date/time.

Flags are also passed, specifically, isDir, isFile, isSymLink, isWritable, isReadable and isExecutable.

QUrlInfo::QUrlInfo ( const QUrlInfo &  other)

Copy constructs a new QUrlInfo from other.

QUrlInfo::~QUrlInfo ( )
virtual

Destroys the URL info object.

Method Documentation

bool QUrlInfo::equal ( const QUrlInfo &  i1,
const QUrlInfo &  i2,
int  sortBy 
)
static

Returns true if i1 equals to i2, otherwise returns false. The objects are compared by the value, which is specified by sortBy. This must be one of QDir::Name, QDir::Time or QDir::Size.

bool QUrlInfo::greaterThan ( const QUrlInfo &  i1,
const QUrlInfo &  i2,
int  sortBy 
)
static

Returns true if i1 is greater than i2, otherwise returns false. The objects are compared by the value, which is specified by sortBy. This must be one of QDir::Name, QDir::Time or QDir::Size.

QString QUrlInfo::group ( ) const

Returns the group of the URL.

See also
setGroup(), isValid()
bool QUrlInfo::isDir ( ) const

Returns true if the URL is a directory, otherwise returns false.

See also
isValid()
bool QUrlInfo::isExecutable ( ) const

Returns true if the URL is executable, otherwise returns false.

See also
isValid()
bool QUrlInfo::isFile ( ) const

Returns true if the URL is a file, otherwise returns false.

See also
isValid()
bool QUrlInfo::isReadable ( ) const

Returns true if the URL is readable, otherwise returns false.

See also
isValid()
bool QUrlInfo::isSymLink ( ) const

Returns true if the URL is a symbolic link, otherwise returns false.

See also
isValid()
bool QUrlInfo::isValid ( ) const

Returns true if the URL info is valid, otherwise returns false. Valid means that the QUrlInfo contains real information. You should always check if the URL info is valid before relying on the values.

bool QUrlInfo::isWritable ( ) const

Returns true if the URL is writable, otherwise returns false.

See also
isValid()
QDateTime QUrlInfo::lastModified ( ) const

Returns the last modification date of the URL.

See also
setLastModified(), isValid()
QDateTime QUrlInfo::lastRead ( ) const

Returns the date when the URL was last read.

See also
setLastRead(), isValid()
bool QUrlInfo::lessThan ( const QUrlInfo &  i1,
const QUrlInfo &  i2,
int  sortBy 
)
static

Returns true if i1 is less than i2, otherwise returns false. The objects are compared by the value, which is specified by sortBy. This must be one of QDir::Name, QDir::Time or QDir::Size.

QString QUrlInfo::name ( ) const

Returns the file name of the URL.

See also
setName(), isValid()
bool QUrlInfo::operator!= ( const QUrlInfo &  other) const
inline

Returns true if this QUrlInfo is not equal to other, otherwise returns false.

See also
lessThan(), equal()
QUrlInfo & QUrlInfo::operator= ( const QUrlInfo &  other)

Copy assigns from other and returns a reference to this object.

bool QUrlInfo::operator== ( const QUrlInfo &  other) const

Returns true if this QUrlInfo is equal to other, otherwise returns false.

See also
lessThan(), equal()
QString QUrlInfo::owner ( ) const

Returns the owner of the URL.

See also
setOwner(), isValid()
int QUrlInfo::permissions ( ) const

Returns the permissions of the URL. You can use the >PermissionSpec flags to test for certain permissions.

See also
setPermissions(), isValid()
void QUrlInfo::setDir ( bool  b)
virtual

If b is true then the URL is set to be a directory, if b is false then the URL is set not to be a directory, which normally means it is a file. A URL can refer to both a file and a directory even though most file systems do not support this.

If you call this method on an invalid QUrlInfo object and pass a valid data, the object becomes valid.

See also
isDir(), isValid()
void QUrlInfo::setFile ( bool  b)
virtual

If b is true then the URL is set to be a file, if b is false then the URL is set not to be a file, which normally means it is a directory. A URL can refer to both a file and a directory even though most file systems do not support this.

If you call this method on an invalid QUrlInfo object and pass a valid data, the object becomes valid.

See also
isFile(), isValid()
void QUrlInfo::setGroup ( const QString s)
virtual

Specifies that the owning group of the URL is called s.

If you call this method on an invalid QUrlInfo object and pass a valid data, the object becomes valid.

See also
group(), isValid()
void QUrlInfo::setLastModified ( const QDateTime dt)
virtual

Specifies that the object the URL refers to was last modified at dt.

If you call this method on an invalid QUrlInfo object and pass a valid data, the object becomes valid.

See also
lastModified(), isValid()
void QUrlInfo::setLastRead ( const QDateTime dt)

Specifies that the object the URL refers to was last read at dt.

If you call this method on an invalid QUrlInfo object and pass a valid data, the object becomes valid.

See also
lastRead(), isValid()
void QUrlInfo::setName ( const QString name)
virtual

Sets the name of the URL to name. The name is the full text, for example, "https://www.copperspice.com/docs/cs_api/index.html".

If you call this method on an invalid QUrlInfo object and pass valid data, the object becomes valid.

See also
name(), isValid()
void QUrlInfo::setOwner ( const QString s)
virtual

Specifies that the owner of the URL is called s. If you call this method on an invalid QUrlInfo object and pass a valid data, the object becomes valid.

See also
owner(), isValid()
void QUrlInfo::setPermissions ( int  p)
virtual

Specifies that the URL has access permissions p.

If you call this method on an invalid QUrlInfo object and pass a valid data, the object becomes valid.

See also
permissions(), isValid()
void QUrlInfo::setReadable ( bool  b)
virtual

Specifies that the URL is readable if b is true and not readable if b is false.

If you call this method on an invalid QUrlInfo object and pass a valid data, the object becomes valid.

See also
isReadable(), isValid()
void QUrlInfo::setSize ( qint64  size)
virtual

Specifies the size of the URL.

If you call this method on an invalid QUrlInfo object and pass a valid data, the object becomes valid.

See also
size(), isValid()
void QUrlInfo::setSymLink ( bool  b)
virtual

Specifies that the URL refers to a symbolic link if b is true and that it does not if b is false.

If you call this method on an invalid QUrlInfo object and pass a valid data, the object becomes valid.

See also
isSymLink(), isValid()
void QUrlInfo::setWritable ( bool  b)
virtual

Specifies that the URL is writable if b is true and not writable if b is false.

If you call this method on an invalid QUrlInfo object and pass a valid data, the object becomes valid.

See also
isWritable(), isValid()
qint64 QUrlInfo::size ( ) const

Returns the size of the URL.

See also
setSize(), isValid()