PushModule Class Reference

Inheritance diagram for PushModule:

List of all members.

Public Member Functions
virtual BOOL	Init ()
	Called after module's constructor to ask it whether it wants to exist or not. Each module is asked in two passes, so that its existence can depend on another module. If a module does not want to exist, it should return FALSE, whereupon it will be deleted.
virtual UINT32	GetInterfaceVersion ()
virtual UINT32	GetInfoVersion ()
virtual void	Describe (void *Info)
	Asks a module for more information. The pointer points to a struct such as ModInfo_v1 which the module should fill in. All fields should be filled (NULL is OK for char* variables). The type of the pointer is not explicitly defined so the structure can evolve while keeping backward compatibility.
virtual void *	CreateTool (UINT32 ToolID)
	Provide a clean interface from module to kernel code for the creation of tools.

---

Detailed Description

Definition at line 151 of file pushbase.cpp.

---

Member Function Documentation

void * PushModule::CreateTool (  UINT32  Type  )  [virtual]

Provide a clean interface from module to kernel code for the creation of tools. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/93 Parameters: ToolNumber  - The number of the tool to create (1 to NumTools) [INPUTS] -  [OUTPUTS] Returns: Pointer to the new instantiation of the desired tool. Errors: - Reimplemented from Module_v1. Definition at line 196 of file pushbase.cpp. { if (Type==1) return NULL; //new ZoomTool; if (Type==2) return new PushTool; if (Type==3) return NULL; //new FreeHandTool; if (Type==4) return new PenTool; if (Type==5) return NULL; //new BlendTool; if (Type==6) return new BezierTool; if (Type==7) return new GradFillTool; if (Type==8) return new TranspTool; if (Type==9) return new GridTool; if (Type==10) return new RectangleTool; if (Type==11) return new QuickShapeTool; if (Type==12) return new MouldTool; if (Type==13) return new BlankTool; return NULL; }

void PushModule::Describe (  void *  Info  )  [virtual]

Asks a module for more information. The pointer points to a struct such as ModInfo_v1 which the module should fill in. All fields should be filled (NULL is OK for char* variables). The type of the pointer is not explicitly defined so the structure can evolve while keeping backward compatibility. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 21/6/93 Parameters: Pointer  to area to recieve info [INPUTS] Info  area is updated [OUTPUTS] Returns: None Errors: None Reimplemented from Module_v1. Definition at line 176 of file pushbase.cpp. { // Cast the pointer into one we understand... ModInfo_v1 *ModInfo = (ModInfo_v1 *) Info; // ...and fill in the fields ModInfo->InfoVersion = 1; ModInfo->InterfaceVersion = GetInterfaceVersion(); ModInfo->Version = 1; ModInfo->ID = MODULEID_PUSH; ModInfo->NumTools = 13; ModInfo->Name = Name; ModInfo->Purpose = Purpose; ModInfo->Author = Author; }

virtual UINT32 PushModule::GetInfoVersion (   )  [inline, virtual]

Definition at line 161 of file pushbase.cpp. { return 1; };

virtual UINT32 PushModule::GetInterfaceVersion (   )  [inline, virtual]

Reimplemented from Module_v1. Definition at line 158 of file pushbase.cpp. { return 1; } ;

BOOL PushModule::Init (  void   )  [virtual]

Called after module's constructor to ask it whether it wants to exist or not. Each module is asked in two passes, so that its existence can depend on another module. If a module does not want to exist, it should return FALSE, whereupon it will be deleted. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 21/6/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if OK, FALSE if module doesn't want to initialise. Errors: None Reimplemented from Module_v1. Definition at line 171 of file pushbase.cpp. { return TRUE; }

---

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

• tools/pushbase.cpp (r1785/r1282)

---