\section{KDock\-Widget Class Reference}
\label{classKDockWidget}\index{KDockWidget@{KDockWidget}}
Floatable widget that can be dragged around with the mouse and encapsulate the actual widgets (and member of the dockwidget class set).  


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

Inheritance diagram for KDock\-Widget:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=56pt]{classKDockWidget__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KDock\-Widget:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=343pt]{classKDockWidget__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf Dock\-Position} \{ \par
{\bf Dock\-None} =  0, 
{\bf Dock\-Top} =  0x0001, 
{\bf Dock\-Left} =  0x0002, 
{\bf Dock\-Right} =  0x0004, 
\par
{\bf Dock\-Bottom} =  0x0008, 
{\bf Dock\-Center} =  0x0010, 
{\bf Dock\-Desktop} =  0x0020, 
{\bf Dock\-To\-Special\-Sites} = 0x0040, 
\par
{\bf Dock\-Corner} =  Dock\-Top $|$ Dock\-Left $|$ Dock\-Right $|$ Dock\-Bottom, 
{\bf Dock\-Full\-Site} =  Dock\-Corner $|$ Dock\-Center, 
{\bf Dock\-Full\-Docking} =  Dock\-Full\-Site $|$ Dock\-Desktop
 \}
\end{CompactItemize}
\subsection*{Public Slots}
\begin{CompactItemize}
\item 
void {\bf set\-Forced\-Fixed\-Width} (int)
\item 
void {\bf set\-Forced\-Fixed\-Height} (int)
\item 
void {\bf restore\-From\-Forced\-Fixed\-Size} ()
\item 
int {\bf forced\-Fixed\-Width} ()
\item 
int {\bf forced\-Fixed\-Height} ()
\item 
void {\bf dock\-Back} ()
\item 
void {\bf change\-Hide\-Show\-State} ()
\item 
void {\bf undock} ()
\item 
void {\bf to\-Desktop} ()
\end{CompactItemize}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf widget\-Set} ({\bf QWidget} $\ast$)
\item 
void {\bf docking} ({\bf KDock\-Widget} $\ast$dw, {\bf KDock\-Widget::Dock\-Position} dp)
\item 
void {\bf set\-Dock\-Default\-Pos} ()
\item 
void {\bf header\-Close\-Button\-Clicked} ()
\item 
void {\bf header\-Dockback\-Button\-Clicked} ()
\item 
void {\bf i\-MBeing\-Closed} ()
\item 
void {\bf has\-Undocked} ()
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KDock\-Widget} ({\bf KDock\-Manager} $\ast$dock\-Manager, const char $\ast$name, const {\bf QPixmap} \&pixmap, {\bf QWidget} $\ast$parent=0L, const {\bf QString} \&str\-Caption=QString::null, const {\bf QString} \&str\-Tab\-Page\-Label={\bf QString::from\-Latin1}(\char`\"{} \char`\"{}), WFlags f=0)
\item 
virtual {\bf $\sim$KDock\-Widget} ()
\item 
{\bf KDock\-Widget} $\ast$ {\bf manual\-Dock} ({\bf KDock\-Widget} $\ast$target, {\bf Dock\-Position} dock\-Pos, int spli\-Pos=50, {\bf QPoint} {\bf pos}={\bf QPoint}(0, 0), bool check=false, int tab\-Index=-1)
\item 
void {\bf set\-Enable\-Docking} (int {\bf pos})
\item 
int {\bf enable\-Docking} () const 
\item 
void {\bf set\-Dock\-Site} (int {\bf pos})
\item 
int {\bf dock\-Site} () const 
\item 
void {\bf set\-Widget} ({\bf QWidget} $\ast$w)
\item 
{\bf QWidget} $\ast$ {\bf get\-Widget} () const 
\item 
void {\bf set\-Header} ({\bf KDock\-Widget\-Abstract\-Header} $\ast$ah)
\item 
{\bf KDock\-Widget\-Abstract\-Header} $\ast$ {\bf get\-Header} ()
\item 
void {\bf make\-Dock\-Visible} ()
\item 
bool {\bf may\-Be\-Hide} () const 
\item 
bool {\bf may\-Be\-Show} () const 
\item 
{\bf KDock\-Manager} $\ast$ {\bf dock\-Manager} () const 
\item 
void {\bf set\-Tool\-Tip\-String} (const {\bf QString} \&tt\-Str)
\item 
const {\bf QString} \& {\bf tool\-Tip\-String} () const 
\item 
bool {\bf is\-Dock\-Back\-Possible} () const 
\item 
void {\bf set\-Tab\-Page\-Label} (const {\bf QString} \&label)
\item 
const {\bf QString} \& {\bf tab\-Page\-Label} () const 
\item 
virtual bool {\bf event} ({\bf QEvent} $\ast$)
\item 
virtual void {\bf show} ()
\item 
{\bf KDock\-Tab\-Group} $\ast$ {\bf parent\-Dock\-Tab\-Group} () const 
\item 
{\bf QWidget} $\ast$ {\bf parent\-Dock\-Container} () const 
\item 
void {\bf set\-Dock\-Window\-Type} ({\bf NET::Window\-Type} window\-Type)
\item 
void {\bf set\-Dock\-Window\-Transient} ({\bf QWidget} $\ast$parent, bool transient\-Enabled)\label{classKDockWidget_a25}

\item 
{\bf QWidget} $\ast$ {\bf transient\-To} ()
\item 
{\bf KDock\-Widget} $\ast$ {\bf find\-Nearest\-Dock\-Widget} ({\bf Dock\-Position} {\bf pos})
\item 
void {\bf set\-Pixmap} (const {\bf QPixmap} \&pixmap={\bf QPixmap}())
\item 
const {\bf QPixmap} \& {\bf pixmap} () const 
\item 
{\bf KDock\-Widget::Dock\-Position} {\bf current\-Dock\-Position} () const 
\end{CompactItemize}
\subsection*{Protected Slots}
\begin{CompactItemize}
\item 
void {\bf lose\-Former\-Brother\-Dock\-Widget} ()
\item 
virtual void {\bf paint\-Event} ({\bf QPaint\-Event} $\ast$)\label{classKDockWidget_j1}

\item 
virtual void {\bf mouse\-Press\-Event} ({\bf QMouse\-Event} $\ast$)\label{classKDockWidget_j2}

\item 
virtual void {\bf mouse\-Release\-Event} ({\bf QMouse\-Event} $\ast$)\label{classKDockWidget_j3}

\item 
virtual void {\bf mouse\-Move\-Event} ({\bf QMouse\-Event} $\ast$)\label{classKDockWidget_j4}

\item 
virtual void {\bf leave\-Event} ({\bf QEvent} $\ast$)\label{classKDockWidget_j5}

\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
void {\bf update\-Header} ()
\item 
void {\bf set\-Latest\-KDock\-Container} ({\bf QWidget} $\ast$)
\item 
{\bf QWidget} $\ast$ {\bf latest\-KDock\-Container} ()
\item 
void {\bf set\-Former\-Brother\-Dock\-Widget} ({\bf KDock\-Widget} $\ast$)
\item 
virtual void {\bf virtual\_\-hook} (int id, void $\ast$data)\label{classKDockWidget_b4}

\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
{\bf KDock\-Widget} $\ast$ {\bf former\-Brother\-Dock\-Widget}
\item 
{\bf Dock\-Position} {\bf current\-Dock\-Pos}
\item 
{\bf Dock\-Position} {\bf former\-Dock\-Pos}
\item 
{\bf QString} {\bf tool\-Tip\-Str}
\item 
{\bf QString} {\bf tab\-Page\-Title}
\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
class {\bf KDock\-Manager}\label{classKDockWidget_n0}

\item 
class {\bf KDock\-Splitter}\label{classKDockWidget_n1}

\item 
class {\bf KDock\-Main\-Window}\label{classKDockWidget_n2}

\item 
class {\bf KDock\-Area}\label{classKDockWidget_n3}

\item 
class {\bf KMdi\-Main\-Frm}\label{classKDockWidget_n4}

\item 
class {\bf KMDI::Main\-Window}\label{classKDockWidget_n5}

\item 
class {\bf KDock\-Widget\-Header}\label{classKDockWidget_n6}

\end{CompactItemize}


\subsection{Detailed Description}
Floatable widget that can be dragged around with the mouse and encapsulate the actual widgets (and member of the dockwidget class set). 

You just grip the double-lined panel, tear it off its parent widget, drag it somewhere and let it loose. Depending on the position where you leave it, the dockwidget becomes a toplevel window on the desktop (floating mode) or docks to a new widget (dock mode). Note: A KDock\-Widget can only be docked to a KDock\-Widget.

If you want to use this kind of widget, your main application window has to be a {\bf KDock\-Main\-Window}{\rm (p.\,\pageref{classKDockMainWindow})}. That is because it has got several additional dock management features, for instance a {\bf KDock\-Manager}{\rm (p.\,\pageref{classKDockManager})} that has an overview over all dockwidgets and and a dockmovemanager (internal class) that handles the dock process.

Usually you create an KDock\-Widget that covers the actual widget in this way: 

\footnotesize\begin{verbatim} ...
 KDockMainWindow* mainWidget;
 ...
 KDockWidget* dock = 0L;
 dock = mainWidget->createDockWidget( "Any window caption", nicePixmap, 0L, i18n("window caption")); // 0L==no parent
 QWidget* actualWidget = new QWidget( dock);
 dock->setWidget( actualWidget); // embed it
 dock->setToolTipString(i18n("That's me")); // available when appearing as tab page
 ...
\end{verbatim}
\normalsize


See {\bf KDock\-Main\-Window}{\rm (p.\,\pageref{classKDockMainWindow})} how a dockwidget is docked in.

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




Definition at line 423 of file kdockwidget.h.

\subsection{Member Enumeration Documentation}
\index{KDockWidget@{KDock\-Widget}!DockPosition@{DockPosition}}
\index{DockPosition@{DockPosition}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf enum} {\bf KDock\-Widget::Dock\-Position}}\label{classKDockWidget_w11}


The possible positions where a dockwidget can dock to another dockwidget. 

\begin{Desc}
\item[Enumeration values: ]\par
\begin{description}
\index{DockToSpecialSites@{DockToSpecialSites}!KDockWidget@{KDockWidget}}\index{KDockWidget@{KDockWidget}!DockToSpecialSites@{DockToSpecialSites}}\item[{\em 
Dock\-To\-Special\-Sites\label{classKDockWidget_w11w7}
}]\begin{Desc}
\item[Since:]3.1 \end{Desc}
\end{description}
\end{Desc}



Definition at line 459 of file kdockwidget.h.

\subsection{Constructor \& Destructor Documentation}
\index{KDockWidget@{KDock\-Widget}!KDockWidget@{KDockWidget}}
\index{KDockWidget@{KDockWidget}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KDock\-Widget::KDock\-Widget ({\bf KDock\-Manager} $\ast$ {\em dock\-Manager}, const char $\ast$ {\em name}, const {\bf QPixmap} \& {\em pixmap}, {\bf QWidget} $\ast$ {\em parent} = {\tt 0L}, const {\bf QString} \& {\em str\-Caption} = {\tt QString::null}, const {\bf QString} \& {\em str\-Tab\-Page\-Label} = {\tt {\bf QString::from\-Latin1}(\char`\"{}~\char`\"{})}, WFlags {\em f} = {\tt 0})}\label{classKDockWidget_a0}


Construct a dockwidget. 

Initially, docking to another and docking to this is allowed for every {\tt Dock\-Position}. It is supposed to be no (tab) group. It will taken under control of its dockmanager.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em dock\-Manager}]The responsible manager (dock helper) \item[{\em name}]Object instance name \item[{\em pixmap}]An icon (for instance shown when docked centered) \item[{\em parent}]Parent widget \item[{\em str\-Caption}]Title of the dockwidget window (shown when toplevel) \item[{\em str\-Tab\-Page\-Label}]The title of the tab page (shown when in tab page mode), if it is \char`\"{}\char`\"{}, only the icon will be shown, if it is 0L, the label is set to str\-Caption \item[{\em f}]Qt::Widget\-Flags widget flags \end{description}
\end{Desc}


Definition at line 482 of file kdockwidget.cpp.

References QObject::connect(), and QObject::install\-Event\-Filter().

Referenced by manual\-Dock().\index{KDockWidget@{KDock\-Widget}!~KDockWidget@{$\sim$KDockWidget}}
\index{~KDockWidget@{$\sim$KDockWidget}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KDock\-Widget::$\sim${\bf KDock\-Widget} ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKDockWidget_a1}


Destructs a dockwidget. 



Definition at line 552 of file kdockwidget.cpp.

References KDock\-Widget\-Private::block\-Has\-Undocked\-Signal, KDock\-Manager::child\-Dock, KDock\-Manager::d, i\-MBeing\-Closed(), latest\-KDock\-Container(), KDock\-Widget\-Private::pending\-Dtor, undock(), and KDock\-Manager::undock\-Process.

\subsection{Member Function Documentation}
\index{KDockWidget@{KDock\-Widget}!manualDock@{manualDock}}
\index{manualDock@{manualDock}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KDock\-Widget} $\ast$ KDock\-Widget::manual\-Dock ({\bf KDock\-Widget} $\ast$ {\em target}, {\bf Dock\-Position} {\em dock\-Pos}, int {\em spli\-Pos} = {\tt 50}, {\bf QPoint} {\em pos} = {\tt {\bf QPoint}(0,~0)}, bool {\em check} = {\tt false}, int {\em tab\-Index} = {\tt -1})}\label{classKDockWidget_a2}


This is a key method of this class! Use it to dock dockwidgets to another dockwidget at the right position within its {\bf KDock\-Main\-Window}{\rm (p.\,\pageref{classKDockMainWindow})} or a toplevel dockwidget. 

If the target is null, it will become a toplevel dockwidget at position pos; Note: Docking to another dockwidget means exactly: A new parent dockwidget will be created, that replaces the target dockwidget and contains another single helper widget (tab widget or panner) which contains both dockwidgets, this and the target dockwidget. So consider parent$<$-$>$child relationships change completely during such actions.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em target}]The dockwidget to dock to \item[{\em dock\-Pos}]One of the Dock\-Positions this is going to dock to \item[{\em spli\-Pos}]The split relation (in percent, or percent$\ast$100 in high resolution) between both dockwidgets, target and this \item[{\em pos}]The dock position, mainly of interest for docking to the desktop (as toplevel dockwidget) \item[{\em check}]Only for internal use; \item[{\em tab\-Index}]The position index of the tab widget (when in tab page mode), -1 (default) means append \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]result The group dockwidget that replaces the target dockwidget and will be grandparent of target and {\tt this}. \end{Desc}


Definition at line 948 of file kdockwidget.cpp.

References KDock\-Splitter::activate(), apply\-To\-Widget(), KDock\-Widget\-Private::block\-Has\-Undocked\-Signal, KDock\-Manager::change(), QObject::connect(), current\-Dock\-Pos, KDock\-Manager::d, KDock\-Splitter::deactivate(), docking(), dock\-Manager(), e\-Docking, former\-Brother\-Dock\-Widget, former\-Dock\-Pos, QWidget::geometry(), KDock\-Splitter::get\-First(), QWidget::icon(), QTab\-Widget::insert\-Tab(), QString::is\-Empty(), is\-Group, is\-Tab\-Group, KDock\-Widget(), latest\-KDock\-Container(), lose\-Former\-Brother\-Dock\-Widget(), QWidget::move(), parent\-Dock\-Container(), parent\-Dock\-Tab\-Group(), KDock\-Manager::replace\-Dock(), QWidget::resize(), set\-Dock\-Window\-Transient(), QWidget::set\-Focus\-Policy(), set\-Former\-Brother\-Dock\-Widget(), QWidget::set\-Geometry(), KDock\-Splitter::set\-Keep\-Size(), set\-Latest\-KDock\-Container(), KDock\-Splitter::set\-Opaque\-Resize(), QTab\-Widget::set\-Tab\-Tool\-Tip(), set\-Widget(), QWidget::show(), show(), KDock\-Manager::splitter\-High\-Resolution(), KDock\-Manager::splitter\-Keep\-Size(), KDock\-Manager::splitter\-Opaque\-Resize(), tab\-Page\-Label(), tool\-Tip\-Str, tool\-Tip\-String(), KDock\-Tab\-Group::transient\-To(), and undock().

Referenced by dock\-Back(), KDock\-Manager::read\-Config(), and to\-Desktop().\index{KDockWidget@{KDock\-Widget}!setEnableDocking@{setEnableDocking}}
\index{setEnableDocking@{setEnableDocking}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Enable\-Docking (int {\em pos})}\label{classKDockWidget_a3}


Specify where it is either possible or impossible for this to dock to another dockwidget. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em pos}]An OR'ed set of {\tt Dock\-Positions} \end{description}
\end{Desc}


Definition at line 765 of file kdockwidget.cpp.

References update\-Header().

Referenced by set\-Header().\index{KDockWidget@{KDock\-Widget}!enableDocking@{enableDocking}}
\index{enableDocking@{enableDocking}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KDock\-Widget::enable\-Docking () const\hspace{0.3cm}{\tt  [inline]}}\label{classKDockWidget_a4}


\begin{Desc}
\item[Returns:]Where it is either possible or impossible for this to dock to another dockwidget (an OR'ed set of Dock\-Positions). \end{Desc}


Definition at line 505 of file kdockwidget.h.\index{KDockWidget@{KDock\-Widget}!setDockSite@{setDockSite}}
\index{setDockSite@{setDockSite}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Dock\-Site (int {\em pos})\hspace{0.3cm}{\tt  [inline]}}\label{classKDockWidget_a5}


Specify where it is either possible or impossible for another dockwidget to dock to this. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em pos}]An OR'ed set of {\tt Dock\-Positions} \end{description}
\end{Desc}


Definition at line 512 of file kdockwidget.h.\index{KDockWidget@{KDock\-Widget}!dockSite@{dockSite}}
\index{dockSite@{dockSite}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KDock\-Widget::dock\-Site () const\hspace{0.3cm}{\tt  [inline]}}\label{classKDockWidget_a6}


\begin{Desc}
\item[Returns:]There it is either possible or impossible for another dockwidget to dock to this (an OR'ed set of {\tt Dock\-Positions}). \end{Desc}


Definition at line 517 of file kdockwidget.h.

Referenced by is\-Dock\-Back\-Possible().\index{KDockWidget@{KDock\-Widget}!setWidget@{setWidget}}
\index{setWidget@{setWidget}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Widget ({\bf QWidget} $\ast$ {\em w})}\label{classKDockWidget_a7}


Sets the embedded widget. 

A {\bf QLayout} takes care about proper resizing, automatically.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em w}]The pointer to the dockwidget's child widget. \end{description}
\end{Desc}


Definition at line 1430 of file kdockwidget.cpp.

References KDock\-Manager::d, KDock\-Widget\-Private::is\-Container, update\-Header(), and widget\-Set().

Referenced by manual\-Dock(), and set\-Header().\index{KDockWidget@{KDock\-Widget}!getWidget@{getWidget}}
\index{getWidget@{getWidget}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QWidget}$\ast$ KDock\-Widget::get\-Widget () const\hspace{0.3cm}{\tt  [inline]}}\label{classKDockWidget_a8}


Get the embedded widget. 

\begin{Desc}
\item[Returns:]The pointer to the dockwidget's child widget, 0L if there's no such child. \end{Desc}


Definition at line 533 of file kdockwidget.h.

Referenced by find\-Nearest\-Dock\-Widget(), and KDock\-Manager::read\-Config().\index{KDockWidget@{KDock\-Widget}!setHeader@{setHeader}}
\index{setHeader@{setHeader}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Header ({\bf KDock\-Widget\-Abstract\-Header} $\ast$ {\em ah})}\label{classKDockWidget_a9}


Sets the header of this dockwidget. 

A {\bf QLayout} takes care about proper resizing, automatically. The header contains the drag panel, the close button and the stay button.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ah}]A base class pointer to the dockwidget header \end{description}
\end{Desc}


Definition at line 745 of file kdockwidget.cpp.

References QWidget::caption(), endl(), kd\-Debug(), set\-Enable\-Docking(), and set\-Widget().\index{KDockWidget@{KDock\-Widget}!getHeader@{getHeader}}
\index{getHeader@{getHeader}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KDock\-Widget\-Abstract\-Header} $\ast$ KDock\-Widget::get\-Header ()}\label{classKDockWidget_a10}


\begin{Desc}
\item[Since:]3.2 get the pointer to the header widget \end{Desc}




Definition at line 741 of file kdockwidget.cpp.\index{KDockWidget@{KDock\-Widget}!makeDockVisible@{makeDockVisible}}
\index{makeDockVisible@{makeDockVisible}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::make\-Dock\-Visible ()}\label{classKDockWidget_a11}


Normally it simply shows the dockwidget. 

But additionally, if it is docked to a tab widget ({\tt Dock\-Center}), it is set as the active (visible) tab page. 

Definition at line 1516 of file kdockwidget.cpp.

References dock\-Back(), QWidget::is\-Visible(), parent\-Dock\-Container(), parent\-Dock\-Tab\-Group(), QWidget::parent\-Widget(), show(), QWidget::show(), and QTab\-Widget::show\-Page().

Referenced by change\-Hide\-Show\-State(), dock\-Back(), KDock\-Main\-Window::make\-Dock\-Visible(), KDock\-Manager::make\-Widget\-Dock\-Visible(), and show().\index{KDockWidget@{KDock\-Widget}!mayBeHide@{mayBeHide}}
\index{mayBeHide@{mayBeHide}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDock\-Widget::may\-Be\-Hide () const}\label{classKDockWidget_a12}


\begin{Desc}
\item[Returns:]If it may be possible to hide this.\end{Desc}
There are reasons that it's impossible: \begin{itemize}
\item It is a (tab) group. \item It is already invisible ;-) \item The parent of this is the {\bf KDock\-Main\-Window}{\rm (p.\,\pageref{classKDockMainWindow})}. \item It isn't able to dock to another widget. \end{itemize}


Definition at line 1488 of file kdockwidget.cpp.

References QWidget::is\-Visible(), and KDock\-Manager::main.

Referenced by change\-Hide\-Show\-State().\index{KDockWidget@{KDock\-Widget}!mayBeShow@{mayBeShow}}
\index{mayBeShow@{mayBeShow}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDock\-Widget::may\-Be\-Show () const}\label{classKDockWidget_a13}


\begin{Desc}
\item[Returns:]If it may be possible to show this. There are reasons that it's impossible: \begin{itemize}
\item It is a (tab) group. \item It is already visible ;-) \item The parent of this is the {\tt {\bf KDock\-Main\-Window}{\rm (p.\,\pageref{classKDockMainWindow})}}. \end{itemize}
\end{Desc}


Definition at line 1494 of file kdockwidget.cpp.

References QWidget::is\-Visible(), and KDock\-Manager::main.

Referenced by change\-Hide\-Show\-State().\index{KDockWidget@{KDock\-Widget}!dockManager@{dockManager}}
\index{dockManager@{dockManager}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KDock\-Manager}$\ast$ KDock\-Widget::dock\-Manager () const\hspace{0.3cm}{\tt  [inline]}}\label{classKDockWidget_a14}


\begin{Desc}
\item[Returns:]The dockmanager that is responsible for this. \end{Desc}


Definition at line 580 of file kdockwidget.h.

Referenced by manual\-Dock().\index{KDockWidget@{KDock\-Widget}!setToolTipString@{setToolTipString}}
\index{setToolTipString@{setToolTipString}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Tool\-Tip\-String (const {\bf QString} \& {\em tt\-Str})\hspace{0.3cm}{\tt  [inline]}}\label{classKDockWidget_a15}


Stores a string for a tooltip. 

That tooltip string has only a meaning when this dockwidget is shown as tab page. In this case the tooltip is shown when one holds the mouse cursor on the tab page header. Such tooltip will for instance be useful, if you use only icons there. Note: Setting an empty string switches the tooltip off.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em tt\-Str}]A string for the tooltip on the tab. \end{description}
\end{Desc}


Definition at line 592 of file kdockwidget.h.

Referenced by KDock\-Manager::read\-Config().\index{KDockWidget@{KDock\-Widget}!toolTipString@{toolTipString}}
\index{toolTipString@{toolTipString}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf QString}\& KDock\-Widget::tool\-Tip\-String () const\hspace{0.3cm}{\tt  [inline]}}\label{classKDockWidget_a16}


\begin{Desc}
\item[Returns:]The tooltip string being shown on the appropriate tab page header when in dock-centered mode. \end{Desc}


Definition at line 597 of file kdockwidget.h.

Referenced by manual\-Dock(), and KDock\-Manager::write\-Config().\index{KDockWidget@{KDock\-Widget}!isDockBackPossible@{isDockBackPossible}}
\index{isDockBackPossible@{isDockBackPossible}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDock\-Widget::is\-Dock\-Back\-Possible () const}\label{classKDockWidget_a17}


\begin{Desc}
\item[Returns:]result {\tt true}, if a dockback is possible, otherwise {\tt false}. \end{Desc}


Definition at line 1590 of file kdockwidget.cpp.

References dock\-Site(), former\-Brother\-Dock\-Widget, and former\-Dock\-Pos.

Referenced by KDock\-Widget\-Header::set\-Top\-Level().\index{KDockWidget@{KDock\-Widget}!setTabPageLabel@{setTabPageLabel}}
\index{setTabPageLabel@{setTabPageLabel}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Tab\-Page\-Label (const {\bf QString} \& {\em label})\hspace{0.3cm}{\tt  [inline]}}\label{classKDockWidget_a18}


Sets a string that is used for the label of the tab page when in tab page mode. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em label}]The new tab page label. \end{description}
\end{Desc}


Definition at line 608 of file kdockwidget.h.

Referenced by KDock\-Manager::read\-Config().\index{KDockWidget@{KDock\-Widget}!tabPageLabel@{tabPageLabel}}
\index{tabPageLabel@{tabPageLabel}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf QString}\& KDock\-Widget::tab\-Page\-Label () const\hspace{0.3cm}{\tt  [inline]}}\label{classKDockWidget_a19}


\begin{Desc}
\item[Returns:]A string that is used for the label of the tab page when in tab page mode. \end{Desc}


Definition at line 613 of file kdockwidget.h.

Referenced by event(), manual\-Dock(), and KDock\-Manager::write\-Config().\index{KDockWidget@{KDock\-Widget}!event@{event}}
\index{event@{event}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDock\-Widget::event ({\bf QEvent} $\ast$)\hspace{0.3cm}{\tt  [virtual]}}\label{classKDockWidget_a20}


Catches and processes some {\bf QWidget} events that are interesting for dockwidgets. 



Reimplemented from {\bf QWidget}.

Definition at line 878 of file kdockwidget.cpp.

References KDock\-Manager::change(), QWidget::event(), event(), QWidget::hide(), i\-MBeing\-Closed(), parent\-Dock\-Tab\-Group(), QWidget::parent\-Widget(), KDock\-Widget\-Private::pending\-Focus\-In\-Event, QWidget::set\-Focus(), QTab\-Widget::set\-Tab\-Label(), QWidget::show(), and tab\-Page\-Label().

Referenced by event().\index{KDockWidget@{KDock\-Widget}!show@{show}}
\index{show@{show}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::show ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKDockWidget_a21}


Add dockwidget management actions to {\bf QWidget::show}. 



Reimplemented from {\bf QWidget}.

Definition at line 841 of file kdockwidget.cpp.

References QWidget::is\-Visible(), KDock\-Manager::main, make\-Dock\-Visible(), set\-Dock\-Default\-Pos(), KDock\-Manager::set\-Dock\-Default\-Pos(), and QWidget::show().

Referenced by KDock\-Manager::activate(), make\-Dock\-Visible(), manual\-Dock(), KDock\-Manager::read\-Config(), and undock().\index{KDockWidget@{KDock\-Widget}!parentDockTabGroup@{parentDockTabGroup}}
\index{parentDockTabGroup@{parentDockTabGroup}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KDock\-Tab\-Group} $\ast$ KDock\-Widget::parent\-Dock\-Tab\-Group () const}\label{classKDockWidget_a22}


\begin{Desc}
\item[Returns:]the parent widget of this if it inherits class {\bf KDock\-Tab\-Group}{\rm (p.\,\pageref{classKDockTabGroup})} \end{Desc}


Definition at line 1200 of file kdockwidget.cpp.

References QWidget::parent\-Widget().

Referenced by KDock\-Manager::activate(), event(), make\-Dock\-Visible(), manual\-Dock(), set\-Pixmap(), and undock().\index{KDockWidget@{KDock\-Widget}!parentDockContainer@{parentDockContainer}}
\index{parentDockContainer@{parentDockContainer}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QWidget} $\ast$ KDock\-Widget::parent\-Dock\-Container () const}\label{classKDockWidget_a23}


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




Definition at line 1208 of file kdockwidget.cpp.

References QWidget::parent\-Widget().

Referenced by make\-Dock\-Visible(), manual\-Dock(), and set\-Pixmap().\index{KDockWidget@{KDock\-Widget}!setDockWindowType@{setDockWindowType}}
\index{setDockWindowType@{setDockWindowType}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Dock\-Window\-Type ({\bf NET::Window\-Type} {\em window\-Type})}\label{classKDockWidget_a24}


Sets the type of the dock window. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em window\-Type}]is type of dock window \end{description}
\end{Desc}


Definition at line 859 of file kdockwidget.cpp.

References QWidget::parent\-Widget(), and KDock\-Widget\-Private::window\-Type.\index{KDockWidget@{KDock\-Widget}!transientTo@{transientTo}}
\index{transientTo@{transientTo}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QWidget} $\ast$ KDock\-Widget::transient\-To ()}\label{classKDockWidget_a26}


Returns the widget this dockwidget is set transient to, otherwise 0 \begin{Desc}
\item[Since:]3.2. \end{Desc}




Definition at line 874 of file kdockwidget.cpp.

References KDock\-Widget\-Private::\_\-parent, and KDock\-Widget\-Private::transient.\index{KDockWidget@{KDock\-Widget}!findNearestDockWidget@{findNearestDockWidget}}
\index{findNearestDockWidget@{findNearestDockWidget}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KDock\-Widget} $\ast$ KDock\-Widget::find\-Nearest\-Dock\-Widget ({\bf Dock\-Position} {\em pos})}\label{classKDockWidget_a27}


Lookup the nearest dockwidget docked left/right/top/bottom to this one or return 0. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em pos}]is the position the wanted widget is docked to this one \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 921 of file kdockwidget.cpp.

References get\-Widget().\index{KDockWidget@{KDock\-Widget}!setPixmap@{setPixmap}}
\index{setPixmap@{setPixmap}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Pixmap (const {\bf QPixmap} \& {\em pixmap} = {\tt {\bf QPixmap}()})}\label{classKDockWidget_a28}


Allows changing the pixmap which is used for the caption or dock tabs. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em pixmap}]is the pixmap to set \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 532 of file kdockwidget.cpp.

References QTab\-Widget::change\-Tab(), parent\-Dock\-Container(), parent\-Dock\-Tab\-Group(), pixmap(), QWidget::set\-Icon(), and QTab\-Widget::tab\-Label().\index{KDockWidget@{KDock\-Widget}!pixmap@{pixmap}}
\index{pixmap@{pixmap}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf QPixmap} \& KDock\-Widget::pixmap () const}\label{classKDockWidget_a29}


Returns the dockwidget's associated caption/dock tab pixmap. 

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


Definition at line 548 of file kdockwidget.cpp.

Referenced by set\-Pixmap().\index{KDockWidget@{KDock\-Widget}!currentDockPosition@{currentDockPosition}}
\index{currentDockPosition@{currentDockPosition}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KDock\-Widget::Dock\-Position} KDock\-Widget::current\-Dock\-Position () const}\label{classKDockWidget_a30}


\begin{Desc}
\item[Returns:]the current dock position. \end{Desc}
\begin{Desc}
\item[Since:]3.3 \end{Desc}


Definition at line 1268 of file kdockwidget.cpp.

References current\-Dock\-Pos.\index{KDockWidget@{KDock\-Widget}!setForcedFixedWidth@{setForcedFixedWidth}}
\index{setForcedFixedWidth@{setForcedFixedWidth}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Forced\-Fixed\-Width (int)\hspace{0.3cm}{\tt  [slot]}}\label{classKDockWidget_i0}


subject to changes. 

It doesn't completely work yet without small hacks from within the calling application (Perhaps {\bf KDE} 3.1.x oder 3.2 width is in pixel. It only affects a widget, which is placed directly into a horizontal {\bf KDock\-Splitter}{\rm (p.\,\pageref{classKDockSplitter})} \begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 1217 of file kdockwidget.cpp.

References KDock\-Widget\-Private::forced\-Width, and QWidget::set\-Fixed\-Width().\index{KDockWidget@{KDock\-Widget}!setForcedFixedHeight@{setForcedFixedHeight}}
\index{setForcedFixedHeight@{setForcedFixedHeight}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Forced\-Fixed\-Height (int)\hspace{0.3cm}{\tt  [slot]}}\label{classKDockWidget_i1}


subject to changes. 

It doesn't completely work yet without small hacks from within the calling application (Perhaps {\bf KDE} 3.1.x oder 3.2 height is in pixel. It only affects a widget, which is placed directly into a vertical {\bf KDock\-Splitter}{\rm (p.\,\pageref{classKDockSplitter})} \begin{Desc}
\item[Since:]3.1 \end{Desc}


Definition at line 1226 of file kdockwidget.cpp.

References KDock\-Widget\-Private::forced\-Height, and QWidget::set\-Fixed\-Height().\index{KDockWidget@{KDock\-Widget}!restoreFromForcedFixedSize@{restoreFromForcedFixedSize}}
\index{restoreFromForcedFixedSize@{restoreFromForcedFixedSize}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::restore\-From\-Forced\-Fixed\-Size ()\hspace{0.3cm}{\tt  [slot]}}\label{classKDockWidget_i2}


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




Definition at line 1245 of file kdockwidget.cpp.

References KDock\-Widget\-Private::forced\-Height, KDock\-Widget\-Private::forced\-Width, QWidget::set\-Maximum\-Height(), QWidget::set\-Maximum\-Width(), QWidget::set\-Minimum\-Height(), and QWidget::set\-Minimum\-Width().\index{KDockWidget@{KDock\-Widget}!forcedFixedWidth@{forcedFixedWidth}}
\index{forcedFixedWidth@{forcedFixedWidth}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KDock\-Widget::forced\-Fixed\-Width ()\hspace{0.3cm}{\tt  [slot]}}\label{classKDockWidget_i3}


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




Definition at line 1235 of file kdockwidget.cpp.

References KDock\-Widget\-Private::forced\-Width.\index{KDockWidget@{KDock\-Widget}!forcedFixedHeight@{forcedFixedHeight}}
\index{forcedFixedHeight@{forcedFixedHeight}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int KDock\-Widget::forced\-Fixed\-Height ()\hspace{0.3cm}{\tt  [slot]}}\label{classKDockWidget_i4}


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




Definition at line 1240 of file kdockwidget.cpp.

References KDock\-Widget\-Private::forced\-Height.\index{KDockWidget@{KDock\-Widget}!dockBack@{dockBack}}
\index{dockBack@{dockBack}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::dock\-Back ()\hspace{0.3cm}{\tt  [slot]}}\label{classKDockWidget_i5}


Docks a dockwidget back to the dockwidget that was the neighbor widget before the current dock position. 



Definition at line 1558 of file kdockwidget.cpp.

References former\-Brother\-Dock\-Widget, former\-Dock\-Pos, KDock\-Widget\-Private::index, KDock\-Manager::main, make\-Dock\-Visible(), manual\-Dock(), and KDock\-Widget\-Private::split\-Pos\-In\-Percent.

Referenced by KDock\-Manager::event\-Filter(), and make\-Dock\-Visible().\index{KDockWidget@{KDock\-Widget}!changeHideShowState@{changeHideShowState}}
\index{changeHideShowState@{changeHideShowState}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::change\-Hide\-Show\-State ()\hspace{0.3cm}{\tt  [slot]}}\label{classKDockWidget_i6}


Toggles the visibility state of the dockwidget if it is able to be shown or to be hidden. 



Definition at line 1500 of file kdockwidget.cpp.

References KDock\-Manager::main, make\-Dock\-Visible(), may\-Be\-Hide(), may\-Be\-Show(), and undock().\index{KDockWidget@{KDock\-Widget}!undock@{undock}}
\index{undock@{undock}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::undock ()\hspace{0.3cm}{\tt  [slot]}}\label{classKDockWidget_i7}


Undocks this. 

It means it becomes a toplevel widget framed by the system window manager. A small panel at the top of this undocked widget gives the possibility to drag it into another dockwidget by mouse (docking). 

Definition at line 1273 of file kdockwidget.cpp.

References KDock\-Splitter::activate(), apply\-To\-Widget(), KDock\-Widget\-Private::block\-Has\-Undocked\-Signal, QObject::block\-Signals(), KDock\-Manager::change(), KDock\-Widget\-Private::container, QTab\-Widget::count(), current\-Dock\-Pos, KDock\-Manager::d, KDock\-Splitter::deactivate(), KDock\-Manager::draw\-Drag\-Rectangle(), former\-Dock\-Pos, QWidget::frame\-Geometry(), KDock\-Splitter::get\-Another(), KDock\-Splitter::get\-First(), has\-Undocked(), QWidget::height(), QWidget::hide(), i\-MBeing\-Closed(), KDock\-Widget\-Private::index, QTab\-Widget::index\-Of(), QWidget::move(), QTab\-Widget::page(), parent\-Dock\-Tab\-Group(), QWidget::parent\-Widget(), KDock\-Widget\-Private::pending\-Dtor, QTab\-Widget::remove\-Page(), KDock\-Manager::replace\-Dock(), QWidget::resize(), KDock\-Splitter::separator\-Pos(), set\-Former\-Brother\-Dock\-Widget(), QWidget::show(), show(), KDock\-Widget\-Private::split\-Pos\-In\-Percent, KDock\-Manager::undock\-Process, and QWidget::width().

Referenced by change\-Hide\-Show\-State(), KDock\-Main\-Window::make\-Dock\-Invisible(), manual\-Dock(), KDock\-Manager::read\-Config(), and $\sim$KDock\-Widget().\index{KDockWidget@{KDock\-Widget}!toDesktop@{toDesktop}}
\index{toDesktop@{toDesktop}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::to\-Desktop ()\hspace{0.3cm}{\tt  [slot]}}\label{classKDockWidget_i8}


Docks the widget to the desktop (as a toplevel widget) \begin{Desc}
\item[Since:]3.1. \end{Desc}




Definition at line 1258 of file kdockwidget.cpp.

References manual\-Dock(), QWidget::map\-To\-Global(), QPoint::set\-X(), QPoint::set\-Y(), QPoint::x(), and QPoint::y().

Referenced by KDock\-Manager::event\-Filter().\index{KDockWidget@{KDock\-Widget}!updateHeader@{updateHeader}}
\index{updateHeader@{updateHeader}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::update\-Header ()\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidget_b0}


Checks some conditions and shows or hides the dockwidget header (drag panel). 

The header is hidden if: \begin{itemize}
\item the parent widget is the {\bf KDock\-Main\-Window}{\rm (p.\,\pageref{classKDockMainWindow})} \item this is a (tab) group dockwidget \item it is not able to dock to another dockwidget \end{itemize}


Definition at line 773 of file kdockwidget.cpp.

References KDock\-Manager::main, QWidget::set\-Cursor(), QWidget::set\-Mouse\-Tracking(), KDock\-Widget\-Abstract\-Header::set\-Top\-Level(), and QWidget::style().

Referenced by KDock\-Manager::read\-Config(), set\-Enable\-Docking(), and set\-Widget().\index{KDockWidget@{KDock\-Widget}!setLatestKDockContainer@{setLatestKDockContainer}}
\index{setLatestKDockContainer@{setLatestKDockContainer}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Latest\-KDock\-Container ({\bf QWidget} $\ast$)\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidget_b1}


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




Definition at line 721 of file kdockwidget.cpp.

References KDock\-Widget\-Private::container.

Referenced by manual\-Dock().\index{KDockWidget@{KDock\-Widget}!latestKDockContainer@{latestKDockContainer}}
\index{latestKDockContainer@{latestKDockContainer}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QWidget} $\ast$ KDock\-Widget::latest\-KDock\-Container ()\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidget_b2}


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




Definition at line 732 of file kdockwidget.cpp.

References KDock\-Widget\-Private::container.

Referenced by manual\-Dock(), and $\sim$KDock\-Widget().\index{KDockWidget@{KDock\-Widget}!setFormerBrotherDockWidget@{setFormerBrotherDockWidget}}
\index{setFormerBrotherDockWidget@{setFormerBrotherDockWidget}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Former\-Brother\-Dock\-Widget ({\bf KDock\-Widget} $\ast$)\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidget_b3}


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




Definition at line 1541 of file kdockwidget.cpp.

References QObject::connect(), former\-Brother\-Dock\-Widget, i\-MBeing\-Closed(), and lose\-Former\-Brother\-Dock\-Widget().

Referenced by manual\-Dock(), KDock\-Manager::read\-Config(), and undock().\index{KDockWidget@{KDock\-Widget}!widgetSet@{widgetSet}}
\index{widgetSet@{widgetSet}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::widget\-Set ({\bf QWidget} $\ast$)\hspace{0.3cm}{\tt  [signal]}}\label{classKDockWidget_l0}


\begin{Desc}
\item[Since:]3.2 is emitted after the set\-Widget method has finished \end{Desc}




Referenced by set\-Widget().\index{KDockWidget@{KDock\-Widget}!docking@{docking}}
\index{docking@{docking}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::docking ({\bf KDock\-Widget} $\ast$ {\em dw}, {\bf KDock\-Widget::Dock\-Position} {\em dp})\hspace{0.3cm}{\tt  [signal]}}\label{classKDockWidget_l1}


Emitted when another dock widget is docking to this. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em dw}]the dockwidget that is docking to this \item[{\em dp}]the Dock\-Position where it wants to dock to \end{description}
\end{Desc}


Referenced by manual\-Dock().\index{KDockWidget@{KDock\-Widget}!setDockDefaultPos@{setDockDefaultPos}}
\index{setDockDefaultPos@{setDockDefaultPos}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::set\-Dock\-Default\-Pos ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDockWidget_l2}


Signals that the dock default position is set. 



Referenced by show().\index{KDockWidget@{KDock\-Widget}!headerCloseButtonClicked@{headerCloseButtonClicked}}
\index{headerCloseButtonClicked@{headerCloseButtonClicked}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::header\-Close\-Button\-Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDockWidget_l3}


Emitted when the close button of the panel ( {\bf KDock\-Widget\-Header}{\rm (p.\,\pageref{classKDockWidgetHeader})}) has been clicked. 

\index{KDockWidget@{KDock\-Widget}!headerDockbackButtonClicked@{headerDockbackButtonClicked}}
\index{headerDockbackButtonClicked@{headerDockbackButtonClicked}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::header\-Dockback\-Button\-Clicked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDockWidget_l4}


Emitted when the dockback button of the panel ( {\bf KDock\-Widget\-Header}{\rm (p.\,\pageref{classKDockWidgetHeader})}) has been clicked. 

\index{KDockWidget@{KDock\-Widget}!iMBeingClosed@{iMBeingClosed}}
\index{iMBeingClosed@{iMBeingClosed}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::i\-MBeing\-Closed ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDockWidget_l5}


Emitted when the widget processes a close event. 



Referenced by event(), lose\-Former\-Brother\-Dock\-Widget(), set\-Former\-Brother\-Dock\-Widget(), undock(), and $\sim$KDock\-Widget().\index{KDockWidget@{KDock\-Widget}!hasUndocked@{hasUndocked}}
\index{hasUndocked@{hasUndocked}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::has\-Undocked ()\hspace{0.3cm}{\tt  [signal]}}\label{classKDockWidget_l6}


Emitted when the widget has undocked. 



Referenced by undock().\index{KDockWidget@{KDock\-Widget}!loseFormerBrotherDockWidget@{loseFormerBrotherDockWidget}}
\index{loseFormerBrotherDockWidget@{loseFormerBrotherDockWidget}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDock\-Widget::lose\-Former\-Brother\-Dock\-Widget ()\hspace{0.3cm}{\tt  [protected, slot]}}\label{classKDockWidget_j0}


Does several things here when it has noticed that the former brother widget (closest neighbor) gets lost. 

The former brother widget is needed for a possible dockback action, to speak with the Beatles: \char`\"{}To get back to where you once belonged\char`\"{} ;-) 

Definition at line 1549 of file kdockwidget.cpp.

References QObject::disconnect(), former\-Brother\-Dock\-Widget, i\-MBeing\-Closed(), and QWidget::repaint().

Referenced by manual\-Dock(), and set\-Former\-Brother\-Dock\-Widget().

\subsection{Member Data Documentation}
\index{KDockWidget@{KDock\-Widget}!formerBrotherDockWidget@{formerBrotherDockWidget}}
\index{formerBrotherDockWidget@{formerBrotherDockWidget}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KDock\-Widget}$\ast$ {\bf KDock\-Widget::former\-Brother\-Dock\-Widget}\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidget_p0}


earlier closest neighbor widget, so it's possible to dock back to it. 



Definition at line 805 of file kdockwidget.h.

Referenced by dock\-Back(), is\-Dock\-Back\-Possible(), lose\-Former\-Brother\-Dock\-Widget(), manual\-Dock(), set\-Former\-Brother\-Dock\-Widget(), and KDock\-Manager::write\-Config().\index{KDockWidget@{KDock\-Widget}!currentDockPos@{currentDockPos}}
\index{currentDockPos@{currentDockPos}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Dock\-Position} {\bf KDock\-Widget::current\-Dock\-Pos}\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidget_p1}


the current dock position. 



Definition at line 809 of file kdockwidget.h.

Referenced by current\-Dock\-Position(), KDock\-Manager::event\-Filter(), manual\-Dock(), and undock().\index{KDockWidget@{KDock\-Widget}!formerDockPos@{formerDockPos}}
\index{formerDockPos@{formerDockPos}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Dock\-Position} {\bf KDock\-Widget::former\-Dock\-Pos}\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidget_p2}


the former dock position when it really was at another position before. 



Definition at line 813 of file kdockwidget.h.

Referenced by dock\-Back(), is\-Dock\-Back\-Possible(), manual\-Dock(), KDock\-Manager::read\-Config(), undock(), and KDock\-Manager::write\-Config().\index{KDockWidget@{KDock\-Widget}!toolTipStr@{toolTipStr}}
\index{toolTipStr@{toolTipStr}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} {\bf KDock\-Widget::tool\-Tip\-Str}\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidget_p3}


a string used as tooltip for the tab page header when in dock-centered mode. 



Definition at line 817 of file kdockwidget.h.

Referenced by manual\-Dock().\index{KDockWidget@{KDock\-Widget}!tabPageTitle@{tabPageTitle}}
\index{tabPageTitle@{tabPageTitle}!KDockWidget@{KDock\-Widget}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} {\bf KDock\-Widget::tab\-Page\-Title}\hspace{0.3cm}{\tt  [protected]}}\label{classKDockWidget_p4}


a string used as title of the tab page when in tab page mode 



Definition at line 821 of file kdockwidget.h.

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