1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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 KDEV_MAINWINDOW_H
#define KDEV_MAINWINDOW_H
#include <qstring.h>
class QWidget;
class KStatusBar;
class KMainWindow;
/**
@file kdevmainwindow.h
KDevelop main window interface.
*/
/**
KDevelop main window interface.
Provides methods to control the main window of an application.
*/
class KDevMainWindow
{
public:
/**Destroys the main window*/
virtual ~KDevMainWindow() {} // 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(QWidget *view, const QString &title, const QString& toolTip = QString::null) = 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(QWidget *view, const QString &title, const QString &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(QWidget *view, const QString &title, const QString &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(QWidget* view, const QString& title, const QString &toolTip) = 0;
/**Removes a view from the main window.
@param view The view to remove.*/
virtual void removeView(QWidget *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(QWidget *pView, bool bEnabled) = 0;
/**Raises a view (shows it if it was minimized).
@param view The view to be raised.*/
virtual void raiseView(QWidget *view) = 0;
/**Minimize a view.
@param view The view to be lowered.*/
virtual void lowerView(QWidget *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 QString &caption ) = 0;
/**@return KMainWindow object which actually represents the main window.*/
virtual KMainWindow *main() = 0;
/**@return KStatusBar object which actually represents the status bar in the main window.*/
KStatusBar *statusBar();
};
#endif
|
