summaryrefslogtreecommitdiffstats
path: root/tdeparts/dockmainwindow.h
diff options
context:
space:
mode:
Diffstat (limited to 'tdeparts/dockmainwindow.h')
-rw-r--r--tdeparts/dockmainwindow.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/tdeparts/dockmainwindow.h b/tdeparts/dockmainwindow.h
new file mode 100644
index 000000000..223bd3a42
--- /dev/null
+++ b/tdeparts/dockmainwindow.h
@@ -0,0 +1,88 @@
+/* This file is part of the KDE project
+ Copyright (C) 2000 Falk Brettschneider <gigafalk@yahoo.com>
+ (C) 1999 Simon Hausmann <hausmann@kde.org>
+ (C) 1999 David Faure <faure@kde.org>
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Library General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Library General Public License for more details.
+
+ You should have received a copy of the GNU Library General Public License
+ along with this library; see the file COPYING.LIB. If not, write to
+ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
+*/
+#ifndef __DOCKMAINWINDOW_H
+#define __DOCKMAINWINDOW_H
+
+#include <tqptrlist.h>
+#include <kaction.h>
+
+#include <kdockwidget.h>
+
+#include <tdeparts/part.h>
+
+class TQString;
+
+namespace KParts
+{
+
+class DockMainWindowPrivate;
+
+/**
+ * A KPart-aware main window with ability for docking widgets, whose user interface is described in XML.
+ *
+ * Inherit your main dock-window from this class
+ * and don't forget to call setXMLFile() in the inherited constructor.
+ *
+ * It implements all internal interfaces in the case of a KDockMainWindow as host:
+ * the builder and servant interface (for menu merging).
+ */
+class KPARTS_EXPORT DockMainWindow : public KDockMainWindow, virtual public PartBase
+{
+ Q_OBJECT
+ public:
+ /**
+ * Constructor, same signature as KDockMainWindow.
+ */
+ DockMainWindow( TQWidget* parent = 0L, const char *name = 0L, WFlags f = (WFlags)WDestructiveClose );
+ /**
+ * Destructor.
+ */
+ virtual ~DockMainWindow();
+
+protected slots:
+
+ /**
+ * Create the GUI (by merging the host's and the active part's)
+ *
+ * Called on startup and whenever the active part changes.
+ * For this you need to connect this slot to the
+ * PartManager::activePartChanged() signal
+ * @param part The active part (set to 0L if no part).
+ */
+ void createGUI( KParts::Part * part );
+
+ /**
+ * Called when the active part wants to change the statusbar message.
+ * Reimplement if your dock-mainwindow has a complex statusbar
+ * (with several items)
+ */
+ virtual void slotSetStatusBarText( const TQString & );
+
+protected:
+ virtual void createShellGUI( bool create = true );
+
+ private:
+ DockMainWindowPrivate *d;
+ };
+
+}
+
+#endif