libgnomevfsmm  2.26.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gnome::Vfs::FileInfo Class Reference

#include <file-info.h>

Public Member Functions

void reference () const
 
void unreference () const
 
GnomeVFSFileInfo * gobj ()
 Provides access to the underlying C instance. More...
 
const GnomeVFSFileInfo * gobj () const
 Provides access to the underlying C instance. More...
 
GnomeVFSFileInfo * gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
void clear ()
 Clears the attributes so they are ready to accept new data. More...
 
Glib::ustring get_mime_type () const
 Retrieve MIME type from this object. More...
 
Glib::RefPtr< FileInfoduplicate ()
 Duplicates orig and returns it. More...
 
std::string get_name () const
 Get the name property of this FileInfo. More...
 
FileType get_type () const
 Get the file type of this FileInfo. More...
 
FilePermissions get_permissions () const
 Get the permissions of this FileInfo. More...
 
FileFlags get_flags () const
 Get the special flags of this FileInfo. More...
 
guint get_link_count () const
 Get the link count of this FileInfo. More...
 
guint get_uid () const
 Get the user id of this FileInfo. More...
 
guint get_gid () const
 Get the group id of this FileInfo. More...
 
FileSize get_size () const
 Get the size of this FileInfo. More...
 
FileSize get_block_count () const
 Get the size of this FileInfo. More...
 
guint get_io_block_size () const
 Get the I/O block size of this FileInfo. More...
 
time_t get_access_time () const
 Get the access time of this FileInfo. More...
 
time_t get_modification_time () const
 Get the modification time of this FileInfo. More...
 
time_t get_creation_time () const
 Get the creation time of this FileInfo. More...
 
std::string get_symlink_name () const
 Get the symlink name of this FileInfo. More...
 
bool is_symlink () const
 Find out if this FileInfo is a symbolic link. More...
 

Static Public Member Functions

static Glib::RefPtr< FileInfocreate ()
 

Protected Member Functions

 FileInfo ()
 
void operator delete (void *, size_t)
 

Related Functions

(Note that these are not member functions.)

bool operator== (const FileInfo &lhs, const FileInfo &rhs)
 
bool operator!= (const FileInfo &lhs, const FileInfo &rhs)
 
Glib::RefPtr< Gnome::Vfs::FileInfowrap (GnomeVFSFileInfo *object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Constructor & Destructor Documentation

Gnome::Vfs::FileInfo::FileInfo ( )
protected

Member Function Documentation

void Gnome::Vfs::FileInfo::clear ( )

Clears the attributes so they are ready to accept new data.

static Glib::RefPtr<FileInfo> Gnome::Vfs::FileInfo::create ( )
static
Glib::RefPtr<FileInfo> Gnome::Vfs::FileInfo::duplicate ( )

Duplicates orig and returns it.

Returns
A new file information struct that duplicates the information in orig.
time_t Gnome::Vfs::FileInfo::get_access_time ( ) const

Get the access time of this FileInfo.

Returns
The time.
FileSize Gnome::Vfs::FileInfo::get_block_count ( ) const

Get the size of this FileInfo.

This is the size of the file measured in units of 512-byte blocks.

Returns
The size.
time_t Gnome::Vfs::FileInfo::get_creation_time ( ) const

Get the creation time of this FileInfo.

Returns
The time.
FileFlags Gnome::Vfs::FileInfo::get_flags ( ) const

Get the special flags of this FileInfo.

Returns
A FileFlags representing the special flags.
guint Gnome::Vfs::FileInfo::get_gid ( ) const

Get the group id of this FileInfo.

Returns
The gid.
guint Gnome::Vfs::FileInfo::get_io_block_size ( ) const

Get the I/O block size of this FileInfo.

This is used to determine the optimal block size for reading/writing the file.

Returns
The block size.
guint Gnome::Vfs::FileInfo::get_link_count ( ) const

Get the link count of this FileInfo.

Returns
The number of links.
Glib::ustring Gnome::Vfs::FileInfo::get_mime_type ( ) const

Retrieve MIME type from this object.

Returns
A pointer to a string representing the MIME type.
time_t Gnome::Vfs::FileInfo::get_modification_time ( ) const

Get the modification time of this FileInfo.

Returns
The time.
std::string Gnome::Vfs::FileInfo::get_name ( ) const

Get the name property of this FileInfo.

Returns
A string containing the name.
FilePermissions Gnome::Vfs::FileInfo::get_permissions ( ) const

Get the permissions of this FileInfo.

Returns
A FilePermissions representing the permissions.
FileSize Gnome::Vfs::FileInfo::get_size ( ) const

Get the size of this FileInfo.

This is the size of the file in bytes.

Returns
The size.
std::string Gnome::Vfs::FileInfo::get_symlink_name ( ) const

Get the symlink name of this FileInfo.

Returns
If this FileInfo is a symlink, the file this FileInfo points to.
FileType Gnome::Vfs::FileInfo::get_type ( ) const

Get the file type of this FileInfo.

Returns
A FileType representing the file type.
guint Gnome::Vfs::FileInfo::get_uid ( ) const

Get the user id of this FileInfo.

Returns
The uid.
GnomeVFSFileInfo* Gnome::Vfs::FileInfo::gobj ( )

Provides access to the underlying C instance.

const GnomeVFSFileInfo* Gnome::Vfs::FileInfo::gobj ( ) const

Provides access to the underlying C instance.

GnomeVFSFileInfo* Gnome::Vfs::FileInfo::gobj_copy ( ) const

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

bool Gnome::Vfs::FileInfo::is_symlink ( ) const

Find out if this FileInfo is a symbolic link.

In order for this to work, this FileInfo must be created using FILE_INFO_FOLLOW_LINKS.

Returns
true if it is a sym link, otherwise false.
void Gnome::Vfs::FileInfo::operator delete ( void *  ,
size_t   
)
protected
void Gnome::Vfs::FileInfo::reference ( ) const
void Gnome::Vfs::FileInfo::unreference ( ) const

Friends And Related Function Documentation

bool operator!= ( const FileInfo lhs,
const FileInfo rhs 
)
related
Parameters
lhsThe left-hand side
rhsThe right-hand side
Returns
The result
bool operator== ( const FileInfo lhs,
const FileInfo rhs 
)
related
Parameters
lhsThe left-hand side
rhsThe right-hand side
Returns
The result
Glib::RefPtr< Gnome::Vfs::FileInfo > wrap ( GnomeVFSFileInfo *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

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