summaryrefslogtreecommitdiffstats
path: root/lib/interfaces/tdevmainwindow.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/interfaces/tdevmainwindow.h')
-rw-r--r--lib/interfaces/tdevmainwindow.h101
1 files changed, 101 insertions, 0 deletions
diff --git a/lib/interfaces/tdevmainwindow.h b/lib/interfaces/tdevmainwindow.h
new file mode 100644
index 00000000..83aef3b0
--- /dev/null
+++ b/lib/interfaces/tdevmainwindow.h
@@ -0,0 +1,101 @@
+/* This file is part of the KDE project
+ Copyright (C) 2003 F@lk Brettschneider <falkbr@kdevelop.org>
+ Copyright (C) 2003 John Firebaugh <jfirebaugh@kde.org>
+ Copyright (C) 2003 Amilcar do Carmo Lucas <amilcar@ida.ing.tu-bs.de>
+ Copyright (C) 2004 Alexander Dymo <adymo@kdevelop.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 TDEV_MAINWINDOW_H
+#define TDEV_MAINWINDOW_H
+
+#include <tqstring.h>
+
+class TQWidget;
+class KStatusBar;
+class TDEMainWindow;
+
+/**
+@file tdevmainwindow.h
+KDevelop main window interface.
+*/
+
+/**
+KDevelop main window interface.
+Provides methods to control the main window of an application.
+*/
+class TDevMainWindow
+{
+public:
+ /**Destroys the main window*/
+ virtual ~TDevMainWindow() {} // must be virtual!
+
+ /**Embeds a view of a part into the main window.
+ @param view The view to embed. Must be a KPart.
+ @param title The title of a view.
+ @param toolTip The tooltip of a view.*/
+ virtual void embedPartView(TQWidget *view, const TQString &title, const TQString& toolTip = TQString()) = 0;
+
+ /**Embeds a toolview at the left of the main window.
+ @param view The view to embed. Must be a KPart.
+ @param title The title of a view.
+ @param toolTip The tooltip of a view.*/
+ virtual void embedSelectView(TQWidget *view, const TQString &title, const TQString &toolTip) = 0;
+
+ /**Embeds a toolview at the bottom of the main window.
+ @param view The view to embed. Must be a KPart.
+ @param title The title of a view.
+ @param toolTip The tooltip of a view.*/
+ virtual void embedOutputView(TQWidget *view, const TQString &title, const TQString &toolTip) = 0;
+
+ /**Embeds a toolview at the right of the main window.
+ @param view The view to embed. Must be a KPart.
+ @param title The title of a view.
+ @param toolTip The tooltip of a view.*/
+ virtual void embedSelectViewRight(TQWidget* view, const TQString& title, const TQString &toolTip) = 0;
+
+ /**Removes a view from the main window.
+ @param view The view to remove.*/
+ virtual void removeView(TQWidget *view) = 0;
+
+ /**Shows or hides a view.
+ @param pView The view to show or hide.
+ @param bEnabled true if view should be shown, false it it is not.*/
+ virtual void setViewAvailable(TQWidget *pView, bool bEnabled) = 0;
+
+ /**Raises a view (shows it if it was minimized).
+ @param view The view to be raised.*/
+ virtual void raiseView(TQWidget *view) = 0;
+
+ /**Minimize a view.
+ @param view The view to be lowered.*/
+ virtual void lowerView(TQWidget *view) = 0;
+
+ /**Loads main window settings.*/
+ virtual void loadSettings() = 0;
+
+ /**Sets the current document's caption, if applicable.
+ @param caption the caption to set.*/
+ virtual void setCurrentDocumentCaption( const TQString &caption ) = 0;
+
+ /**@return TDEMainWindow object which actually represents the main window.*/
+ virtual TDEMainWindow *main() = 0;
+
+ /**@return KStatusBar object which actually represents the status bar in the main window.*/
+ KStatusBar *statusBar();
+};
+
+#endif