.TH "KHE::BytesEditInterface" kde3 "11 Jun 2005" "Version Version 3.4.1" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KHE::BytesEditInterface \- An interface for a hex edit editor/viewer for arrays of byte.  

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

.in +1c
.ti -1c
.RI "virtual void \fBsetData\fP (char *D, int S, int RS=-1, bool KM=true)=0"
.br
.ti -1c
.RI "virtual void \fBsetReadOnly\fP (bool RO=true)=0"
.br
.ti -1c
.RI "virtual void \fBsetMaxDataSize\fP (int MS)=0"
.br
.ti -1c
.RI "virtual void \fBsetAutoDelete\fP (bool AD=true)=0"
.br
.ti -1c
.RI "virtual void \fBsetKeepsMemory\fP (bool KM=true)=0"
.br
.ti -1c
.RI "virtual void \fBsetOverwriteOnly\fP (bool b)=0"
.br
.ti -1c
.RI "virtual void \fBsetOverwriteMode\fP (bool b)=0"
.br
.ti -1c
.RI "virtual void \fBsetModified\fP (bool b)=0"
.br
.ti -1c
.RI "virtual char * \fBdata\fP () const =0"
.br
.ti -1c
.RI "virtual int \fBdataSize\fP () const =0"
.br
.ti -1c
.RI "virtual int \fBmaxDataSize\fP () const =0"
.br
.ti -1c
.RI "virtual bool \fBisAutoDelete\fP () const =0"
.br
.ti -1c
.RI "virtual bool \fBkeepsMemory\fP () const =0"
.br
.ti -1c
.RI "virtual bool \fBisOverwriteMode\fP () const =0"
.br
.ti -1c
.RI "virtual bool \fBisOverwriteOnly\fP () const =0"
.br
.ti -1c
.RI "virtual bool \fBisReadOnly\fP () const =0"
.br
.ti -1c
.RI "virtual bool \fBisModified\fP () const =0"
.br
.ti -1c
.RI "virtual void \fBrepaintRange\fP (int i1, int i2)=0"
.br
.in -1c
.SH "Detailed Description"
.PP 
An interface for a hex edit editor/viewer for arrays of byte. 

.PP
.nf
  KHE::BytesEditInterface *BytesEdit = KHE::bytesEditInterface( BytesEditWidget );
.fi
.PP
.PP
It can be used in different ways: 
.PD 0

.IP "\(bu" 2
as an viewer for array char* Data, sized DataSize 
.PP
.nf
 BytesEdit->setData( Data, DataSize );
 BytesEdit->setReadOnly( true );

.fi
.PP
.PP

.IP "\(bu" 2
as an editor for a given array of bytes with a fixed size 
.PP
.nf
 BytesEdit->setData( Data, DataSize );
 BytesEdit->setOverWriteOnly( true );

.fi
.PP
.PP

.IP "\(bu" 2
as an editor for a given array of bytes with a limited size 
.PP
.nf
 BytesEdit->setData( Data, DataSize, -1, false );
 BytesEdit->setMaxDataSize( MaxDataSize );
 BytesEdit->setOverWriteMode( false );

.fi
.PP
.PP

.IP "\(bu" 2
as an editor for a new to be created array of chars, max. with MaxDataSize 
.PP
.nf
 BytesEdit->setMaxDataSize( MaxDataSize );
 ...
 QByteArray BA;
 BA.setRawData( BytesEdit->data(), BytesEdit->dataSize() );

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

.PP
Definition at line 76 of file byteseditinterface.h.
.SH "Member Function Documentation"
.PP 
.SS "virtual void KHE::BytesEditInterface::setData (char * D, int S, int RS = \fC-1\fP, bool KM = \fCtrue\fP)\fC [pure virtual]\fP"
.PP
hands over to the editor a new byte array. 
.PP
If there exists an old one and autodelete is set the old one gets deleted. 
.PP
\fBParameters:\fP
.RS 4
\fID\fP pointer to memory 
.br
\fIS\fP size of used memory 
.br
\fIRS\fP real size of the memory, -1 means S is the real size 
.br
\fIKM\fP keep the memory on resize (RS is the maximum size) 
.RE
.PP

.SS "virtual void KHE::BytesEditInterface::setReadOnly (bool RO = \fCtrue\fP)\fC [pure virtual]\fP"
.PP
sets whether the given array should be handled read only or not. 
.PP
Default is false. 
.SS "virtual void KHE::BytesEditInterface::setMaxDataSize (int MS)\fC [pure virtual]\fP"
.PP
sets the maximal size of the actual byte array. 
.PP
If the actual array is already larger it will not be modified but there can be only done non-inserting actions until the array's is below the limit If the flag KeepsMemory is set MaxDataSize is limited to the real size of the array. MaxDataSize == -1 means no limit. Default is -1. 
.PP
\fBParameters:\fP
.RS 4
\fIMS\fP new maximal data size 
.RE
.PP

.SS "virtual void KHE::BytesEditInterface::setAutoDelete (bool AD = \fCtrue\fP)\fC [pure virtual]\fP"
.PP
sets whether the array should be deleted on the widget's end or if a new array is set. 
.PP
Default is false 
.SS "virtual void KHE::BytesEditInterface::setKeepsMemory (bool KM = \fCtrue\fP)\fC [pure virtual]\fP"
.PP
sets whether the actual memory used to store the data (as given by setData or in the constructor, or allocated by the class) should be kept on resize. 
.PP
If MaxDataSize is set and greater than the raw size of the memory it is limited to the raw size. Default is false. 
.SS "virtual void KHE::BytesEditInterface::setOverwriteOnly (bool b)\fC [pure virtual]\fP"
.PP
sets whether the widget is overwriteonly or not. 
.PP
Default is false. 
.SS "virtual void KHE::BytesEditInterface::setOverwriteMode (bool b)\fC [pure virtual]\fP"
.PP
sets whether the widget is in overwrite mode or not. 
.PP
Default is true. 
.SS "virtual void KHE::BytesEditInterface::setModified (bool b)\fC [pure virtual]\fP"
.PP
sets whether the data should be treated modified or not 
.PP
.SS "virtual char* KHE::BytesEditInterface::data () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
a pointer to the actual byte array 
.RE
.PP

.SS "virtual int KHE::BytesEditInterface::dataSize () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the size of the actual byte array 
.RE
.PP

.SS "virtual int KHE::BytesEditInterface::maxDataSize () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the maximal allowed size for the byte array 
.RE
.PP

.SS "virtual bool KHE::BytesEditInterface::isAutoDelete () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
whether autodelete is set for the byte array 
.RE
.PP

.SS "virtual bool KHE::BytesEditInterface::keepsMemory () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
\fCtrue\fP if the memory of the byte array is kept, otherwise \fCfalse\fP 
.RE
.PP

.SS "virtual bool KHE::BytesEditInterface::isOverwriteMode () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
\fCtrue\fP if the edit mode is overwrite, otherwise \fCfalse\fP for insert mode 
.RE
.PP

.SS "virtual bool KHE::BytesEditInterface::isOverwriteOnly () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
\fCtrue\fP if the memory of the byte array is kept, otherwise \fCfalse\fP 
.RE
.PP

.SS "virtual bool KHE::BytesEditInterface::isReadOnly () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
\fCtrue\fP if the ReadOnly flag is set, otherwise \fCfalse\fP 
.RE
.PP

.SS "virtual bool KHE::BytesEditInterface::isModified () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
\fCtrue\fP if the Modified flag is set, otherwise \fCfalse\fP 
.RE
.PP

.SS "virtual void KHE::BytesEditInterface::repaintRange (int i1, int i2)\fC [pure virtual]\fP"
.PP
repaint the indizes from i1 to i2 
.PP


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