pp::DirectoryEntry Class Reference

#include <directory_entry.h>

Collaboration diagram for pp::DirectoryEntry:

Public Member Functions
	DirectoryEntry ()
	DirectoryEntry (PassRef, const PP_DirectoryEntry &data)
	DirectoryEntry (const DirectoryEntry &other)
	~DirectoryEntry ()
DirectoryEntry &	operator= (const DirectoryEntry &other)
bool	is_null () const
FileRef	file_ref () const
PP_FileType	file_type () const

Detailed Description

The DirectoryEntry class represents information about a directory entry.

Definition at line 24 of file directory_entry.h.

Constructor & Destructor Documentation

pp::DirectoryEntry::DirectoryEntry

(

)

Default constructor for creating an is_null() DirectoryEntry object.

Definition at line 14 of file directory_entry.cc.

pp::DirectoryEntry::DirectoryEntry	(	PassRef	,
		const PP_DirectoryEntry &	data
	)

A constructor used when you have a PP_DirectoryEntry which contains a FileRef that has already been reference counted as a return value.

Parameters

[in]

data

A PP_DirectoryEntry to be copied.

Definition at line 18 of file directory_entry.cc.

pp::DirectoryEntry::DirectoryEntry

(

const DirectoryEntry &

other

)

A copy constructor for DirectoryEntry. This constructor increments a reference count of the FileRef held by this DirectoryEntry.

Parameters

[in]

other

A pointer to a DirectoryEntry.

Definition at line 24 of file directory_entry.cc.

References pp::Core::AddRefResource(), pp::Module::core(), and pp::Module::Get().

pp::DirectoryEntry::~DirectoryEntry

(

)

A destructor that decrements a reference count of the FileRef held by this DirectoryEntry.

Definition at line 31 of file directory_entry.cc.

References pp::Module::core(), pp::Module::Get(), and pp::Core::ReleaseResource().

Member Function Documentation

FileRef pp::DirectoryEntry::file_ref ( ) const

inline

This function returns the FileRef held by this DirectoryEntry.

Returns

A FileRef of the file.

Definition at line 68 of file directory_entry.h.

PP_FileType pp::DirectoryEntry::file_type ( ) const

inline

This function returns the PP_FileType of the file referenced by this DirectoryEntry.

Returns

A PP_FileType of the file.

Definition at line 74 of file directory_entry.h.

bool pp::DirectoryEntry::is_null ( ) const

inline

This function determines if this DirectoryEntry is a null value.

Returns

true if this DirectoryEntry is null, otherwise false.

Definition at line 62 of file directory_entry.h.

DirectoryEntry & pp::DirectoryEntry::operator=

(

const DirectoryEntry &

other

)

This function assigns one DirectoryEntry object to this DirectoryEntry object. This function increases the reference count of the FileRef of the other DirectoryEntry while decrementing the reference count of the FileRef of this DirectoryEntry.

Parameters

[in]

other

A pointer to a DirectoryEntry.

Returns

A new DirectoryEntry object.

Definition at line 36 of file directory_entry.cc.

References pp::Core::AddRefResource(), pp::Module::core(), pp::Module::Get(), and pp::Core::ReleaseResource().

---

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

• directory_entry.h
• directory_entry.cc