• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KDE3Support

Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
K3AboutDialog Class Reference

#include <k3aboutdialog.h>

Inheritance diagram for K3AboutDialog:
KDialog QDialog K3AboutApplication

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 Types inherited from KDialog
enum  ButtonCode
 
enum  ButtonPopupMode
 
enum  CaptionFlag
 

Public Member Functions

 K3AboutDialog (int dialogLayout, const QString &caption, QWidget *parent=0)
 
 K3AboutDialog (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 QPixmap &pixmap)
 
void setProgramLogo (const QString &fileName)
 
void setTitle (const QString &title)
 
void setVersion (const QString &name)
 
virtual void show ()
 
virtual void show (QWidget *centerParent)
 
- Public Member Functions inherited from KDialog
 KDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
 
 ~KDialog ()
 
KPushButton * button (ButtonCode id) const
 
KIcon buttonIcon (ButtonCode id) const
 
QString buttonText (ButtonCode id) const
 
QString buttonToolTip (ButtonCode id) const
 
QString buttonWhatsThis (ButtonCode id) const
 
ButtonCode defaultButton () const
 
QString helpLinkText () const
 
void incrementInitialSize (const QSize &size)
 
bool isButtonEnabled (ButtonCode id) const
 
QWidget * mainWidget ()
 
virtual QSize minimumSizeHint () const
 
void restoreDialogSize (const KConfigGroup &config)
 
void saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const
 
void setButtonFocus (ButtonCode id)
 
void setButtonGuiItem (ButtonCode id, const KGuiItem &item)
 
void setButtonIcon (ButtonCode id, const KIcon &icon)
 
void setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)
 
void setButtons (ButtonCodes buttonMask)
 
void setButtonsOrientation (Qt::Orientation orientation)
 
void setButtonText (ButtonCode id, const QString &text)
 
void setButtonToolTip (ButtonCode id, const QString &text)
 
void setButtonWhatsThis (ButtonCode id, const QString &text)
 
void setDefaultButton (ButtonCode id)
 
void setEscapeButton (ButtonCode id)
 
void setInitialSize (const QSize &size)
 
void setMainWidget (QWidget *widget)
 
void showButton (ButtonCode id, bool state)
 
void showButtonSeparator (bool state)
 
virtual QSize sizeHint () 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 KDialog
static bool avoidArea (QWidget *widget, const QRect &area, int screen=-1)
 
static void centerOnScreen (QWidget *widget, int screen=-1)
 
static int groupSpacingHint ()
 
static QString makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
 
static int marginHint ()
 
static void resizeLayout (QLayout *lay, int margin, int spacing)
 
static void resizeLayout (QWidget *widget, int margin, int spacing)
 
static void setAllowEmbeddingInGraphicsView (bool allowEmbedding)
 
static int spacingHint ()
 

Protected Attributes

K3AboutWidget * mAbout
 
K3AboutContainerBase * mContainerBase
 
- Protected Attributes inherited from KDialog
KDialogPrivate *const d_ptr
 

Additional Inherited Members

- Public Slots inherited from KDialog
void delayedDestruct ()
 
void enableButton (ButtonCode id, bool state)
 
void enableButtonApply (bool state)
 
void enableButtonCancel (bool state)
 
void enableButtonOk (bool state)
 
void enableLinkedHelp (bool state)
 
bool isDetailsWidgetVisible () const
 
virtual void setCaption (const QString &caption)
 
virtual void setCaption (const QString &caption, bool modified)
 
void setDetailsWidget (QWidget *detailsWidget)
 
void setDetailsWidgetVisible (bool visible)
 
void setHelp (const QString &anchor, const QString &appname=QString())
 
void setHelpLinkText (const QString &text)
 
virtual void setPlainCaption (const QString &caption)
 
- Signals inherited from KDialog
void aboutToShowDetails ()
 
void applyClicked ()
 
void buttonClicked (KDialog::ButtonCode button)
 
void cancelClicked ()
 
void closeClicked ()
 
void defaultClicked ()
 
void finished ()
 
void helpClicked ()
 
void hidden ()
 
void layoutHintChanged ()
 
void noClicked ()
 
void okClicked ()
 
void resetClicked ()
 
void tryClicked ()
 
void user1Clicked ()
 
void user2Clicked ()
 
void user3Clicked ()
 
void yesClicked ()
 
- Public Attributes inherited from KDialog
 Apply
 
 AppNameCaption
 
 Cancel
 
 Close
 
 Default
 
 DelayedPopup
 
 Details
 
 Help
 
 HIGCompliantCaption
 
 InstantPopup
 
 ModifiedCaption
 
 No
 
 NoCaptionFlags
 
 NoDefault
 
 None
 
 Ok
 
 Reset
 
 Try
 
 User1
 
 User2
 
 User3
 
 Yes
 
- Protected Slots inherited from KDialog
virtual void slotButtonClicked (int button)
 
void updateGeometry ()
 
- Protected Member Functions inherited from KDialog
 KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags=0)
 
virtual void closeEvent (QCloseEvent *e)
 
virtual void hideEvent (QHideEvent *)
 
virtual void keyPressEvent (QKeyEvent *)
 

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

◆ LayoutType

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() [1/2]

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() [2/2]

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
dialogLayoutUse a mask of LayoutType flags.
captionThe dialog caption. The text you specify is prepended by i18n("About").
parentParent of the dialog.

Definition at line 1039 of file k3aboutdialog.cpp.

Member Function Documentation

◆ addContainer()

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
childAlignmentSpecifies how the children of the container are aligned with respect to the container.
innerAlignmentSpecifies how the children are aligned with respect to each other.
Returns
The new container.

Definition at line 1155 of file k3aboutdialog.cpp.

◆ addContainerPage()

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
titleTab name.
childAlignmentSpecifies how the children of the container are aligned with respect to the container.
innerAlignmentSpecifies how the children are aligned with respect to each other.
Returns
The new container.

Definition at line 1132 of file k3aboutdialog.cpp.

◆ addContributor()

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.

◆ addLicensePage()

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

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

Parameters
titleTab name.
textThe text to display.
numLinesThe 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.

◆ addPage()

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

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

Parameters
titleTab name
Returns
The new page.

Definition at line 1148 of file k3aboutdialog.cpp.

◆ addScrolledContainerPage()

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
titleTab name.
childAlignmentSpecifies how the children of the container are aligned with respect to the container.
innerAlignmentSpecifies how the children are aligned with respect to each other.
Returns
The new container.

Definition at line 1140 of file k3aboutdialog.cpp.

◆ addTextPage()

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
titleTab name.
textThe text to display.
richTextSet this to true if 'text' is rich text.
numLinesThe 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.

◆ adjust()

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.

◆ imageUrl()

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.

◆ setAuthor()

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.

◆ setImage()

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
fileNamePath to image file.

Definition at line 1169 of file k3aboutdialog.cpp.

◆ setImageBackgroundColor()

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
colorBackground color.

Definition at line 1187 of file k3aboutdialog.cpp.

◆ setImageFrame()

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
stateA value of true enables the frame

Definition at line 1193 of file k3aboutdialog.cpp.

◆ setLogo()

void K3AboutDialog::setLogo ( const QPixmap &  logo)

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

Definition at line 1075 of file k3aboutdialog.cpp.

◆ setMaintainer()

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.

◆ setProduct()

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
appNameThe application name.
versionApplication version.
authorOne or more authors.
yearA string telling when the application was made.

Definition at line 1199 of file k3aboutdialog.cpp.

◆ setProgramLogo() [1/2]

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
pixmapThe logo pixmap.

Definition at line 1181 of file k3aboutdialog.cpp.

◆ setProgramLogo() [2/2]

void K3AboutDialog::setProgramLogo ( const QString &  fileName)

Overloaded version of setProgramLogo(const QPixmap& pixmap).

Definition at line 1175 of file k3aboutdialog.cpp.

◆ setTitle()

void K3AboutDialog::setTitle ( const QString &  title)

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

Parameters
titleTitle string.

Definition at line 1163 of file k3aboutdialog.cpp.

◆ setVersion()

void K3AboutDialog::setVersion ( const QString &  name)

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

Definition at line 1110 of file k3aboutdialog.cpp.

◆ show() [1/2]

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.

◆ show() [2/2]

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
centerParentCenter the dialog with respect to this widget.

Definition at line 1059 of file k3aboutdialog.cpp.

Member Data Documentation

◆ mAbout

K3AboutWidget* K3AboutDialog::mAbout
protected

The main widget (Constructor I)

Definition at line 524 of file k3aboutdialog.h.

◆ mContainerBase

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
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDE3Support

Skip menu "KDE3Support"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal