Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KAboutDialog Class Reference

#include <kaboutdialog.h>

Inheritance diagram for KAboutDialog:

KDialogBase KDialog KAboutApplication KAboutKDE List of all members.

Public Types

enum  LayoutType

Signals

void sendEmail (const QString &name, const QString &email)
void openURL (const QString &url)

Public Methods

 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 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 Methods

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 Methods

virtual void virtual_hook (int id, void *data)

Protected Attributes

KAboutWidget * about
KAboutContainerBase * mContainerBase

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.

Member Enumeration Documentation

enum KAboutDialog::LayoutType
 

Layout formats.

Definition at line 291 of file kaboutdialog.h.

Constructor & Destructor Documentation

KAboutDialog::KAboutDialog (  QWidget *    parent = 0,
const char *    name = 0,
bool    modal = true
) 
 

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.

KAboutDialog::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
) 
 

The extended constructor. (Constructor II).

Add components with the methods: setTitle(), setImage(), setImageBackgroundColor(), setImageFrame(), setProduct(), addTextPage(), addContainerPage(), addContainer(), or addPage().

Parameters:
dialogLayout  Use a mask of LayoutType flags.
caption  The dialog caption. The text you specify is prepended by i18n("About").
buttonMask  Specifies what buttons will be visible.
defaultButton  Specifies what button will be marked as the default.
parent  Parent of the dialog.
name  Dialog name (for internal use only)
modal  Sets dialog modality. If false, the rest of the program interface (other dialogs, for example) is accessible while the dialog is open.
separator  If true, a separator line is drawn between the action buttons an the main widget.
user1  User button1 text.
user2  User button2 text.
user3  User button3 text.

Member Function Documentation

KAboutContainer* KAboutDialog::addContainer (  int    childAlignment,
int    innerAlignment
) 
 

(Constructor II only) Adds a container. You can add text and images to a container.

Parameters:
childAlignment  Specifies how the children of the container are aligned with respect to the container.
innerAlignment  Specifies how the children are aligned with respect to each other.
Returns:
The new container.

KAboutContainer* KAboutDialog::addContainerPage (  const QString &    title,
int    childAlignment = AlignCenter,
int    innerAlignment = AlignCenter
) 
 

(Constructor II only) Adds a container to a tab box. You can add text and images to a container.

Parameters:
title  Tab name.
childAlignment  Specifies how the children of the container are aligned with respect to the container.
innerAlignment  Specifies how the children are aligned with respect to each other.
Returns:
The new container.

void KAboutDialog::addContributor (  const QString &    name,
const QString &    email,
const QString &    url,
const QString &    work
) 
 

(Constructor I only) Show this person as one of the major contributors.

QFrame* KAboutDialog::addLicensePage (  const QString &    title,
const QString &    text,
int    numLines = 10
) 
 

(Constructor II only) Adds a license page to a tab box.

Parameters:
title  Tab name.
text  The text to display.
numLines  The text area height will be adjusted so that this is the minimum number of lines of text that are visible.
Returns:
The frame that contains the page.

QFrame* KAboutDialog::addPage (  const QString &    title ) 
 

(Constructor II only) Adds an empty page to a tab box.

Parameters:
title  Tab name
Returns:
The new page.

KAboutContainer* KAboutDialog::addScrolledContainerPage (  const QString &    title,
int    childAlignment = AlignCenter,
int    innerAlignment = AlignCenter
) 
 

(Constructor II only) Adds a container inside a QScrollView to a tab box. You can add text and images to a container.

Parameters:
title  Tab name.
childAlignment  Specifies how the children of the container are aligned with respect to the container.
innerAlignment  Specifies how the children are aligned with respect to each other.
Returns:
The new container.

QFrame* KAboutDialog::addTextPage (  const QString &    title,
const QString &    text,
bool    richText = false,
int    numLines = 10
) 
 

(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.

Parameters:
title  Tab name.
text  The text to display.
richText  Set this to true if 'text' is rich text.
numLines  The text area height will be adjusted so that this is the minimum number of lines of text that are visible.
Returns:
The frame that contains the page.

void KAboutDialog::adjust (    ) 
 

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.

void KAboutDialog::imageURL (  QWidget *    parent,
const QString &    caption,
const QString &    path,
const QColor &    imageColor,
const QString &    url
)  [static]
 

Create a modal dialog with an image in the upper area with a URL link below.

virtual void KAboutDialog::mouseTrackSlot (  int    mode,
const QMouseEvent *    e
)  [protected, virtual, slot]
 

(Constructor II only) Tells the position of the mouse cursor when the left mouse button is pressed above an image

void KAboutDialog::openURL (  const QString &    url )  [signal]
 

Open the selected URL.

void KAboutDialog::openURLSlot (  const QString &    url )  [protected, slot]
 

Open this URL.

void KAboutDialog::sendEmail (  const QString &    name,
const QString &    email
)  [signal]
 

Send an email to this person.

The application must provide the functionality.

void KAboutDialog::sendEmailSlot (  const QString &    name,
const QString &    email
)  [protected, slot]
 

Connected to widget->sendEmail.

void KAboutDialog::setAuthor (  const QString &    name,
const QString &    email,
const QString &    url,
const QString &    work
) 
 

(Constructor I only) Sets the author's name and email address.

void KAboutDialog::setImage (  const QString &    fileName ) 
 

(Constructor II only) Define an image to be shown in the dialog. The position is dependent on the dialogLayout in the constructor

Parameters:
fileName  Path to image file.

void KAboutDialog::setImageBackgroundColor (  const QColor &    color ) 
 

(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.

Parameters:
color  Background color.

void KAboutDialog::setImageFrame (  bool    state ) 
 

(Constructor II only) Enables or disables a frame around the image. The frame is, by default, enabled in the constructor

Parameters:
state  A value of true enables the frame

void KAboutDialog::setLogo (  const QPixmap &    ) 
 

(Constructor I only) Sets the image as the application logo.

void KAboutDialog::setMaintainer (  const QString &    name,
const QString &    email,
const QString &    url,
const QString &    work
) 
 

(Constructor I only) Sets the maintainer's name and email address.

void KAboutDialog::setProduct (  const QString &    appName,
const QString &    version,
const QString &    author,
const QString &    year
) 
 

(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.

Parameters:
appName  The application name.
version  Application version.
author  One or more authors.
year  A string telling when the application was made.

void KAboutDialog::setTitle (  const QString &    title ) 
 

(Constructor II only) Sets a title (not caption) in the uppermost area of the dialog.

Parameters:
title  Title string.

void KAboutDialog::setVersion (  const QString &    name ) 
 

(Constructor I only) Sets the text describing the version.

virtual void KAboutDialog::show (  QWidget *    centerParent )  [virtual]
 

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 )).

Parameters:
centerParent  Center the dialog with respect to this widget.

virtual void KAboutDialog::show (  void    )  [virtual]
 

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.

Member Data Documentation

KAboutWidget* KAboutDialog::about [protected]
 

The main widget (Constructor I)

Definition at line 565 of file kaboutdialog.h.

KAboutContainerBase* KAboutDialog::mContainerBase [protected]
 

The main widget (Constructor II)

Definition at line 570 of file kaboutdialog.h.

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:03 2003 for kdelibs by doxygen1.2.18