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

#include <MBaseResourceAccess.h>

Inheritance diagram for MBaseResourceAccess:
IResourceAccessMResourceAccess

Classes

struct  ResourceFileInfo
 

Public Member Functions

 MBaseResourceAccess ()
 
 MBaseResourceAccess (ResourceFileInfo *resFileInfo)
 
 MBaseResourceAccess (const IDFile *resourceFile, ResourceFileInfo *)
 
 MBaseResourceAccess (const CFBundleRef bundleRef, ResourceFileInfo *)
 
 MBaseResourceAccess (PluginID plugin, ResourceFileInfo *)
 
virtual ~MBaseResourceAccess ()
 
virtual const IDFileGetResourceFile ()
 
ResourceFileInfoGetResourceFileInfo ()
 

Static Public Member Functions

static void SetAppResource (const int16 appRefNum)
 

Detailed Description

Macintosh implementation class behind MResourceAccess.

MResourceAccess is a shallow implementation that is compiled into every plugin and shared library

so that every plugin has it's own copy of the static data used to retain the resource file information

for a plugin. MBaseResourceAccess contains the majority of the actual implementation.

See Also
ResourceEnabler, MResourceAccess

[[DEPRECATED]] For modernized implementation of this class

See Also
MBaseResourceAccessX

Constructor & Destructor Documentation

MBaseResourceAccess::MBaseResourceAccess ()

Unused - implementation simply asserts

MBaseResourceAccess::MBaseResourceAccess (ResourceFileInforesFileInfo)

Uses the resource file local to the plugin containing the call (passed in resFileInfo). Assertion violation if SetResourceFile or SetPluginBundle hasn't been called.

MBaseResourceAccess::MBaseResourceAccess (const IDFileresourceFile,
ResourceFileInfo 
)

Uses the specified resource file. Assumes that the IDFile* will be valid as long as "this" is valid.

MBaseResourceAccess::MBaseResourceAccess (const CFBundleRef bundleRef,
ResourceFileInfo 
)

Uses the specified bundle's resources. Assumes that the CFBundleRef will be valid as long as "this" is valid.

MBaseResourceAccess::MBaseResourceAccess (PluginID plugin,
ResourceFileInfo 
)

Uses the specified plugin's resources. Assumes that the plugin is loaded as long as "this" is valid.

virtual MBaseResourceAccess::~MBaseResourceAccess ()
virtual

Closes the resource file (or caches it).

Member Function Documentation

virtual const IDFile* MBaseResourceAccess::GetResourceFile ()
virtual

Retrieves the resource file - note that there will not be one if a Mac based plugin is bundled.

Implements IResourceAccess.

ResourceFileInfo* MBaseResourceAccess::GetResourceFileInfo ()
inline

Retrieves the resource file info which can be used to determine if a resource file or bundle is being used and to obtain them.

static void MBaseResourceAccess::SetAppResource (const int16 appRefNum)
static

Called during runtime initialization to set up the resource file for the application. Should only be called once.