K3AboutDialog Class Reference

A KDialog with predefined main widget. More...

#include <k3aboutdialog.h>

Inheritance diagram for K3AboutDialog:

List of all members.

Public Types
enum	LayoutType {   Plain = 0x0001, Tabbed = 0x0002, Title = 0x0004, ImageLeft = 0x0008,   ImageRight = 0x0010, ImageOnly = 0x0020, Product = 0x0040, KDEStandard = Tabbed | Title | ImageLeft,   AppStandard = Tabbed | Title | Product, ImageAndTitle = Plain | Title | ImageOnly }
Public Member Functions
	K3AboutDialog (QWidget *parent=0)
	K3AboutDialog (int dialogLayout, const QString &caption, QWidget *parent=0)
K3AboutContainer *	addContainer (Qt::Alignment childAlignment, Qt::Alignment innerAlignment)
K3AboutContainer *	addContainerPage (const QString &title, Qt::Alignment childAlignment=Qt::AlignCenter, Qt::Alignment innerAlignment=Qt::AlignCenter)
void	addContributor (const QString &name, const QString &email, const QString &url, const QString &work)
QFrame *	addLicensePage (const QString &title, const QString &text, int numLines=10)
QFrame *	addPage (const QString &title)
K3AboutContainer *	addScrolledContainerPage (const QString &title, Qt::Alignment childAlignment=Qt::AlignCenter, Qt::Alignment innerAlignment=Qt::AlignCenter)
QFrame *	addTextPage (const QString &title, const QString &text, bool richText=false, int numLines=10)
void	adjust ()
void	setAuthor (const QString &name, const QString &email, const QString &url, const QString &work)
void	setImage (const QString &fileName)
void	setImageBackgroundColor (const QColor &color)
void	setImageFrame (bool state)
void	setLogo (const QPixmap &logo)
void	setMaintainer (const QString &name, const QString &email, const QString &url, const QString &work)
void	setProduct (const QString &appName, const QString &version, const QString &author, const QString &year)
void	setProgramLogo (const QString &fileName)
void	setProgramLogo (const QPixmap &pixmap)
void	setTitle (const QString &title)
void	setVersion (const QString &name)
virtual void	show ()
virtual void	show (QWidget *centerParent)
Static Public Member Functions
static void	imageUrl (QWidget *parent, const QString &caption, const QString &path, const QColor &imageColor, const QString &url)
Protected Attributes
K3AboutWidget *	mAbout
K3AboutContainerBase *	mContainerBase

---

Detailed Description

A KDialog with predefined main widget.

As a KDialog it uses your application wide settings for KDialog objects (base frame tiles, main frame tiles etc). To use it, simply create a K3AboutDialog 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 KDialog.

Author:

Mirko Boehm (mirko@kde.org) and Espen Sand (espensa@online.no)

See also:

KDialog

Definition at line 255 of file k3aboutdialog.h.

---

Member Enumeration Documentation

enum K3AboutDialog::LayoutType

Layout formats.

Enumerator:

Plain
Tabbed
Title
ImageLeft
ImageRight
ImageOnly
Product
KDEStandard
AppStandard
ImageAndTitle

Definition at line 264 of file k3aboutdialog.h.

---

Constructor & Destructor Documentation

K3AboutDialog::K3AboutDialog

(

QWidget *

parent = 0

)

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 1030 of file k3aboutdialog.cpp.

K3AboutDialog::K3AboutDialog	(	int	dialogLayout,
		const QString &	caption,
		QWidget *	parent = 0
	)

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").
parent	Parent of the dialog.

Definition at line 1039 of file k3aboutdialog.cpp.

---

Member Function Documentation

K3AboutContainer * K3AboutDialog::addContainer	(	Qt::Alignment	childAlignment,
		Qt::Alignment	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.

Definition at line 1155 of file k3aboutdialog.cpp.

K3AboutContainer * K3AboutDialog::addContainerPage	(	const QString &	title,
		Qt::Alignment	childAlignment = Qt::AlignCenter,
		Qt::Alignment	innerAlignment = Qt::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.

Definition at line 1132 of file k3aboutdialog.cpp.

void K3AboutDialog::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.

Definition at line 1101 of file k3aboutdialog.cpp.

QFrame * K3AboutDialog::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.

Definition at line 1125 of file k3aboutdialog.cpp.

QFrame * K3AboutDialog::addPage

(

const QString &

title

)

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

Parameters:

title

Tab name

Returns:

The new page.

Definition at line 1148 of file k3aboutdialog.cpp.

K3AboutContainer * K3AboutDialog::addScrolledContainerPage	(	const QString &	title,
		Qt::Alignment	childAlignment = Qt::AlignCenter,
		Qt::Alignment	innerAlignment = Qt::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.

Definition at line 1140 of file k3aboutdialog.cpp.

QFrame * K3AboutDialog::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.

Definition at line 1118 of file k3aboutdialog.cpp.

void K3AboutDialog::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.

Definition at line 1066 of file k3aboutdialog.cpp.

void K3AboutDialog::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.

Definition at line 1206 of file k3aboutdialog.cpp.

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

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

Definition at line 1092 of file k3aboutdialog.cpp.

void K3AboutDialog::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.

Definition at line 1169 of file k3aboutdialog.cpp.

void K3AboutDialog::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.

Definition at line 1187 of file k3aboutdialog.cpp.

void K3AboutDialog::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

Definition at line 1193 of file k3aboutdialog.cpp.

void K3AboutDialog::setLogo

(

const QPixmap &

logo

)

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

Definition at line 1075 of file k3aboutdialog.cpp.

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

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

Definition at line 1083 of file k3aboutdialog.cpp.

void K3AboutDialog::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.

Definition at line 1199 of file k3aboutdialog.cpp.

void K3AboutDialog::setProgramLogo

(

const QString &

fileName

)

Overloaded version of setProgramLogo(const QPixmap& pixmap).

Definition at line 1175 of file k3aboutdialog.cpp.

void K3AboutDialog::setProgramLogo

(

const QPixmap &

pixmap

)

(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 K3AboutDialog is for a panel applet and you want to override the appletproxy logo with your own pixmap.

Parameters:

pixmap

The logo pixmap.

Definition at line 1181 of file k3aboutdialog.cpp.

void K3AboutDialog::setTitle

(

const QString &

title

)

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

Parameters:

title

Title string.

Definition at line 1163 of file k3aboutdialog.cpp.

void K3AboutDialog::setVersion

(

const QString &

name

)

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

Definition at line 1110 of file k3aboutdialog.cpp.

void K3AboutDialog::show

(

void

)

[virtual]

Makes a modeless dialog visible.

If you reimplement this method make sure you run it in the new method (e.g., show()). Reimplemented from KDialog.

Definition at line 1051 of file k3aboutdialog.cpp.

void K3AboutDialog::show

(

QWidget *

centerParent

)

[virtual]

Makes a modeless 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.

Definition at line 1059 of file k3aboutdialog.cpp.

---

Member Data Documentation

K3AboutWidget* K3AboutDialog::mAbout [protected]

The main widget (Constructor I)

Definition at line 524 of file k3aboutdialog.h.

K3AboutContainerBase* K3AboutDialog::mContainerBase [protected]

The main widget (Constructor II)

Definition at line 529 of file k3aboutdialog.h.

---

The documentation for this class was generated from the following files:

• k3aboutdialog.h
• k3aboutdialog.cpp