IShPartUtilities Struct Reference
[Shell Utilities]

Utilities for creating parts. More...

Inheritance diagram for IShPartUtilities:

IMCUnknown List of all members.

Public Member Functions

virtual MCCOMErr MCCOMAPI CreatePartByName (IMFPart **outPart, TMCString &inPartName, IDType inPartID, IDType inPartExtension)=0
virtual MCCOMErr MCCOMAPI CreatePartByResource (IMFPart **outPart, EMFResources inResType, ResourceID inResID)=0
virtual MCCOMErr MCCOMAPI CreateToolWindow (IMFPart **outWindow, ResourceID inTBARID, boolean isVertical, IDType inFamilyID)=0
virtual void MCCOMAPI CreateIMFWindow (IMFWindow **outWindow, const TMCWindowInfo &inWindowInfo)=0
virtual void MCCOMAPI CreateShowBackBufferWindow (IShowBackBufferWindow **outWindow, const TMCWindowInfo &inWindowInfo)=0
virtual void MCCOMAPI Alert (const TMCString &message)=0

Detailed Description

Utilities for creating parts.

Member Function Documentation

virtual void MCCOMAPI IShPartUtilities::Alert (  const TMCString &  message  )  [pure virtual]
 

Display an altert message.

Note:
Also available: IShUtilities::DoAlert() and IShUtilities::Alert()
Parameters:
message Text of the message to display to the user.

virtual void MCCOMAPI IShPartUtilities::CreateIMFWindow (  IMFWindow **  outWindow,
const TMCWindowInfo &  inWindowInfo
)  [pure virtual]
 

Creates a window according to the parameters in inWindowInfo.

Parameters:
outWindow Returns a pointer to the window created
inWindowInfo Window information for the window to create

virtual MCCOMErr MCCOMAPI IShPartUtilities::CreatePartByName (  IMFPart **  outPart,
TMCString &  inPartName,
IDType  inPartID,
IDType  inPartExtension
)  [pure virtual]
 

Creates a part by class name. Also allows you to specify the ID of the part extension to associate with this part, if any.

Parameters:
outPart Returns a pointer to the part created
inPartName String to specify name of part to create (ie "TMFCollapsiblePart")
inPartID ID to assign to the part (ie 'sndC')
inPartExtension ID of the part extension to create for this part (ie 'seqC')

virtual MCCOMErr MCCOMAPI IShPartUtilities::CreatePartByResource (  IMFPart **  outPart,
EMFResources  inResType,
ResourceID  inResID
)  [pure virtual]
 

Creates a part from a resource. Looks in the current resource file for a resource matching inResType with the ID specified by inResID.

See also:
CWhileInCompResFile
Parameters:
outPart Returns a pointer to the part created
inResType Type of resource to create (See MFPartTypes.h)
inResID Resource ID of the part to create

virtual void MCCOMAPI IShPartUtilities::CreateShowBackBufferWindow (  IShowBackBufferWindow **  outWindow,
const TMCWindowInfo &  inWindowInfo
)  [pure virtual]
 

Creates a ShowBackBufferWindow, which is generally used only by the application. Do not call.

Parameters:
outWindow Returns a pointer to the window created
inWindowInfo Window information for the window to create

virtual MCCOMErr MCCOMAPI IShPartUtilities::CreateToolWindow (  IMFPart **  outWindow,
ResourceID  inTBARID,
boolean  isVertical,
IDType  inFamilyID
)  [pure virtual]
 

Creates a tool window containing a toolbar from a TBAR resource.

See also:
CWhileInCompResFile
Parameters:
outWindow Returns a pointer to the part created
inTBARID Resource ID of the tool window to create
isVertical If true, creates a vertical tool bar window. If false, horizontal.
inFamilyID Family ID to assign to this toolbar window.

The documentation for this struct was generated from the following file:
Generated on Mon Mar 14 12:29:05 2005 for Carrara SDK Doc by  doxygen 1.3.9.1