[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    kdelibs/kmdi/kmdi
From:       Matt Rogers <mattr () kde ! org>
Date:       2004-10-27 5:07:10
Message-ID: 20041027050710.01A3716C9C () office ! kde ! org
[Download RAW message or body]

CVS commit by mattr: 

Add some sorely missing documentation.


  M +2 -0      dockcontainer.cpp   1.9
  M +38 -2     dockcontainer.h   1.6


--- kdelibs/kmdi/kmdi/dockcontainer.cpp  #1.8:1.9
@@ -344,4 +344,6 @@ void DockContainer::removeWidget(KDockWi
   int id=m_map[w];
   if (m_tb->isTabRaised(id)) {
+    //why do we hide the tab if we're just going
+    //to remove it? - mattr 2004-10-26
           m_tb->setTab(id,false);
           tabClicked(id);

--- kdelibs/kmdi/kmdi/dockcontainer.h  #1.5:1.6
@@ -45,11 +45,47 @@ class DockContainer: public QWidget, pub
     virtual ~DockContainer();
 
+    /** Get the KDockWidget that is our parent */
     KDockWidget *parentDockWidget();
 
+    /**
+     * Add a widget to this container.
+     * \param w the KDockWidget object to add
+     * \TODO Remove the extra parameters that we don't use?
+     */
     virtual void insertWidget (KDockWidget *w, QPixmap, const QString &, int &);
+
+    /**
+     * Show a KDockWidget in our DockContainer
+     * \param w the KDockWidget to show
+     */
     virtual void showWidget (KDockWidget *w);
+
+    /**
+     * Set a tooltip for a widget
+     *
+     * \TODO Actually implement it? Right now, it looks just it
+     * does exactly nothing
+     */
     virtual void setToolTip (KDockWidget *, QString &);
-    virtual void setPixmap(KDockWidget*,const QPixmap&);
-    virtual void undockWidget(KDockWidget*);
+
+    /**
+     * Set a pixmap for one of our dock widgets
+     * \param widget the KDockWidget to set the pixmap for
+     * \param pixmap the pixmap you want to give the widget
+     */
+    virtual void setPixmap(KDockWidget* widget, const QPixmap& pixmap);
+
+    /**
+     * Undock a widget from the container. This function is called
+     * when you've dragged a tab off the dock it's attached to. 
+     * \param dwdg the KDockWidget to undock
+     */
+    virtual void undockWidget(KDockWidget* dwdg);
+
+    /**
+     * Remove a widget from the container. The caller
+     * of this function is responsible for deleting the widget after calling
+     * this function.
+     */
     virtual void removeWidget(KDockWidget*);
 


[prev in list] [next in list] [prev in thread] [next in thread]