home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / kaboutapplication.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-10-10  |  3.8 KB  |  95 lines
  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 _KABOUT_APPLICATION_H_
  24. #define _KABOUT_APPLICATION_H_
  25.  
  26. #include <kaboutdata.h>
  27. #include <kaboutdialog.h>
  28.  
  29. /**
  30.  * @short Standard "About Application" dialog box.
  31.  * 
  32.  * This class provides the standard "About Application" dialog box
  33.  * that is used by KHelpMenu. It uses the information of the global
  34.  * KAboutData that is specified at the start of your program in
  35.  * main(). Normally you should not use this class directly but rather
  36.  * the KHelpMenu class or even better just subclass your toplevel
  37.  * window from KMainWindow. If you do the latter, the help menu and
  38.  * thereby this dialog box is available through the
  39.  * KMainWindow::helpMenu() function.
  40.  *
  41.  * @author Waldo Bastian (bastian@kde.org) and Espen Sand (espen@kde.org)
  42.  */
  43.  
  44. class KDEUI_EXPORT KAboutApplication : public KAboutDialog
  45. {
  46.   public:
  47.     /**
  48.      * Constructor. Creates a fully featured "About Application" dialog box.
  49.      * Note that this dialog is made modeless in the KHelpMenu class so
  50.      * the users may expect a modeless dialog.
  51.      *
  52.      * @param parent The parent of the dialog box. You should use the
  53.      *        toplevel window so that the dialog becomes centered.
  54.      * @param name Internal name of the widget. This name is not used in the
  55.      *        caption.
  56.      * @param modal If false, this widget will be modeless and must be
  57.      *        made visible using QWidget::show(). Otherwise it will be
  58.      *        modal and must be made visible using QWidget::exec().
  59.      */
  60.     KAboutApplication( QWidget *parent=0, const char *name=0, bool modal=true );
  61.  
  62.     /**
  63.      * Constructor. Mostly does the same stuff as the previous constructor, except
  64.      * that it can take a custom KAboutData object instead of the one specified
  65.      * in your main() function. This is especially useful for applications
  66.      * which are implemented as (dynamically loaded) libraries, e.g. panel
  67.      * applets.
  68.      *
  69.      * @param aboutData A pointer to a KAboutData object which data
  70.      *        will be used for filling the dialog.
  71.      * @param parent The parent of the dialog box. You should use the
  72.      *        toplevel window so that the dialog becomes centered.
  73.      * @param name Internal name of the widget. This name is not used in the
  74.      *        caption.
  75.      * @param modal If false, this widget will be modeless and must be
  76.      *        made visible using QWidget::show(). Otherwise it will be
  77.      *        modal and must be made visible using QWidget::exec().
  78.      */
  79.     KAboutApplication( const KAboutData *aboutData, QWidget *parent=0, const char *name=0, bool modal=true );
  80.  
  81. /*
  82.  FIXME: The two constructors should be replaced with the following  after the lib freeze:
  83.  
  84.     KAboutApplication( const KAboutData *aboutData=0, QWidget *parent=0, const char *name=0, bool modal=true );
  85.  
  86.  This will make buildDialog() obsolete as well (Frerich).
  87. */
  88.   protected:
  89.     void buildDialog( const KAboutData *aboutData );
  90. };
  91.  
  92.  
  93. #endif
  94.  
  95.