.TH "KJS::UCharReference" 3 "28 Jan 2004" "kjs Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KJS::UCharReference \- Dynamic reference to a string character.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ustring.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBUCharReference\fP & \fBoperator=\fP (\fBUChar\fP c)"
.br
.RI "\fISet the referenced character to c. \fP"
.ti -1c
.RI "\fBUCharReference\fP & \fBoperator=\fP (char c)"
.br
.RI "\fISame operator as above except the argument that it takes. \fP"
.ti -1c
.RI "unsigned short \fBunicode\fP () const "
.br
.ti -1c
.RI "unsigned char \fBlow\fP () const "
.br
.ti -1c
.RI "unsigned char \fBhigh\fP () const "
.br
.ti -1c
.RI "\fBUChar\fP \fBtoLower\fP () const "
.br
.ti -1c
.RI "\fBUChar\fP \fBtoUpper\fP () const "
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBUString\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Dynamic reference to a string character. 

\fBUCharReference\fP is the dynamic counterpart of \fBUChar\fP. It's used when characters retrieved via index from a \fBUString\fP are used in an assignment expression (and therefore can't be treated as being const): 
.PP
.nf

 \fBUString\fP s('hello world');
 s[0] = 'H';
 
.PP
.PP
If that sounds confusing your best bet is to simply forget about the existance of this class and treat is as being identical to \fBUChar\fP. 
.PP
Definition at line 121 of file ustring.h.
.SH "Member Function Documentation"
.PP 
.SS "\fBUCharReference\fP & UCharReference::operator= (\fBUChar\fP c)"
.PP
Set the referenced character to c. Definition at line 148 of file ustring.cpp.
.PP
References KJS::UString::detach(), and KJS::UString::rep.
.PP
Referenced by operator=().
.SS "\fBUCharReference\fP& KJS::UCharReference::operator= (char c)\fC [inline]\fP"
.PP
Same operator as above except the argument that it takes. Definition at line 132 of file ustring.h.
.PP
References operator=().
.SS "unsigned short KJS::UCharReference::unicode () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
Unicode value. 
.RE
.PP
Definition at line 136 of file ustring.h.
.PP
References KJS::UChar::unicode().
.SS "unsigned char KJS::UCharReference::low () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
Lower byte. 
.RE
.PP
Definition at line 140 of file ustring.h.
.PP
References KJS::UChar::uc.
.SS "unsigned char KJS::UCharReference::high () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
Higher byte. 
.RE
.PP
Definition at line 144 of file ustring.h.
.PP
References KJS::UChar::uc.
.SS "\fBUChar\fP KJS::UCharReference::toLower () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
Character converted to lower case. 
.RE
.PP
Definition at line 148 of file ustring.h.
.PP
References KJS::UChar::toLower().
.SS "\fBUChar\fP KJS::UCharReference::toUpper () const\fC [inline]\fP"
.PP
\fBReturns:\fP
.RS 4
Character converted to upper case. 
.RE
.PP
Definition at line 152 of file ustring.h.
.PP
References KJS::UChar::toUpper().

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