Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

WizOp Class Reference

The Camelot Text file format supports templating. Each argument to a template is processed by a WizOp. The WizOp's extracted from the registry, which this class represents, are then Available Properties in the Wizard Properties dialog. More...

#include <tmpltarg.h>

Inheritance diagram for WizOp:

ListItem CCObject SimpleCCObject List of all members.

Public Member Functions

 WizOp (const StringBase &InternalName, const StringBase &UserName, const StringBase &ParamHint)
 This constructor provides the Wizard Properties with something to talk about.
const StringBase & GetInternalName () const
 Allows access to the WizOp's vital statistics.
const StringBase & GetUserName () const
const StringBase & GetParamHint () const

Private Member Functions

 CC_DECLARE_MEMDUMP (WizOp)

Private Attributes

const String_256 m_Name
const String_256 m_UserName
const String_256 m_ParamHint

Detailed Description

The Camelot Text file format supports templating. Each argument to a template is processed by a WizOp. The WizOp's extracted from the registry, which this class represents, are then Available Properties in the Wizard Properties dialog.

Author:
Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com> G.Barfoot
Date:
11/06/97

Definition at line 120 of file tmpltarg.h.

Constructor & Destructor Documentation

WizOp::WizOp (  const StringBase &  InternalName,
const StringBase &  UserName,
const StringBase &  ParamHint
) 
 

This constructor provides the Wizard Properties with something to talk about.

Author:
Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com>
Date:
09/06/97
Parameters:
InternalName : a persistant identifier for the WizOp. The CLSID of the entry [INPUTS] extracted from the registry would be good. UserName : the text that will appear in the Wizard Properties dialog. The "UserName" subkey under the InternalName (CLSID) is good. ParamHint: If the WizOp can accept a parameter this string should contain some text explaining what it is.

Definition at line 524 of file tmpltarg.cpp.

00525                                              :
00526     m_Name(InternalName),
00527     m_UserName(UserName),
00528     m_ParamHint(ParamHint)
00529 {
00530 }

Member Function Documentation

WizOp::CC_DECLARE_MEMDUMP (  WizOp   )  [private]
 

const StringBase & WizOp::GetInternalName (   )  const
 

Allows access to the WizOp's vital statistics.

Author:
Colin_Barfoot (Xara Group Ltd) <camelotdev@xara.com>
Date:
09/06/97
Returns:
Strings of things

Definition at line 547 of file tmpltarg.cpp.

00548 {
00549     return (StringBase&)m_Name;
00550 }

const StringBase & WizOp::GetParamHint (   )  const
 

Definition at line 559 of file tmpltarg.cpp.

00560 {
00561     return (StringBase&)m_ParamHint;
00562 }

const StringBase & WizOp::GetUserName (   )  const
 

Definition at line 553 of file tmpltarg.cpp.

00554 {
00555     return (StringBase&)m_UserName;
00556 }

Member Data Documentation

const String_256 WizOp::m_Name [private]
 

Definition at line 134 of file tmpltarg.h.

const String_256 WizOp::m_ParamHint [private]
 

Definition at line 136 of file tmpltarg.h.

const String_256 WizOp::m_UserName [private]
 

Definition at line 135 of file tmpltarg.h.

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 04:03:10 2007 for Camelot by  doxygen 1.4.4