.TH "KJS::Completion" 3 "28 Jan 2004" "kjs Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KJS::Completion \- \fBCompletion\fP objects are used to convey the return status and value from functions. Handle for a \fBCompletion\fP type.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <types.h>\fP
.PP
Inherits \fBKJS::Value\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBCompletion\fP (ComplType c=Normal, const  \fBValue\fP &v=\fBValue\fP(), const  \fBUString\fP &t=\fBUString::null\fP)"
.br
.ti -1c
.RI "\fBCompletion\fP (CompletionImp *v)"
.br
.ti -1c
.RI "\fBCompletion\fP (const  \fBCompletion\fP &v)"
.br
.ti -1c
.RI "\fBCompletion\fP & \fBoperator=\fP (const  \fBCompletion\fP &v)"
.br
.ti -1c
.RI "ComplType \fBcomplType\fP () const "
.br
.ti -1c
.RI "\fBValue\fP \fBvalue\fP () const "
.br
.ti -1c
.RI "\fBUString\fP \fBtarget\fP () const "
.br
.ti -1c
.RI "bool \fBisValueCompletion\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBCompletion\fP \fBdynamicCast\fP (const  \fBValue\fP &v)"
.br
.RI "\fIConverts a \fBValue\fP into an \fBCompletion\fP. \fP"
.in -1c
.SH "Detailed Description"
.PP 
\fBCompletion\fP objects are used to convey the return status and value from functions. Handle for a \fBCompletion\fP type. 

See \fBFunctionImp::execute\fP()
.PP
\fBSee also:\fP
.RS 4
\fBFunctionImp\fP
.RE
.PP

.PP
Definition at line 248 of file types.h.
.SH "Member Function Documentation"
.PP 
.SS "\fBCompletion\fP Completion::dynamicCast (const \fBValue\fP & v)\fC [static]\fP"
.PP
Converts a \fBValue\fP into an \fBCompletion\fP. If the value's type is not CompletionType, a null object will be returned (i.e. one with it's internal pointer set to 0). If you do not know for sure whether the value is of type CompletionType, you should check the \fBisNull\fP() methods afterwards before calling any methods on the returned value.
.PP
\fBReturns:\fP
.RS 4
The value converted to an \fBCompletion\fP 
.RE
.PP
Definition at line 311 of file types.cpp.
.PP
References KJS::Value::imp(), KJS::Value::isNull(), and KJS::Value::type().

.SH "Author"
.PP 
Generated automatically by Doxygen for kjs Library from the source code.
