1/*
2 * This file is part of the KDE Libraries
3 * Copyright (C) 2000 Waldo Bastian (bastian@kde.org) and
4 * Espen Sand (espen@kde.org)
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
15 *
16 * You should have received a copy of the GNU Library General Public License
17 * along with this library; see the file COPYING.LIB. If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
20 *
21 */
22
23#ifndef K3ABOUT_APPLICATION_H
24#define K3ABOUT_APPLICATION_H
25
26#include <k3aboutdialog.h>
27
28class KAboutData;
29
30/**
31 * @short Standard "About Application" dialog box.
32 *
33 * This class provides the standard "About Application" dialog box
34 * that is used by KHelpMenu. It uses the information of the global
35 * KAboutData that is specified at the start of your program in
36 * main(). Normally you should not use this class directly but rather
37 * the KHelpMenu class or even better just subclass your toplevel
38 * window from KMainWindow. If you do the latter, the help menu and
39 * thereby this dialog box is available through the
40 * KMainWindow::helpMenu() function.
41 *
42 * @author Waldo Bastian (bastian@kde.org) and Espen Sand (espen@kde.org)
43 */
44
45class KDE3SUPPORT_EXPORT K3AboutApplication : public K3AboutDialog
46{
47 public:
48 /**
49 * Constructor. Creates a fully featured "About Application" dialog box.
50 * Note that this dialog is made modeless in the KHelpMenu class so
51 * the users may expect a modeless dialog.
52 *
53 * @param aboutData A pointer to a KAboutData object which data
54 * will be used for filling the dialog.
55 * @param parent The parent of the dialog box. You should use the
56 * toplevel window so that the dialog becomes centered.
57 * @param modal If false, this widget will be modeless and must be
58 * made visible using QWidget::show(). Otherwise it will be
59 * modal and must be made visible using QWidget::exec().
60 */
61 explicit K3AboutApplication( const KAboutData *aboutData=0, QWidget *parent=0, bool modal=true );
62
63 private:
64 class Private;
65 Private* const d;
66};
67
68#endif
69