AppInfo Class Reference

#include <AppInfo.h>

Public Types
typedef object_type	data_type

Public Member Functions
	AppInfo (const PMString &path, const PMString &displayName, const PMString &version, const bool16 defaultApp=kFalse, const bool16 adobeApp=kFalse)
	AppInfo (const AppInfo &info)
PMString	GetPath () const
PMString	GetDisplayName () const
PMString	GetVersion () const
bool16	GetIsDefault () const
bool16	GetIsAdobeApp () const
bool16	operator== (const AppInfo &other) const
bool16	operator< (const AppInfo &other) const

Detailed Description

Class that contains information about applications, used Edit Original/Edit With functionality. AppInfo is used to launch a specific application for a linked file in an external editor. In general, clients should not need to contruct this class, but rather gather a list of applications that can edit a particular link or link resource via GetEditOriginalEditor and GetEditorList respectively. Given an empty AppInfoList, these APIs will gather all the editors for a link in the form of a list of AppInfo classes/structures. Then ILinkResource->Edit may be used to edit a link via launching an external editor specified with a particular AppInfo.

See Also

ILinksUIUtils.h, GetEditOriginalEditorList

ILinksUIUtils.h, EditOriginal

ILinksUtils.h, GetEditorList

ILinkResource.h, Edit

Constructor & Destructor Documentation

AppInfo::AppInfo ( const AppInfo &  info )

inline

Copy Constructor

Member Function Documentation

PMString AppInfo::GetDisplayName ( ) const

inline

A more user-friendly name with version info appended. Used for menu display. e.g. Adobe Photoshop CS3

Parameters

none

Returns

PMString

bool16 AppInfo::GetIsAdobeApp ( ) const

inline

Return if application is considered an Adobe application. Used for sorting and menu display purposes.

Parameters

none

Returns

kTrue if a well-known Adobe app, kFalse otherwise.

bool16 AppInfo::GetIsDefault ( ) const

inline

Is this the default application for a file type (via IEditFile.h or IDataLinkAction.h)

Parameters

none

Returns

kTrue if it's the default app, kFalse if not.

PMString AppInfo::GetPath ( ) const

inline

Return the path to the application. On Windows, might look like this: C: Files Photoshop CS3\Photoshop.exe On Mac, might look like this: /Applications/Safari.app

Parameters

none

Returns

PMString

PMString AppInfo::GetVersion ( ) const

inline

Return a version string. e.g. CS3 or 5.1

Parameters

none

Returns

PMString

bool16 AppInfo::operator< ( const AppInfo &  other ) const

inline

Less than(<) operator for comparison. Sort by Adobe status, then by display name. If display names are equal, sort by version number.

Parameters

other

IN the object to compare with.

Returns

bool16 kTrue means less than, otherwise kFalse.

bool16 AppInfo::operator== ( const AppInfo &  other ) const

inline

Don't care about fIsDefaultApp or fIsAdobeApp for comparison purposes