UnitListComponentClass Class Reference

Provide a class that will add Unit List components to new documents. More...

#include <unitcomp.h>

Inheritance diagram for UnitListComponentClass:

List of all members.

Public Member Functions
BOOL	AddComponent (BaseDocument *)
	Add a unit list component to the specified document.
Static Public Member Functions
static BOOL	Init ()
	Register the unit list document component with the main application.

---

Detailed Description

Provide a class that will add Unit List components to new documents.

Author:

Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>

Date:

23/07/96

See also:

DocComponentClass

Definition at line 120 of file unitcomp.h.

---

Member Function Documentation

BOOL UnitListComponentClass::AddComponent (  BaseDocument *  pDocument  )  [virtual]

Add a unit list component to the specified document. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 23/07/96 Parameters: pDocument  - the document to add the unit list to. [INPUTS] Returns: TRUE if the unit list was added ok; FALSE if not. Errors: Out of memory See also: UnitListComponentClass Implements DocComponentClass. Definition at line 183 of file unitcomp.cpp. { // Check to see if this document already has a colour list; if so, leave it alone. if (pDocument->GetDocComponent(CC_RUNTIME_CLASS(UnitListComponent)) != NULL) return TRUE; // Ok - create the colour list component using this list. UnitListComponent *pComponent = new UnitListComponent(); if (pComponent == NULL) { // Out of memory... return FALSE; } // All ok - add the component to the document. pDocument->AddDocComponent(pComponent); return TRUE; }

BOOL UnitListComponentClass::Init (  void   )  [static]

Register the unit list document component with the main application. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 23/07/96 Returns: TRUE if all went well; FALSE if not. Errors: Out of memory. See also: DocComponent Reimplemented from SimpleCCObject. Definition at line 153 of file unitcomp.cpp. { // Instantiate a component class to register with the application. UnitListComponentClass *pClass = new UnitListComponentClass; if (pClass == NULL) return FALSE; // Register it GetApplication()->RegisterDocComponent(pClass); // All ok return TRUE; }

---

The documentation for this class was generated from the following files:

• Kernel/unitcomp.h (r1785/r1282)
• Kernel/unitcomp.cpp (r1785/r1282)

---