#include <k3aboutdialog.h>

Inheritance diagram for K3AboutDialog:

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)

Public Member Functions inherited from QDialog
	QDialog (QWidget *parent, QFlags< Qt::WindowType > f)

	QDialog (QWidget parent, const char name, bool modal, QFlags< Qt::WindowType > f)

	~QDialog ()

virtual void	accept ()

void	accepted ()

virtual void	done (int r)

int	exec ()

QWidget *	extension () const

void	finished (int result)

bool	isSizeGripEnabled () const

virtual QSize	minimumSizeHint () const

void	open ()

Qt::Orientation	orientation () const

virtual void	reject ()

void	rejected ()

int	result () const

void	setExtension (QWidget *extension)

void	setModal (bool modal)

void	setOrientation (Qt::Orientation orientation)

void	setResult (int i)

void	setSizeGripEnabled (bool)

virtual void	setVisible (bool visible)

void	showExtension (bool showIt)

virtual QSize	sizeHint () const

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, QFlags< Qt::WindowType > f)

	QWidget (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

QString	caption () const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close (bool alsoDelete)

bool	close ()

QColorGroup	colorGroup () const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

void	erase (int x, int y, int w, int h)

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

QInputContext *	inputContext ()

Qt::InputMethodHints	inputMethodHints () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isDesktop () const

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget (bool sameWindow) const

QWidget *	parentWidget () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint (int x, int y, int w, int h, bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRegion &rgn)

void	repaint (bool b)

void	repaint (const QRect &rect)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setActiveWindow ()

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (int minw, int minh)

void	setMinimumSize (const QSize &)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	numColors () const

virtual QPaintEngine *	paintEngine () const =0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

int	x11Screen () const

void *	x11Visual () const

Static Public Member Functions
static void	imageUrl (QWidget *parent, const QString &caption, const QString &path, const QColor &imageColor, const QString &url)

Static Public Member Functions inherited from QWidget
QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QWidgetMapper *	wmapper ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Public Member Functions inherited from QPaintDevice
int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Protected Attributes
K3AboutWidget *	mAbout

K3AboutContainerBase *	mContainerBase

Additional Inherited Members
Public Attributes inherited from QWidget
typedef	RenderFlags

Protected Member Functions inherited from QDialog
virtual void	closeEvent (QCloseEvent *e)

virtual void	contextMenuEvent (QContextMenuEvent *e)

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject o, QEvent e)

virtual void	keyPressEvent (QKeyEvent *e)

virtual void	resizeEvent (QResizeEvent *)

virtual void	showEvent (QShowEvent *event)

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	changeEvent (QEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual void	paintEvent (QPaintEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

void	resetInputContext ()

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QDialog
	modal

	sizeGripEnabled

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

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.nosp@m.@kde.nosp@m..org) and Espen Sand (espen.nosp@m.sa@o.nosp@m.nline.nosp@m..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:

KDE3Support

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

KDE3Support

kdelibs API Reference

Search