kmdi Library API Documentation

KMdiDockContainer Class Reference

Inheritance diagram for KMdiDockContainer:

Inheritance graph
[legend]
Collaboration diagram for KMdiDockContainer:

Collaboration graph
[legend]
List of all members.

Public Slots

void init ()
void collapseOverlapped ()
void toggle ()
void nextToolView ()
void prevToolView ()

Signals

void activated (KMdiDockContainer *)
void deactivated (KMdiDockContainer *)

Public Member Functions

 KMdiDockContainer (QWidget *parent, QWidget *win, int position, int flags)
virtual ~KMdiDockContainer ()
KDockWidget * parentDockWidget ()
virtual void insertWidget (KDockWidget *w, QPixmap, const QString &, int &)
virtual void showWidget (KDockWidget *w)
virtual void setToolTip (KDockWidget *, QString &)
virtual void setPixmap (KDockWidget *widget, const QPixmap &pixmap)
virtual void undockWidget (KDockWidget *dwdg)
virtual void removeWidget (KDockWidget *)
void hideIfNeeded ()
virtual void save (KConfig *, const QString &group_or_prefix)
virtual void load (KConfig *, const QString &group_or_prefix)
virtual void save (QDomElement &)
virtual void load (QDomElement &)
void setStyle (int)

Protected Slots

void tabClicked (int)
void delayedRaise ()
void changeOverlapMode ()

Protected Member Functions

bool eventFilter (QObject *, QEvent *)

Detailed Description

Definition at line 37 of file kmdidockcontainer.h.


Member Function Documentation

KDockWidget * KMdiDockContainer::parentDockWidget  ) 
 

Get the KDockWidget that is our parent.

Definition at line 181 of file kmdidockcontainer.cpp.

Referenced by init(), load(), save(), and tabClicked().

void KMdiDockContainer::insertWidget KDockWidget *  w,
QPixmap  ,
const QString ,
int & 
[virtual]
 

Add a widget to this container.

Parameters:
w the KDockWidget we are adding

Definition at line 186 of file kmdidockcontainer.cpp.

References QToolTip::add(), QWidgetStack::addWidget(), changeOverlapMode(), QMap::contains(), QMap::insert(), QPixmap::isNull(), QWidget::parentWidget(), and tabClicked().

void KMdiDockContainer::showWidget KDockWidget *  w  )  [virtual]
 

Show a widget.

The widget has to belong to this container otherwise it will not be shown

Parameters:
w the KDockWidget to show

Definition at line 323 of file kmdidockcontainer.cpp.

References QMap::contains(), and tabClicked().

void KMdiDockContainer::setToolTip KDockWidget *  ,
QString
[virtual]
 

Set the tooltip for the widget.

Currently, this method does nothing

Definition at line 497 of file kmdidockcontainer.cpp.

References QToolTip::add(), and QToolTip::remove().

void KMdiDockContainer::setPixmap KDockWidget *  widget,
const QPixmap pixmap
[virtual]
 

Set the pixmap for the widget.

Definition at line 506 of file kmdidockcontainer.cpp.

References QWidgetStack::id(), and QPixmap::isNull().

void KMdiDockContainer::undockWidget KDockWidget *  dwdg  )  [virtual]
 

Undock the widget from the container.

Definition at line 400 of file kmdidockcontainer.cpp.

References QMap::contains(), and tabClicked().

void KMdiDockContainer::removeWidget KDockWidget *   )  [virtual]
 

Remove a widget from the container.

The caller of this function is responsible for deleting the widget

Definition at line 369 of file kmdidockcontainer.cpp.

References QMap::contains(), hideIfNeeded(), QMap::remove(), QWidgetStack::removeWidget(), and tabClicked().

void KMdiDockContainer::hideIfNeeded  ) 
 

Hide the the dock container if the number of items is 0.

Definition at line 360 of file kmdidockcontainer.cpp.

References QWidget::parentWidget().

Referenced by removeWidget().

void KMdiDockContainer::save KConfig *  ,
const QString group_or_prefix
[virtual]
 

Save the config using a KConfig object.

The combination of the group_or_prefix variable and the parent dockwidget's name will be the group the configuration is saved in

Parameters:
group_or_prefix the prefix to append to the parent dockwidget's name

Definition at line 627 of file kmdidockcontainer.cpp.

References QPtrListIterator::current(), QString::isEmpty(), parentDockWidget(), and QWidgetStack::widget().

void KMdiDockContainer::load KConfig *  ,
const QString group_or_prefix
[virtual]
 

Load the config using a KConfig object.

The combination of the group_or_prefix variable and the parent dockwidget's name will be the group the configuration is loaded from

Parameters:
group_or_prefix the prefix to append to the parent dockwidget's name

Definition at line 675 of file kmdidockcontainer.cpp.

References QMap::begin(), QPtrListIterator::current(), delayedRaise(), QMap::end(), init(), QString::isEmpty(), parentDockWidget(), QWidget::raise(), and QTimer::singleShot().

void KMdiDockContainer::save QDomElement  )  [virtual]
 

Save the config to a QDomElement.

Definition at line 515 of file kmdidockcontainer.cpp.

References QDomDocument::createElement(), QDomDocument::createTextNode(), QPtrListIterator::current(), QString::isEmpty(), QDomElement::setAttribute(), and QWidgetStack::widget().

void KMdiDockContainer::load QDomElement  )  [virtual]
 

Load the config from a QDomElement.

Definition at line 557 of file kmdidockcontainer.cpp.

References QDomElement::attribute(), QMap::begin(), QPtrListIterator::current(), delayedRaise(), QMap::end(), QDomElement::hasAttribute(), init(), QString::isEmpty(), parentDockWidget(), QWidget::raise(), QTimer::singleShot(), QDomElement::tagName(), and QDomElement::text().

void KMdiDockContainer::setStyle int   ) 
 

Set the style for the tabbar.

Definition at line 128 of file kmdidockcontainer.cpp.

Referenced by KMdiMainFrm::setIDEAlModeStyle().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmdi Library Version 3.4.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun Oct 9 08:07:38 2005 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003