.TH "KHE" kde3 "11 Jun 2005" "Version Version 3.4.1" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KHE \- KHE (short for KHexEdit) is KDE's namespace for all things related to the viewing/editing of bytes.  

.PP
.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBBytesEditInterface\fP"
.br
.RI "\fIAn interface for a hex edit editor/viewer for arrays of byte. \fP"
.ti -1c
.RI "class \fBCharColumnInterface\fP"
.br
.RI "\fIA simple interface for the access to the char column of a hex edit widget. \fP"
.ti -1c
.RI "class \fBClipboardInterface\fP"
.br
.RI "\fIA simple interface for interaction with the clipboard. \fP"
.ti -1c
.RI "class \fBValueColumnInterface\fP"
.br
.RI "\fIInterface for the value displaying column of a hexedit widget. \fP"
.ti -1c
.RI "class \fBZoomInterface\fP"
.br
.RI "\fIA simple interface for zooming. \fP"
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "template<class T> \fBBytesEditInterface\fP * \fBbytesEditInterface\fP (T *t)"
.br
.ti -1c
.RI "\fBQWidget\fP * \fBcreateBytesEditWidget\fP (\fBQWidget\fP *Parent=0, const char *Name=0)"
.br
.ti -1c
.RI "template<class T> \fBCharColumnInterface\fP * \fBcharColumnInterface\fP (T *t)"
.br
.ti -1c
.RI "template<class T> \fBClipboardInterface\fP * \fBclipboardInterface\fP (T *t)"
.br
.ti -1c
.RI "template<class T> \fBValueColumnInterface\fP * \fBvalueColumnInterface\fP (T *t)"
.br
.ti -1c
.RI "template<class T> \fBZoomInterface\fP * \fBzoomInterface\fP (T *t)"
.br
.in -1c
.SH "Detailed Description"
.PP 
KHE (short for KHexEdit) is KDE's namespace for all things related to the viewing/editing of bytes. 

\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
.SH "Function Documentation"
.PP 
.SS "template<class T> \fBBytesEditInterface\fP* bytesEditInterface (T * t)\fC [inline]\fP"
.PP
tries to get the bytesedit interface of t 
.PP
\fBReturns:\fP
.RS 4
a pointer to the interface, otherwise 0 
.RE
.PP
\fBAuthor:\fP
.RS 4
Friedrich W. H. Kossebau <Friedrich.W.H@Kossebau.de> 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 157 of file byteseditinterface.h.
.SS "\fBQWidget\fP* createBytesEditWidget (\fBQWidget\fP * Parent = \fC0\fP, const char * Name = \fC0\fP)\fC [inline]\fP"
.PP
tries to create an instance of a hexedit widget for arrays of chars (char[]) 
.PP
Usage:
.PP
.PP
.nf
 #include <khexedit/byteseditinterface.h>
 #include <khexedit/valuecolumninterface.h>
 #include <khexedit/charcolumninterface.h>
 #include <khexedit/clipboardinterface.h>
 ...

 QWidget *BytesEditWidget = KHE::createBytesEditWidget( this, 'BytesEditWidget' );
 // is e.g. kdeutils (incl. khexedit2) installed, so a widget could be found and created?
 if( BytesEditWidget )
 {
   // fetch the editor interface
   KHE::BytesEditInterface *BytesEdit = KHE::bytesEditInterface( BytesEditWidget );
   Q_ASSERT( BytesEdit ); // This should not fail!

   // now use the editor.
   BytesEdit->setData( Buffer, BufferSize, -1 );
   BytesEdit->setMaxDataSize( BufferSize );
   BytesEdit->setReadOnly( false );
   BytesEdit->setAutoDelete( true );

   KHE::ValueColumnInterface *ValueColumn = KHE::valueColumnInterface( BytesEditWidget );
   if( ValueColumn )
   {
     ValueColumn->setCoding( KHE::ValueColumnInterface::BinaryCoding );
     ValueColumn->setByteSpacingWidth( 2 );
     ValueColumn->setNoOfGroupedBytes( 4 );
     ValueColumn->setGroupSpacingWidth( 12 );
   }

   KHE::CharColumnInterface *CharColumn = KHE::charColumnInterface( BytesEditWidget );
   if( CharColumn )
   {
     CharColumn->setShowUnprintable( false );
     CharColumn->setSubstituteChar( '*' );
   }
   KHE::ClipboardInterface *Clipboard = KHE::clipboardInterface( BytesEditWidget );
   if( Clipboard )
   {
     // Yes, use BytesEditWidget, not Clipboard, because that's the QObject, indeed hacky...
     connect( BytesEditWidget, SIGNAL(copyAvailable(bool)), this, SLOT(offerCopy(bool)) );
   }
 }
.fi
.PP
.PP
\fBParameters:\fP
.RS 4
\fIParent\fP parent widget 
.br
\fIName\fP identifier 
.RE
.PP
\fBReturns:\fP
.RS 4
a pointer to the widget, otherwise 0 
.RE
.PP
\fBAuthor:\fP
.RS 4
Friedrich W. H. Kossebau <Friedrich.W.H@Kossebau.de> 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBBytesEditInterface\fP, \fBValueColumnInterface\fP, \fBCharColumnInterface\fP, \fBZoomInterface\fP, \fBClipboardInterface\fP 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 221 of file byteseditinterface.h.
.PP
References QString::fromLatin1().
.SS "template<class T> \fBCharColumnInterface\fP* charColumnInterface (T * t)"
.PP
tries to get the charcolumn interface of t 
.PP
\fBReturns:\fP
.RS 4
a pointer to the interface, otherwise 0 
.RE
.PP
\fBAuthor:\fP
.RS 4
Friedrich W. H. Kossebau <Friedrich.W.H@Kossebau.de> 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 95 of file charcolumninterface.h.
.SS "template<class T> \fBClipboardInterface\fP* clipboardInterface (T * t)"
.PP
tries to get the clipboard interface of t 
.PP
\fBReturns:\fP
.RS 4
a pointer to the interface, otherwise 0 
.RE
.PP
\fBAuthor:\fP
.RS 4
Friedrich W. H. Kossebau <Friedrich.W.H@Kossebau.de> 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 76 of file khexedit/clipboardinterface.h.
.SS "template<class T> \fBValueColumnInterface\fP* valueColumnInterface (T * t)"
.PP
tries to get the valuecolumn interface of t 
.PP
\fBReturns:\fP
.RS 4
a pointer to the interface, otherwise 0 
.RE
.PP
\fBAuthor:\fP
.RS 4
Friedrich W. H. Kossebau <Friedrich.W.H@Kossebau.de> 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 160 of file valuecolumninterface.h.
.SS "template<class T> \fBZoomInterface\fP* zoomInterface (T * t)"
.PP
tries to get the zoom interface of t 
.PP
\fBReturns:\fP
.RS 4
a pointer to the interface, otherwise 0 
.RE
.PP
\fBAuthor:\fP
.RS 4
Friedrich W. H. Kossebau <Friedrich.W.H@Kossebau.de> 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 69 of file zoominterface.h.
.SH "Author"
.PP 
Generated automatically by Doxygen for interfaces Library from the source code.
