• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KAssistantDialog Class Reference

This class provides a framework for assistant dialogs. More...

#include <kassistantdialog.h>

Inheritance diagram for KAssistantDialog:

Inheritance graph
[legend]

List of all members.


Public Slots

virtual void back ()
virtual void next ()

Public Member Functions

bool isAppropriate (KPageWidgetItem *page) const
bool isValid (KPageWidgetItem *page) const
 KAssistantDialog (QWidget *parent=0, Qt::WFlags flags=0)
void setAppropriate (KPageWidgetItem *page, bool appropriate)
void setValid (KPageWidgetItem *page, bool enable)
virtual ~KAssistantDialog ()

Protected Member Functions

 KAssistantDialog (KPageWidget *widget, QWidget *parent=0, Qt::WFlags flags=0)
virtual void showEvent (QShowEvent *event)

Detailed Description

This class provides a framework for assistant dialogs.

The use of this class is the same as KWizard in KDE3. You should use the word "assistant" instead of "wizard" both in the source and translatable strings.

An assistant dialog consists of a sequence of pages. Its purpose is to guide the user (assist) through a process step by step. Assistant dialogs are useful for complex or infrequently occurring tasks that people may find difficult to learn or do. Sometimes a task requires too many input fields to fit them on a single dialog.

KAssistantDialog provides page titles and displays Next, Back, Finish, Cancel, and Help push buttons, as appropriate to the current position in the page sequence. The Finish Button has the code KDialog::User1, The Next button is KDialog::User2 and the Back button is KDialog::User3. The help button may be hidden using showButton(KDialog::Help, false)

Create and populate dialog pages that inherit from QWidget and add them to the assistant dialog using addPage().

The functions next() and back() are virtual and may be reimplemented to override the default actions of the next and back buttons.

Author:
Olivier Goffart <ogoffart at kde.org>

Definition at line 52 of file kassistantdialog.h.


Constructor & Destructor Documentation

KAssistantDialog::KAssistantDialog ( QWidget *  parent = 0,
Qt::WFlags  flags = 0 
) [explicit]

Construct a new assistant dialog with parent as parent.

Parameters:
parent is the parent of the widget. the window flags to give to the assistant dialog. The default of zero is usually what you want.

Definition at line 68 of file kassistantdialog.cpp.

KAssistantDialog::~KAssistantDialog (  )  [virtual]

Definition at line 85 of file kassistantdialog.cpp.

KAssistantDialog::KAssistantDialog ( KPageWidget *  widget,
QWidget *  parent = 0,
Qt::WFlags  flags = 0 
) [explicit, protected]

Construct an assistant dialog from a single widget.

Parameters:
widget the widget to construct the dialog with
parent the parent of the assistant dialog the window flags to use when creating the widget. The default of zero is usually fine.
Calls the KPageDialog(KPageWidget *widget, QWidget *parent, Qt::WFlags flags) constructor

Definition at line 78 of file kassistantdialog.cpp.


Member Function Documentation

void KAssistantDialog::back (  )  [virtual, slot]

Called when the user clicks the Back button.

This function will show the preceding relevant page in the sequence. Do nothing if the current page is the first page in the sequence.

Definition at line 110 of file kassistantdialog.cpp.

bool KAssistantDialog::isAppropriate ( KPageWidgetItem *  page  )  const

Check if a page is appropriate for use in the assistant dialog.

Parameters:
page is the page to check the appropriateness of.
Returns:
true if page is appropriate, false if it is not

Definition at line 160 of file kassistantdialog.cpp.

bool KAssistantDialog::isValid ( KPageWidgetItem *  page  )  const

return if a page is valid

See also:
setValid
Parameters:
page the page to check the validity of

Definition at line 131 of file kassistantdialog.cpp.

void KAssistantDialog::next (  )  [virtual, slot]

Called when the user clicks the Next/Finish button.

This function will show the next relevant page in the sequence. If the current page is the last page, it will call accept()

Definition at line 117 of file kassistantdialog.cpp.

void KAssistantDialog::setAppropriate ( KPageWidgetItem *  page,
bool  appropriate 
)

Specify whether a page is appropriate.

A page is considered inappropriate if it should not be shown due to the contents of other pages making it inappropriate.

A page which is inappropriate will not be shown.

The last page in an assistant dialog should always be appropriate

Parameters:
page the page to set as appropriate
appropriate flag indicating the appropriateness of the page. If appropriate is true, then page is appropriate and will be shown in the assistant dialog. If false, page will not be shown.

Definition at line 155 of file kassistantdialog.cpp.

void KAssistantDialog::setValid ( KPageWidgetItem *  page,
bool  enable 
)

Specify if the content of the page is valid, and if the next button may be enabled on this page.

By default all pages are valid.

This will disable or enable the next button on the specified page

Parameters:
page the page on which the next button will be enabled/disable
enable if true the next button will be enabled, if false it will be disabled

Definition at line 124 of file kassistantdialog.cpp.

void KAssistantDialog::showEvent ( QShowEvent *  event  )  [protected, virtual]

Definition at line 149 of file kassistantdialog.cpp.


The documentation for this class was generated from the following files:
  • kassistantdialog.h
  • kassistantdialog.cpp

KDEUI

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal