InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MediaLocation Class Reference

#include <MediaLocation.h>

Public Member Functions

 MediaLocation ()
 
 MediaLocation (PMString locationString, bool16 isURL=kFalse)
 
 MediaLocation (const MediaLocation &orig)
 
MediaLocationoperator= (const MediaLocation &copy)
 
bool16 operator== (const MediaLocation &ml) const
 
bool16 operator!= (const MediaLocation &ml) const
 
virtual PMString GetString () const
 
virtual PMString GetExtensionString () const
 
virtual bool16 IsFile () const
 
virtual bool16 IsURL () const
 

Detailed Description

This class encapsulates and abstracts the location of media content. The location can be specified either as the absolute path to a local file, or as a URL. This class is useful when you need to maintain the fact that a string represents a local file path or a URL.

Constructor & Destructor Documentation

MediaLocation::MediaLocation ()
inline

Default contructor.

MediaLocation::MediaLocation (PMString locationString,
bool16 isURL = kFalse 
)
inline

Constructs a MediaLocation object for either a local file or a URL.

MediaLocation::MediaLocation (const MediaLocationorig)
inline

Copy constructor.

Member Function Documentation

virtual PMString MediaLocation::GetExtensionString () const
inlinevirtual

Determines the extension of the file.

Returns
a PMString containing the extension of the file or URL.
virtual PMString MediaLocation::GetString (void ) const
inlinevirtual

Accesses the location string.

Returns
a PMString object of a local file path or a URL.
virtual bool16 MediaLocation::IsFile () const
inlinevirtual

Tests if the location is a file.

Returns
kTrue if file; kFalse otherwise.
virtual bool16 MediaLocation::IsURL () const
inlinevirtual

Tests if the location is a URL.

Returns
kTrue if URL, kFalse otherwise.
bool16 MediaLocation::operator!= (const MediaLocationml) const
inline

Non-equivalence operator for MediaLocation variables.

MediaLocation& MediaLocation::operator= (const MediaLocationcopy)
inline

Assignment operator for MediaLocation variables.

bool16 MediaLocation::operator== (const MediaLocationml) const
inline

Equivalence operator for MediaLocation variables.