KAboutDialog Class Reference
#include <kaboutdialog.h>
Inheritance diagram for KAboutDialog:

Detailed Description
A KDialogBase with predefined main widget.As a KDialogBase it uses your application wide settings for KDialogBase objects (base frame tiles, main frame tiles etc). To use it, simply create a KAboutDialog object, set all (or some) of its properties and show it. Do not derive it to create your own about dialog until you need some cool features that are unsupported and you have contacted me to add them.
The dialog can be created using two different constructors. The difference between these constructors is the available components that can be used to build the contents of the dialog. The first (Constructor I) provides a number of easy to use methods. Basically it allows you to add the components of choice, and the components are placed in a predefined layout. You do not have to plan the layout. Everything is taken care of.
The second constructor (Constructor II) works in quite the same manner as the first, but you have better control on where the components are postioned in the layout and you have access to an extended number of components you can install such as titles, product information, a tabbed pages (where you can display rich text with url links) and a person (developer) information field. The "About KDE" dialog box is created with Constructor II.
For the derived features, see the basic class KDialogBase.
- Author:
- Mirko Boehm (mirko@kde.org) and Espen Sand (espensa@online.no)
- See also:
- KDialogBase
Definition at line 283 of file kaboutdialog.h.
Public Types | |
enum | LayoutType { AbtPlain = 0x0001, AbtTabbed = 0x0002, AbtTitle = 0x0004, AbtImageLeft = 0x0008, AbtImageRight = 0x0010, AbtImageOnly = 0x0020, AbtProduct = 0x0040, AbtKDEStandard = AbtTabbed|AbtTitle|AbtImageLeft, AbtAppStandard = AbtTabbed|AbtTitle|AbtProduct, AbtImageAndTitle = AbtPlain|AbtTitle|AbtImageOnly } |
Signals | |
void | sendEmail (const QString &name, const QString &email) |
void | openURL (const QString &url) |
Public Member Functions | |
KAboutDialog (QWidget *parent=0, const char *name=0, bool modal=true) | |
KAboutDialog (int dialogLayout, const QString &caption, int buttonMask, ButtonCode defaultButton, QWidget *parent=0, const char *name=0, bool modal=false, bool separator=false, const QString &user1=QString::null, const QString &user2=QString::null, const QString &user3=QString::null) | |
void | adjust () |
virtual void | show (void) |
virtual void | show (QWidget *centerParent) |
void | setTitle (const QString &title) |
void | setImage (const QString &fileName) |
void | setIcon (const QString &fileName) KDE_DEPRECATED |
void | setProgramLogo (const QString &fileName) |
void | setProgramLogo (const QPixmap &pixmap) |
void | setImageBackgroundColor (const QColor &color) |
void | setImageFrame (bool state) |
void | setProduct (const QString &appName, const QString &version, const QString &author, const QString &year) |
QFrame * | addTextPage (const QString &title, const QString &text, bool richText=false, int numLines=10) |
QFrame * | addLicensePage (const QString &title, const QString &text, int numLines=10) |
KAboutContainer * | addContainerPage (const QString &title, int childAlignment=AlignCenter, int innerAlignment=AlignCenter) |
KAboutContainer * | addScrolledContainerPage (const QString &title, int childAlignment=AlignCenter, int innerAlignment=AlignCenter) |
KAboutContainer * | addContainer (int childAlignment, int innerAlignment) |
QFrame * | addPage (const QString &title) |
void | setLogo (const QPixmap &) |
void | setAuthor (const QString &name, const QString &email, const QString &url, const QString &work) |
void | setMaintainer (const QString &name, const QString &email, const QString &url, const QString &work) |
void | addContributor (const QString &name, const QString &email, const QString &url, const QString &work) |
void | setVersion (const QString &name) |
Static Public Member Functions | |
static void | imageURL (QWidget *parent, const QString &caption, const QString &path, const QColor &imageColor, const QString &url) |
Protected Slots | |
void | sendEmailSlot (const QString &name, const QString &email) |
void | openURLSlot (const QString &url) |
virtual void | mouseTrackSlot (int mode, const QMouseEvent *e) |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
KAboutWidget * | about |
KAboutContainerBase * | mContainerBase |
Member Enumeration Documentation
|
Layout formats.
Definition at line 291 of file kaboutdialog.h. |
Constructor & Destructor Documentation
|
The standard Qt constructor (Constructor I). Add components with the following methods: setLogo(), setAuthor(), setMaintainer(), addContributor(), or setVersion(). The dialog will be laid out automatically. Definition at line 1506 of file kaboutdialog.cpp. |
|
The extended constructor. (Constructor II). Add components with the methods: setTitle(), setImage(), setImageBackgroundColor(), setImageFrame(), setProduct(), addTextPage(), addContainerPage(), addContainer(), or addPage().
Definition at line 1526 of file kaboutdialog.cpp. |
Member Function Documentation
|
(Constructor II only) Adds a container. You can add text and images to a container.
Definition at line 1683 of file kaboutdialog.cpp. |
|
(Constructor II only) Adds a container to a tab box. You can add text and images to a container.
Definition at line 1657 of file kaboutdialog.cpp. |
|
(Constructor I only) Show this person as one of the major contributors.
Definition at line 1599 of file kaboutdialog.cpp. |
|
(Constructor II only) Adds a license page to a tab box.
Definition at line 1649 of file kaboutdialog.cpp. |
|
(Constructor II only) Adds an empty page to a tab box.
Definition at line 1676 of file kaboutdialog.cpp. |
|
(Constructor II only) Adds a container inside a QScrollView to a tab box. You can add text and images to a container.
Definition at line 1666 of file kaboutdialog.cpp. |
|
(Constructor II only) Adds a text page to a tab box. The text can be regular text or rich text. The rich text can contain URLs and mail links.
Definition at line 1642 of file kaboutdialog.cpp. |
|
Adjusts the dialog. You can call this method after you have set up all the contents but it is not required. It is done automatically when show() is executed. Definition at line 1565 of file kaboutdialog.cpp. |
|
Create a modal dialog with an image in the upper area with a URL link below.
Definition at line 1746 of file kaboutdialog.cpp. |
|
(Constructor II only) Tells the position of the mouse cursor when the left mouse button is pressed above an image
Definition at line 1636 of file kaboutdialog.cpp. |
|
Open the selected URL.
|
|
Open this URL.
Definition at line 1627 of file kaboutdialog.cpp. |
|
Send an email to this person. The application must provide the functionality. |
|
Connected to widget->sendEmail.
Definition at line 1616 of file kaboutdialog.cpp. |
|
(Constructor I only) Sets the author's name and email address.
Definition at line 1590 of file kaboutdialog.cpp. |
|
(Constructor II only) Define the program logo to be shown in the dialog. Use this to override the default program logo. For example, use this function if the KAboutDialog is for a panel applet and you want to override the appletproxy logo with your own pixmap.
Definition at line 1705 of file kaboutdialog.cpp. |
|
(Constructor II only) Define an image to be shown in the dialog.
The position is dependent on the
Definition at line 1698 of file kaboutdialog.cpp. |
|
(Constructor II only) The image has a minimum size, but is centered within an area if the dialog box is enlarged by the user. You set the background color of the area with this method.
Definition at line 1723 of file kaboutdialog.cpp. |
|
(Constructor II only) Enables or disables a frame around the image. The frame is, by default, enabled in the constructor
Definition at line 1730 of file kaboutdialog.cpp. |
|
(Constructor I only) Sets the image as the application logo.
Definition at line 1574 of file kaboutdialog.cpp. |
|
(Constructor I only) Sets the maintainer's name and email address.
Definition at line 1581 of file kaboutdialog.cpp. |
|
(Constructor II only) Prints the application name, KDE version, author, a copyright sign and a year string. To the left of the text the standard application icon is displayed.
Definition at line 1737 of file kaboutdialog.cpp. |
|
(Constructor II only) Define the program logo to be shown in the dialog. Use this to override the default program logo. For example, use this function if the KAboutDialog is for a panel applet and you want to override the appletproxy logo with your own pixmap.
Definition at line 1717 of file kaboutdialog.cpp. |
|
Overloaded version of setProgramLogo(const QPixmap& pixmap).
Definition at line 1711 of file kaboutdialog.cpp. |
|
(Constructor II only) Sets a title (not caption) in the uppermost area of the dialog.
Definition at line 1691 of file kaboutdialog.cpp. |
|
(Constructor I only) Sets the text describing the version.
Definition at line 1608 of file kaboutdialog.cpp. |
|
Makes a modeless (modal = false in constructor) dialog visible. If you reimplmement this method make sure you run it in the new method (i.e., show( parent )).
Definition at line 1557 of file kaboutdialog.cpp. |
|
Makes a modeless (modal = false in constructor) dialog visible. If you reimplement this method make sure you run it in the new method (e.g., show()). Reimplemented from KDialogBase. Definition at line 1549 of file kaboutdialog.cpp. |
Member Data Documentation
|
The main widget (Constructor I).
Definition at line 599 of file kaboutdialog.h. |
|
The main widget (Constructor II).
Definition at line 604 of file kaboutdialog.h. |
The documentation for this class was generated from the following files: