Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_CFBundle Class Reference

A class to handle a MacOS CFBundle.

Inheritance diagram for CP_CFBundle:

CP_Bundle List of all members.

Getters

CP_CFURL GetURL () const
CP_CFURL GetResourceURL () const
CP_CFURL GetResourceURL (const CP_String &inFileName, const CP_String &inExtension) const
CFBundleRef GetOSBundle () const
OSType GetPackageCreator () const
OSType GetPackageType () const
CP_String GetShortVersionString () const
CP_String GetCopyrightString () const
CFTypeRef GetValueForDictionaryKey (const CP_String &inKey) const

Public Member Functions

Constructor / Destructor
 CP_CFBundle ()
 Constructor.
 CP_CFBundle (CP_ResourcePtr< CFBundleRef > inBundleRef)
 CP_CFBundle (CFBundleRef inBundleRef)
 CP_CFBundle (const CP_CFBundle &inBundle)
virtual ~CP_CFBundle () throw ()
 Destructor.
operators
CP_CFBundle & operator= (const CP_CFBundle &inBundle)

Protected Attributes

CFBundleRef fBundleRef
OSType fCreator
OSType fType

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_CFBundle::CP_CFBundle (   ) 
 

Constructor.

Exceptions:
none 

CP_CFBundle::CP_CFBundle (  CP_ResourcePtr< CFBundleRef >  inBundleRef  )  [explicit]
 

Constructor.

Parameters:
inBundleRef An existing CFBundleRef.
Exceptions:
none 

CP_CFBundle::CP_CFBundle (  CFBundleRef  inBundleRef  )  [explicit]
 

Constructor.

Parameters:
inBundleRef An existing CFBundleRef.
Exceptions:
none 

CP_CFBundle::CP_CFBundle (  const CP_CFBundle &  inBundle  ) 
 

Constructor.

Parameters:
inBundle CP_CFBunder object to copy fields from.
Exceptions:
none 

CP_CFBundle::~CP_CFBundle (   )  throw () [virtual]
 

Destructor.

Exceptions:
none 

Member Function Documentation

CP_CFURL CP_CFBundle::GetURL (   )  const
 

Returns a CP_CFURL object that points to this bundle.

Exceptions:
none 
Returns:
CP_CFURL A CP_CFURL that points to this bundle.

CP_CFURL CP_CFBundle::GetResourceURL (   )  const
 

Returns a CP_CFURL object that points to the resources URL inn the bundle.

Exceptions:
none 
Returns:
CP_CFURL A CP_CFURL that points to the resources URL in the bunndle.

CP_CFURL CP_CFBundle::GetResourceURL (  const CP_String &  inFileName,
const CP_String &  inExtension
)  const
 

Returns a CP_CFURL object that points to a file in the resource folder of the main bundle.

Parameters:
inFileName Name of the file to retrieve.
inExtension Extension of the file to retrieve.
Exceptions:
none 
Returns:
CP_CFURL A CP_CFURL that points to the resources URL in the bunndle.

CFBundleRef CP_CFBundle::GetOSBundle (   )  const
 

Return the MacOS CFBundleRef for this bundle.

Exceptions:
none 
Returns:
CFBundleRef MacOS CFBundleRef for this bundle.

OSType CP_CFBundle::GetPackageCreator (   )  const
 

Return the MacOS package creator code for the bundle.

Exceptions:
none 
Returns:
OSType The MacOS page creator code for the bundle.

Reimplemented in CP_Bundle.

OSType CP_CFBundle::GetPackageType (   )  const
 

Return the MacOS package type for the bundle.

Exceptions:
none 
Returns:
OSType The MacOS package type for the bundle.

Reimplemented in CP_Bundle.

CP_String CP_CFBundle::GetShortVersionString (   )  const
 

Returns the short version string from the bundle. This will be the string with the key - CFBundleShortVersionString in the plist file.

Exceptions:
none 
Returns:
CP_String const The short version string.

Reimplemented in CP_Bundle.

CP_String CP_CFBundle::GetCopyrightString (   )  const
 

Returns the copyright string from the bundle. This will be the string with the key - NSHumanReadableCopyright in the plist file.

Exceptions:
none 
Returns:
CP_String const The copyright string.

Reimplemented in CP_Bundle.

CFTypeRef CP_CFBundle::GetValueForDictionaryKey (  const CP_String &  inKey  )  const
 

Returns the value for the passed in dictionary key.

Exceptions:
none 
Returns:
CFTypeRef The value of the found key.

CP_CFBundle & CP_CFBundle::operator= (  const CP_CFBundle &  inBundle  ) 
 

Assignment operator.

Parameters:
inBundleRef An existing CFBundleRefRef.
Exceptions:
none 

bool CP_CFBundle::IsValid (   ) 
 

Returns true if the object represents a bundled object in the MacOS system.

Exceptions:
none 
Returns:
bool True if this represents a valid bundle object.

Member Data Documentation

CFBundleRef CP_CFBundle::fBundleRef [protected]
 

OSType CP_CFBundle::fCreator [protected]
 

The bundle we manage.

OSType CP_CFBundle::fType [protected]
 

Creator code of the bundle.

The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:01:24 2005 for CPLAT by  doxygen 1.4.0