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

CP_Nib Class Reference

A class to handle loading and management of MacOS Nibs.

Inheritance diagram for CP_Nib:

CP_NoCopy List of all members.

Public Member Functions

Constructor / Destructor
 CP_Nib ()
 Constructor.
virtual ~CP_Nib () throw ()
 Destructor.
Menus
CP_Menu * LoadMenu (CP_CFBundle &inBundle, const CP_String &inNibFileName, const CP_String &inMenuName)
Windows
CP_Window * LoadWindow (CP_CFBundle &inBundle, const CP_String &inNibFileName, const CP_String &inWindowName)

Protected Member Functions

Misc
CP_Window * ConvertWindowInNib (CP_FileSystemSpec &inNibSpec, const CP_String &inWindowName)
void BuildNibNameMap (CP_XMLDocNode *inRootNode)
CP_Window * FindIBCarbonWindowNode (CP_XMLDocNode *inParentNode, const CP_String &inWindowName)
CP_String FindWindowRefFromRefID (CP_String &inRefID)
void CreateXMLWriter (CP_XMLWriter_Element **inOutRootElement, CPLAT::CP_XMLWriter_Element **inOutParentElement)

Protected Attributes

IBNibRef fNibRef
CP_NibNameToRefRun_Map fNibNameToRefMap

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_Nib::CP_Nib (   ) 
 

Constructor.

Exceptions:
none 

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

Destructor.

Exceptions:
none 

Member Function Documentation

CP_Menu * CP_Nib::LoadMenu (  CP_CFBundle &  inBundle,
const CP_String &  inNibFileName,
const CP_String &  inMenuName
) 
 

Load a menu from the bundle resources specified in the passed in bundle.

Parameters:
inBundle Name of the bundle.
inNibFileName Name of the nib file in the bundle.
inMenuName Name of the menu in the nib.
Exceptions:
none 

CP_Window * CP_Nib::LoadWindow (  CP_CFBundle &  inBundle,
const CP_String &  inNibFileName,
const CP_String &  inWindowName
) 
 

Load a window from the bundle resources specified in the passed in bundle.

Parameters:
inBundle Name of the bundle.
inNibFileName Name of the nib file in the bundle.
inMenuName Name of the window in the nib.
Exceptions:
none 

CP_Window * CP_Nib::ConvertWindowInNib (  CP_FileSystemSpec &  inNibSpec,
const CP_String &  inWindowName
)  [protected]
 

Helper routine to find and convert the window in the nib file with the specified window name.

Parameters:
inNibSpec File system spec of the nib.
inWindowName Name of the window.
Exceptions:
none 
Returns:
CP_Window * The converted window.

void CP_Nib::BuildNibNameMap (  CP_XMLDocNode *  inRootNode  )  [protected]
 

Construct the names of objects in the nib from the XML represented by the passed in root node.

Parameters:
inRootNode The root node of the XML we are going to find the objects name in.
Exceptions:
none 
Returns:
void

CP_Window * CP_Nib::FindIBCarbonWindowNode (  CP_XMLDocNode *  inParentNode,
const CP_String &  inWindowName
)  [protected]
 

Finds and returns the CP_Window from the passed in XML document node.

Parameters:
inParentNode Parent node containing the XML data.
inWindowName Name of the widnow.
Exceptions:
none 
Returns:
CP_Window * Constructed CP_Window object.

CP_String CP_Nib::FindWindowRefFromRefID (  CP_String &  inRefID  )  [protected]
 

Finds the window references from the passed in reference.

Parameters:
inRefID The reference id to locate the window.
Exceptions:
none 
Returns:
CP_String The name of the window.

void CP_Nib::CreateXMLWriter (  CP_XMLWriter_Element **  inOutRootElement,
CPLAT::CP_XMLWriter_Element **  inOutParentElement
)  [protected]
 

Member Data Documentation

IBNibRef CP_Nib::fNibRef [protected]
 

CP_NibNameToRefRun_Map CP_Nib::fNibNameToRefMap [protected]
 

The documentation for this class was generated from the following files:
Generated on Tue Sep 20 20:21:53 2005 for CPLAT_MacOS by  doxygen 1.4.0