\section{KHE Namespace Reference}
\label{namespaceKHE}\index{KHE@{KHE}}
KHE (short for KHex\-Edit) is KDE's namespace for all things related to the viewing/editing of bytes.  


\subsection*{Classes}
\begin{CompactItemize}
\item 
class {\bf Bytes\-Edit\-Interface}
\begin{CompactList}\small\item\em An interface for a hex edit editor/viewer for arrays of byte. \item\end{CompactList}\item 
class {\bf Char\-Column\-Interface}
\begin{CompactList}\small\item\em A simple interface for the access to the char column of a hex edit widget. \item\end{CompactList}\item 
class {\bf Clipboard\-Interface}
\begin{CompactList}\small\item\em A simple interface for interaction with the clipboard. \item\end{CompactList}\item 
class {\bf Value\-Column\-Interface}
\begin{CompactList}\small\item\em Interface for the value displaying column of a hexedit widget. \item\end{CompactList}\item 
class {\bf Zoom\-Interface}
\begin{CompactList}\small\item\em A simple interface for zooming. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
template$<$class T$>$ {\bf Bytes\-Edit\-Interface} $\ast$ {\bf bytes\-Edit\-Interface} (T $\ast$t)
\item 
{\bf QWidget} $\ast$ {\bf create\-Bytes\-Edit\-Widget} ({\bf QWidget} $\ast$Parent=0, const char $\ast$Name=0)
\item 
template$<$class T$>$ {\bf Char\-Column\-Interface} $\ast$ {\bf char\-Column\-Interface} (T $\ast$t)
\item 
template$<$class T$>$ {\bf Clipboard\-Interface} $\ast$ {\bf clipboard\-Interface} (T $\ast$t)
\item 
template$<$class T$>$ {\bf Value\-Column\-Interface} $\ast$ {\bf value\-Column\-Interface} (T $\ast$t)
\item 
template$<$class T$>$ {\bf Zoom\-Interface} $\ast$ {\bf zoom\-Interface} (T $\ast$t)
\end{CompactItemize}


\subsection{Detailed Description}
KHE (short for KHex\-Edit) is KDE's namespace for all things related to the viewing/editing of bytes. 

\begin{Desc}
\item[Since:]3.2 \end{Desc}




\subsection{Function Documentation}
\index{KHE@{KHE}!bytesEditInterface@{bytesEditInterface}}
\index{bytesEditInterface@{bytesEditInterface}!KHE@{KHE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf Bytes\-Edit\-Interface}$\ast$ bytes\-Edit\-Interface (T $\ast$ {\em t})\hspace{0.3cm}{\tt  [inline]}}\label{namespaceKHE_a0}


tries to get the bytesedit interface of t 

\begin{Desc}
\item[Returns:]a pointer to the interface, otherwise 0 \end{Desc}
\begin{Desc}
\item[Author:]Friedrich W. H. Kossebau $<${\tt Friedrich.W.H@Kossebau.de}$>$ \end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 157 of file byteseditinterface.h.\index{KHE@{KHE}!createBytesEditWidget@{createBytesEditWidget}}
\index{createBytesEditWidget@{createBytesEditWidget}!KHE@{KHE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QWidget}$\ast$ create\-Bytes\-Edit\-Widget ({\bf QWidget} $\ast$ {\em Parent} = {\tt 0}, const char $\ast$ {\em Name} = {\tt 0})\hspace{0.3cm}{\tt  [inline]}}\label{namespaceKHE_a1}


tries to create an instance of a hexedit widget for arrays of chars (char[]) 

Usage:



\footnotesize\begin{verbatim} #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)) );
   }
 }
\end{verbatim}
\normalsize


\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em Parent}]parent widget \item[{\em Name}]identifier \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]a pointer to the widget, otherwise 0 \end{Desc}
\begin{Desc}
\item[Author:]Friedrich W. H. Kossebau $<${\tt Friedrich.W.H@Kossebau.de}$>$ \end{Desc}
\begin{Desc}
\item[See also:]{\bf Bytes\-Edit\-Interface}{\rm (p.\,\pageref{classKHE_1_1BytesEditInterface})}, {\bf Value\-Column\-Interface}{\rm (p.\,\pageref{classKHE_1_1ValueColumnInterface})}, {\bf Char\-Column\-Interface}{\rm (p.\,\pageref{classKHE_1_1CharColumnInterface})}, {\bf Zoom\-Interface}{\rm (p.\,\pageref{classKHE_1_1ZoomInterface})}, {\bf Clipboard\-Interface}{\rm (p.\,\pageref{classKHE_1_1ClipboardInterface})} \end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 221 of file byteseditinterface.h.

References QString::from\-Latin1().\index{KHE@{KHE}!charColumnInterface@{charColumnInterface}}
\index{charColumnInterface@{charColumnInterface}!KHE@{KHE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf Char\-Column\-Interface}$\ast$ char\-Column\-Interface (T $\ast$ {\em t})}\label{namespaceKHE_a2}


tries to get the charcolumn interface of t 

\begin{Desc}
\item[Returns:]a pointer to the interface, otherwise 0 \end{Desc}
\begin{Desc}
\item[Author:]Friedrich W. H. Kossebau $<${\tt Friedrich.W.H@Kossebau.de}$>$ \end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 95 of file charcolumninterface.h.\index{KHE@{KHE}!clipboardInterface@{clipboardInterface}}
\index{clipboardInterface@{clipboardInterface}!KHE@{KHE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf Clipboard\-Interface}$\ast$ clipboard\-Interface (T $\ast$ {\em t})}\label{namespaceKHE_a3}


tries to get the clipboard interface of t 

\begin{Desc}
\item[Returns:]a pointer to the interface, otherwise 0 \end{Desc}
\begin{Desc}
\item[Author:]Friedrich W. H. Kossebau $<${\tt Friedrich.W.H@Kossebau.de}$>$ \end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 76 of file khexedit/clipboardinterface.h.\index{KHE@{KHE}!valueColumnInterface@{valueColumnInterface}}
\index{valueColumnInterface@{valueColumnInterface}!KHE@{KHE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf Value\-Column\-Interface}$\ast$ value\-Column\-Interface (T $\ast$ {\em t})}\label{namespaceKHE_a4}


tries to get the valuecolumn interface of t 

\begin{Desc}
\item[Returns:]a pointer to the interface, otherwise 0 \end{Desc}
\begin{Desc}
\item[Author:]Friedrich W. H. Kossebau $<${\tt Friedrich.W.H@Kossebau.de}$>$ \end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 160 of file valuecolumninterface.h.\index{KHE@{KHE}!zoomInterface@{zoomInterface}}
\index{zoomInterface@{zoomInterface}!KHE@{KHE}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}template$<$class T$>$ {\bf Zoom\-Interface}$\ast$ zoom\-Interface (T $\ast$ {\em t})}\label{namespaceKHE_a5}


tries to get the zoom interface of t 

\begin{Desc}
\item[Returns:]a pointer to the interface, otherwise 0 \end{Desc}
\begin{Desc}
\item[Author:]Friedrich W. H. Kossebau $<${\tt Friedrich.W.H@Kossebau.de}$>$ \end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 69 of file zoominterface.h.