OWLNext    7.0
Borland's Object Windows Library for the modern age
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
ocf::TAutoCommand Class Reference

Automation abstract base class for command objects. More...

#include <ocf/autodefs.h>

Public Types

typedef LPCTSTR(* TErrorMsgHook) (long errCode)
 
typedef bool(* TCommandHook) (TAutoCommand &cmdObj)
 

Public Member Functions

 TAutoCommand (int attr)
 
virtual ~TAutoCommand ()
 
virtual TAutoCommand * Undo ()
 
virtual int Record (TAutoStack &q)
 
virtual TAutoCommand & Invoke ()
 
virtual bool Validate ()
 
virtual void Execute ()
 
virtual long Report ()
 
virtual void Return (TAutoVal &v)
 
virtual void Transfer (TAutoTransfer &x)
 
void Fail (TXAuto::TError)
 
void SetFlag (int mask)
 
void ClearFlag (int mask)
 
bool TestFlag (int mask)
 
bool IsPropSet ()
 
TAutoSymbol * GetSymbol ()
 
void SetSymbol (TAutoSymbol *sym)
 

Static Public Member Functions

static TErrorMsgHook SetErrorMsgHook (TErrorMsgHook callback)
 
static TCommandHook SetCommandHook (TCommandHook callback)
 
static LPCTSTR LookupError (long errCode)
 

Protected Attributes

TAutoSymbol * Symbol
 
int Attr
 

Detailed Description

Automation abstract base class for command objects.

Definition at line 846 of file autodefs.h.

Member Typedef Documentation

◆ TCommandHook

typedef bool(* ocf::TAutoCommand::TCommandHook) (TAutoCommand &cmdObj)

Definition at line 866 of file autodefs.h.

◆ TErrorMsgHook

typedef LPCTSTR(* ocf::TAutoCommand::TErrorMsgHook) (long errCode)

Definition at line 863 of file autodefs.h.

Constructor & Destructor Documentation

◆ TAutoCommand()

ocf::TAutoCommand::TAutoCommand ( int attr)
inline

Definition at line 1820 of file autodefs.h.

◆ ~TAutoCommand()

virtual ocf::TAutoCommand::~TAutoCommand ( )
inlinevirtual

Definition at line 850 of file autodefs.h.

Member Function Documentation

◆ ClearFlag()

void ocf::TAutoCommand::ClearFlag ( int mask)
inline

Definition at line 1822 of file autodefs.h.

References Attr.

◆ Execute()

void ocf::TAutoCommand::Execute ( )
inlinevirtual

Definition at line 1938 of file autodefs.h.

◆ Fail()

void ocf::TAutoCommand::Fail ( TXAuto::TError err)
inline

Definition at line 1927 of file autodefs.h.

◆ GetSymbol()

TAutoSymbol * ocf::TAutoCommand::GetSymbol ( )
inline

Definition at line 1825 of file autodefs.h.

References Symbol.

◆ Invoke()

TAutoCommand & ocf::TAutoCommand::Invoke ( )
inlinevirtual

Definition at line 1931 of file autodefs.h.

References Execute().

◆ IsPropSet()

bool ocf::TAutoCommand::IsPropSet ( )
inline

Definition at line 1824 of file autodefs.h.

References ocf::asSet, and TestFlag().

◆ LookupError()

LPCTSTR ocf::TAutoCommand::LookupError ( long errCode)
inlinestatic

Definition at line 1827 of file autodefs.h.

◆ Record()

int ocf::TAutoCommand::Record ( TAutoStack & q)
inlinevirtual

Definition at line 1958 of file autodefs.h.

◆ Report()

long ocf::TAutoCommand::Report ( )
inlinevirtual

Definition at line 1942 of file autodefs.h.

◆ Return()

void ocf::TAutoCommand::Return ( TAutoVal & v)
inlinevirtual

Definition at line 1947 of file autodefs.h.

◆ SetCommandHook()

TAutoCommand::TCommandHook ocf::TAutoCommand::SetCommandHook ( TAutoCommand::TCommandHook callback)
inlinestatic

Definition at line 1968 of file autodefs.h.

◆ SetErrorMsgHook()

TAutoCommand::TErrorMsgHook ocf::TAutoCommand::SetErrorMsgHook ( TAutoCommand::TErrorMsgHook callback)
inlinestatic

Definition at line 1961 of file autodefs.h.

◆ SetFlag()

void ocf::TAutoCommand::SetFlag ( int mask)
inline

Definition at line 1821 of file autodefs.h.

References Attr.

◆ SetSymbol()

void ocf::TAutoCommand::SetSymbol ( TAutoSymbol * sym)
inline

Definition at line 1826 of file autodefs.h.

References Symbol.

◆ TestFlag()

bool ocf::TAutoCommand::TestFlag ( int mask)
inline

Definition at line 1823 of file autodefs.h.

References Attr, and owl::ToBool().

◆ Transfer()

void ocf::TAutoCommand::Transfer ( TAutoTransfer & x)
inlinevirtual

Definition at line 1952 of file autodefs.h.

◆ Undo()

TAutoCommand * ocf::TAutoCommand::Undo ( )
inlinevirtual

Definition at line 1956 of file autodefs.h.

◆ Validate()

bool ocf::TAutoCommand::Validate ( )
inlinevirtual

Definition at line 1929 of file autodefs.h.

Member Data Documentation

◆ Attr

int ocf::TAutoCommand::Attr
protected

Definition at line 881 of file autodefs.h.

◆ Symbol

TAutoSymbol* ocf::TAutoCommand::Symbol
protected

Definition at line 880 of file autodefs.h.

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