#include <form.h>

Inheritance diagram for Kross::FormProgressDialog:

Public Slots
void	addText (const QString &text)

int	exec ()

int	exec_loop ()

bool	isCanceled ()

void	setRange (int minimum, int maximum)

void	setText (const QString &text)

void	setValue (int progress)

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
void	canceled ()

Signals inherited from KPageDialog
void	currentPageChanged (KPageWidgetItem current, KPageWidgetItem before)

void	pageRemoved (KPageWidgetItem *page)

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 Member Functions
	FormProgressDialog (const QString &caption, const QString &labelText)

virtual	~FormProgressDialog ()

virtual void	done (int r)

Public Member Functions inherited from KPageDialog
	KPageDialog (QWidget *parent=0, Qt::WindowFlags flags=0)

	~KPageDialog ()

void	addPage (KPageWidgetItem *item)

KPageWidgetItem *	addPage (QWidget *widget, const QString &name)

KPageWidgetItem *	addSubPage (KPageWidgetItem parent, QWidget widget, const QString &name)

void	addSubPage (KPageWidgetItem parent, KPageWidgetItem item)

KPageWidgetItem *	currentPage () const

void	insertPage (KPageWidgetItem before, KPageWidgetItem item)

KPageWidgetItem *	insertPage (KPageWidgetItem before, QWidget widget, const QString &name)

void	removePage (KPageWidgetItem *item)

void	setCurrentPage (KPageWidgetItem *item)

void	setFaceType (FaceType faceType)

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

Additional Inherited Members
Public Types inherited from KPageDialog
enum	FaceType

Public Types inherited from KDialog
enum	ButtonCode

enum	ButtonPopupMode

enum	CaptionFlag

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

Public Attributes inherited from KPageDialog
	Auto

	List

	Plain

	Tabbed

	Tree

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 KPageDialog
	KPageDialog (KPageWidget widget, QWidget parent, Qt::WindowFlags flags=0)

	KPageDialog (KPageDialogPrivate &dd, KPageWidget widget, QWidget parent, Qt::WindowFlags flags=0)

const KPageWidget *	pageWidget () const

KPageWidget *	pageWidget ()

void	setPageWidget (KPageWidget *widget)

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

Protected Attributes inherited from KDialog
KDialogPrivate *const	d_ptr

Detailed Description

The FormProgressDialog class provides access to progressbar.

Example (in Python) :

import time, Kross
forms = Kross.module("forms")
progress = forms.showProgressDialog("My Title")
progress.setText("Some <i>detailed</i> text.")
for i in range(0,101):
    progress.setValue(i)
    progress.addText("%s" % i)
    time.sleep(1)
progress.reset()

Definition at line 155 of file form.h.

Constructor & Destructor Documentation

FormProgressDialog::FormProgressDialog	(	const QString &	caption,
		const QString &	labelText
	)

Definition at line 219 of file form.cpp.

FormProgressDialog::~FormProgressDialog ( )

virtual

Definition at line 256 of file form.cpp.

Member Function Documentation

void FormProgressDialog::addText ( const QString & text )

slot

Add to the HTML-text that is displayed as information the text text .

Definition at line 288 of file form.cpp.

void Kross::FormProgressDialog::canceled ( )

signal

This signal got emitted if the user requests to cancel the operation.

void FormProgressDialog::done ( int r )

virtual

Definition at line 299 of file form.cpp.

int FormProgressDialog::exec ( )

slot

Shows the dialog as a modal dialog, blocking until the user closes it and returns the execution result.

Returns: >=1 if the dialog was accepted (e.g. "Ok" pressed) else the user rejected the dialog (e.g. by pressing "Cancel" or just closing the dialog by pressing the escape-key).

Definition at line 312 of file form.cpp.

int Kross::FormProgressDialog::exec_loop ( )

inlineslot

Same as the exec() method above provided for Python-lovers (python does not like functions named "exec" and PyQt named it "exec_loop", so just let's do the same).

Definition at line 193 of file form.h.

bool FormProgressDialog::isCanceled ( )

slot

Returns true if the user requested to cancel the operation.

Definition at line 321 of file form.cpp.

void FormProgressDialog::setRange	(	int	minimum,
		int	maximum
	)

slot

Set the minimum and maximum range of the progressbar.

Definition at line 277 of file form.cpp.

void FormProgressDialog::setText ( const QString & text )

slot

Set the HTML-text that is displayed as information to the text text .

Definition at line 282 of file form.cpp.

void FormProgressDialog::setValue ( int progress )

slot

Set the value of the progressbar.

If -1 the progressbar will be hidden.

Definition at line 261 of file form.cpp.

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

Kross

Public Slots

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Kross

kdelibs-4.14.7 API Reference