.TH "KHE::CharColumnInterface" kde3 "11 Jun 2005" "Version Version 3.4.1" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KHE::CharColumnInterface \- A simple interface for the access to the char column of a hex edit widget.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <charcolumninterface.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBKEncoding\fP { \fBLocalEncoding\fP = 0, \fBISO8859_1Encoding\fP = 1, \fBCECP1047Encoding\fP = 2, \fBMaxEncodingId\fP = 0xFFFF }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBsetShowUnprintable\fP (bool SU=true)=0"
.br
.ti -1c
.RI "virtual void \fBsetSubstituteChar\fP (\fBQChar\fP SC)=0"
.br
.ti -1c
.RI "virtual void \fBsetEncoding\fP (\fBKEncoding\fP C)=0"
.br
.ti -1c
.RI "virtual bool \fBshowUnprintable\fP () const =0"
.br
.ti -1c
.RI "virtual \fBQChar\fP \fBsubstituteChar\fP () const =0"
.br
.ti -1c
.RI "virtual \fBKEncoding\fP \fBencoding\fP () const =0"
.br
.in -1c
.SH "Detailed Description"
.PP 
A simple interface for the access to the char column of a hex edit widget. 

\fBAuthor:\fP
.RS 4
Friedrich W. H. Kossebau <Friedrich.W.H@Kossebau.de> 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBcreateBytesEditWidget()\fP, \fBcharColumnInterface()\fP 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 33 of file charcolumninterface.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKHE::CharColumnInterface::KEncoding\fP"
.PP
encoding used to display the symbols in the text column 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fILocalEncoding \fP\fP
the encoding of your shell. 
.PP
If that is a multibyte encoding this will default to Latin1. 
.TP
\fB\fIISO8859_1Encoding \fP\fP
extended ASCII encoding, also known as Latin1 
.PP
Definition at line 37 of file charcolumninterface.h.
.SH "Member Function Documentation"
.PP 
.SS "virtual void KHE::CharColumnInterface::setShowUnprintable (bool SU = \fCtrue\fP)\fC [pure virtual]\fP"
.PP
sets whether 'unprintable' chars (value<32) should be displayed in the text column with their corresponding character. 
.PP
Default is \fCfalse\fP. 
.PP
\fBParameters:\fP
.RS 4
\fISU\fP 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBshowUnprintable()\fP 
.RE
.PP

.SS "virtual void KHE::CharColumnInterface::setSubstituteChar (\fBQChar\fP SC)\fC [pure virtual]\fP"
.PP
sets the substitute character for 'unprintable' chars Default is '.'. 
.PP
\fBParameters:\fP
.RS 4
\fISC\fP new character 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsubstituteChar()\fP 
.RE
.PP

.SS "virtual void KHE::CharColumnInterface::setEncoding (\fBKEncoding\fP C)\fC [pure virtual]\fP"
.PP
sets the encoding of the text column. 
.PP
If the encoding is not available the format will not be changed. Default is \fCLocalEncoding\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIC\fP the new encoding 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBencoding()\fP 
.RE
.PP

.SS "virtual bool KHE::CharColumnInterface::showUnprintable () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
\fCtrue\fP if 'unprintable' chars (value<32) are displayed in the text column with their corresponding character, \fCfalse\fP otherwise 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetShowUnprintable()\fP 
.RE
.PP

.SS "virtual \fBQChar\fP KHE::CharColumnInterface::substituteChar () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the currently used substitute character for 'unprintable' chars. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetSubstituteChar()\fP 
.RE
.PP

.SS "virtual \fBKEncoding\fP KHE::CharColumnInterface::encoding () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the currently used encoding 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetEncoding()\fP 
.RE
.PP


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