\section{KDock\-Widget\-Header Class Reference}
\label{classKDockWidgetHeader}\index{KDockWidgetHeader@{KDockWidgetHeader}}
The header (additional bar) for a {\bf KDock\-Widget}{\rm (p.\,\pageref{classKDockWidget})} s (and member of the dockwidget class set).  


{\tt \#include $<$kdockwidget.h$>$}

Inheritance diagram for KDock\-Widget\-Header:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=97pt]{classKDockWidgetHeader__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KDock\-Widget\-Header:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=238pt]{classKDockWidgetHeader__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KDock\-Widget\-Header} ({\bf KDock\-Widget} $\ast$parent, const  char $\ast$name=0L)
\begin{CompactList}\small\item\em Constructs this. \item\end{CompactList}\item 
virtual {\bf $\sim$KDock\-Widget\-Header} ()
\begin{CompactList}\small\item\em Destructs this. \item\end{CompactList}\item 
virtual void {\bf set\-Top\-Level} (bool t)
\begin{CompactList}\small\item\em Hides the close button and stay button when switching to toplevel or vice versa shows them. \item\end{CompactList}\item 
void {\bf set\-Drag\-Panel} ({\bf KDock\-Widget\-Header\-Drag} $\ast$nd)
\begin{CompactList}\small\item\em Sets the drag panel of this header. \item\end{CompactList}\item 
bool {\bf drag\-Enabled} () const \label{classKDockWidgetHeader_a4}

\item 
void {\bf set\-Drag\-Enabled} (bool b)\label{classKDockWidgetHeader_a5}

\item 
void {\bf show\-Undock\-Button} (bool show)
\begin{CompactList}\small\item\em \begin{Desc}
\item[Since:]3.1 \end{Desc}
\item\end{CompactList}\item 
virtual void {\bf save\-Config} ({\bf KConfig} $\ast$c)
\begin{CompactList}\small\item\em Saves the current button state to a {\bf KDE} config container object. \item\end{CompactList}\item 
virtual void {\bf load\-Config} ({\bf KConfig} $\ast$)
\begin{CompactList}\small\item\em Loads the current button state from a {\bf KDE} config container object. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Slots}
\begin{CompactItemize}
\item 
void {\bf slot\-Stay\-Clicked} ()
\begin{CompactList}\small\item\em Sets dragging the dockwidget off when the stay button is pressed down and vice versa. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKDockWidgetHeader_b0}

\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
{\bf QHBox\-Layout} $\ast$ {\bf layout}
\begin{CompactList}\small\item\em A layout manager for placing the embedded buttons (close and stay). \item\end{CompactList}\item 
{\bf KDock\-Button\_\-Private} $\ast$ {\bf close\-Button}
\begin{CompactList}\small\item\em a little button for closing (undocking and hiding) the dockwidget \item\end{CompactList}\item 
{\bf KDock\-Button\_\-Private} $\ast$ {\bf stay\-Button}
\begin{CompactList}\small\item\em a little button for enabling/disabling dragging the dockwidget with the mouse \item\end{CompactList}\item 
{\bf KDock\-Button\_\-Private} $\ast$ {\bf dockback\-Button}
\begin{CompactList}\small\item\em a little button for dock back the dockwidget to it's previous dockwidget \item\end{CompactList}\item 
{\bf KDock\-Widget\-Header\-Drag} $\ast$ {\bf drag}
\begin{CompactList}\small\item\em the drag panel (double line) \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
The header (additional bar) for a {\bf KDock\-Widget}{\rm (p.\,\pageref{classKDockWidget})} s (and member of the dockwidget class set). 

It have got the buttons located there. And it is for recording and reading the button states. More or less a minor helper class for the dockwidget class set.

\begin{Desc}
\item[Author:]Max Judin (documentation: Falk Brettschneider). \end{Desc}




Definition at line 233 of file kdockwidget.h.

\subsection{Constructor \& Destructor Documentation}
\index{KDockWidgetHeader@{KDock\-Widget\-Header}!KDockWidgetHeader@{KDockWidgetHeader}}
\index{KDockWidgetHeader@{KDockWidgetHeader}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KDock\-Widget\-Header::KDock\-Widget\-Header ({\bf KDock\-Widget} $\ast$ {\em parent}, const char $\ast$ {\em name} = 0L)}\label{classKDockWidgetHeader_a0}


Constructs this. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em parent}]the parent widget (usually a dockwidget) \item[{\em name}]the object instance name \end{description}
\end{Desc}


Definition at line 210 of file kdockwidget.cpp.

References close\-Button, dockback\-Button, drag, layout, KStd\-Accel::name(), QPush\-Button::pixmap(), QPush\-Button::set\-Pixmap(), QPush\-Button::set\-Toggle\-Button(), slot\-Stay\-Clicked(), and stay\-Button.\index{KDockWidgetHeader@{KDock\-Widget\-Header}!~KDockWidgetHeader@{$\sim$KDockWidgetHeader}}
\index{~KDockWidgetHeader@{$\sim$KDockWidgetHeader}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual KDock\-Widget\-Header::$\sim${\bf KDock\-Widget\-Header} ()\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classKDockWidgetHeader_a1}


Destructs this. 



Definition at line 249 of file kdockwidget.h.

\subsection{Member Function Documentation}
\index{KDockWidgetHeader@{KDock\-Widget\-Header}!setTopLevel@{setTopLevel}}
\index{setTopLevel@{setTopLevel}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget\-Header::set\-Top\-Level (bool {\em t})\hspace{0.3cm}{\tt  [virtual]}}\label{classKDockWidgetHeader_a2}


Hides the close button and stay button when switching to toplevel or vice versa shows them. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em t}]toplevel or not \end{description}
\end{Desc}


Reimplemented from {\bf KDock\-Widget\-Abstract\-Header} {\rm (p.\,\pageref{classKDockWidgetAbstractHeader_a2})}.

Definition at line 257 of file kdockwidget.cpp.

References close\-Button, dockback\-Button, drag, KDock\-Widget::is\-Dock\-Back\-Possible(), layout, and stay\-Button.\index{KDockWidgetHeader@{KDock\-Widget\-Header}!setDragPanel@{setDragPanel}}
\index{setDragPanel@{setDragPanel}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget\-Header::set\-Drag\-Panel ({\bf KDock\-Widget\-Header\-Drag} $\ast$ {\em nd})}\label{classKDockWidgetHeader_a3}


Sets the drag panel of this header. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em nd}]A pointer to the new drag panel \end{description}
\end{Desc}


Definition at line 283 of file kdockwidget.cpp.

References close\-Button, dockback\-Button, drag, layout, and stay\-Button.\index{KDockWidgetHeader@{KDock\-Widget\-Header}!showUndockButton@{showUndockButton}}
\index{showUndockButton@{showUndockButton}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget\-Header::show\-Undock\-Button (bool {\em show})}\label{classKDockWidgetHeader_a6}


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




Definition at line 313 of file kdockwidget.cpp.\index{KDockWidgetHeader@{KDock\-Widget\-Header}!saveConfig@{saveConfig}}
\index{saveConfig@{saveConfig}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget\-Header::save\-Config ({\bf KConfig} $\ast$ {\em c})\hspace{0.3cm}{\tt  [virtual]}}\label{classKDockWidgetHeader_a7}


Saves the current button state to a {\bf KDE} config container object. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em c}]the configuration safe \end{description}
\end{Desc}


Reimplemented from {\bf KDock\-Widget\-Abstract\-Header} {\rm (p.\,\pageref{classKDockWidgetAbstractHeader_a3})}.

Definition at line 333 of file kdockwidget.cpp.

References QPush\-Button::is\-On(), KStd\-Accel::name(), stay\-Button, and KConfig\-Base::write\-Entry().\index{KDockWidgetHeader@{KDock\-Widget\-Header}!loadConfig@{loadConfig}}
\index{loadConfig@{loadConfig}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget\-Header::load\-Config ({\bf KConfig} $\ast$)\hspace{0.3cm}{\tt  [virtual]}}\label{classKDockWidgetHeader_a8}


Loads the current button state from a {\bf KDE} config container object. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em c}]the configuration safe \end{description}
\end{Desc}


Reimplemented from {\bf KDock\-Widget\-Abstract\-Header} {\rm (p.\,\pageref{classKDockWidgetAbstractHeader_a4})}.

Definition at line 338 of file kdockwidget.cpp.

References KStd\-Accel::name(), and KConfig\-Base::read\-Bool\-Entry().\index{KDockWidgetHeader@{KDock\-Widget\-Header}!slotStayClicked@{slotStayClicked}}
\index{slotStayClicked@{slotStayClicked}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget\-Header::slot\-Stay\-Clicked ()\hspace{0.3cm}{\tt  [protected, slot]}}\label{classKDockWidgetHeader_j0}


Sets dragging the dockwidget off when the stay button is pressed down and vice versa. 



Definition at line 303 of file kdockwidget.cpp.

References QPush\-Button::is\-On(), and stay\-Button.

Referenced by KDock\-Widget\-Header().

\subsection{Member Data Documentation}
\index{KDockWidgetHeader@{KDock\-Widget\-Header}!layout@{layout}}
\index{layout@{layout}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QHBox\-Layout}$\ast$ {\bf KDock\-Widget\-Header::layout}\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidgetHeader_p0}


A layout manager for placing the embedded buttons (close and stay). 



Definition at line 297 of file kdockwidget.h.

Referenced by KDock\-Widget\-Header(), set\-Drag\-Panel(), and set\-Top\-Level().\index{KDockWidgetHeader@{KDock\-Widget\-Header}!closeButton@{closeButton}}
\index{closeButton@{closeButton}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KDock\-Button\_\-Private}$\ast$ {\bf KDock\-Widget\-Header::close\-Button}\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidgetHeader_p1}


a little button for closing (undocking and hiding) the dockwidget 



Definition at line 302 of file kdockwidget.h.

Referenced by KDock\-Widget\-Header(), set\-Drag\-Panel(), and set\-Top\-Level().\index{KDockWidgetHeader@{KDock\-Widget\-Header}!stayButton@{stayButton}}
\index{stayButton@{stayButton}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KDock\-Button\_\-Private}$\ast$ {\bf KDock\-Widget\-Header::stay\-Button}\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidgetHeader_p2}


a little button for enabling/disabling dragging the dockwidget with the mouse 



Definition at line 307 of file kdockwidget.h.

Referenced by KDock\-Widget\-Header(), save\-Config(), set\-Drag\-Panel(), set\-Top\-Level(), and slot\-Stay\-Clicked().\index{KDockWidgetHeader@{KDock\-Widget\-Header}!dockbackButton@{dockbackButton}}
\index{dockbackButton@{dockbackButton}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KDock\-Button\_\-Private}$\ast$ {\bf KDock\-Widget\-Header::dockback\-Button}\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidgetHeader_p3}


a little button for dock back the dockwidget to it's previous dockwidget 



Definition at line 312 of file kdockwidget.h.

Referenced by KDock\-Widget\-Header(), set\-Drag\-Panel(), and set\-Top\-Level().\index{KDockWidgetHeader@{KDock\-Widget\-Header}!drag@{drag}}
\index{drag@{drag}!KDockWidgetHeader@{KDock\-Widget\-Header}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KDock\-Widget\-Header\-Drag}$\ast$ {\bf KDock\-Widget\-Header::drag}\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidgetHeader_p4}


the drag panel (double line) 



Definition at line 317 of file kdockwidget.h.

Referenced by KDock\-Widget\-Header(), set\-Drag\-Panel(), and set\-Top\-Level().

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
kdockwidget.h\item 
kdockwidget.cpp\end{CompactItemize}
