kio Library API Documentation

KIO::StatusbarProgress Class Reference

This is a special IO progress widget. IO progress widget for embedding in a statusbar. More...

#include <statusbarprogress.h>

Inheritance diagram for KIO::StatusbarProgress:

KIO::ProgressBase QWidget List of all members.

Public Slots

virtual void slotClean ()
virtual void slotTotalSize (KIO::Job *, KIO::filesize_t size)
virtual void slotPercent (KIO::Job *, unsigned long percent)
virtual void slotSpeed (KIO::Job *, unsigned long bytes_per_second)

Public Methods

 StatusbarProgress (QWidget *parent, bool button=true)
void setJob (KIO::Job *job)

Protected Methods

virtual void virtual_hook (int id, void *data)

Detailed Description

This is a special IO progress widget. IO progress widget for embedding in a statusbar.

Similarly to DefaultProgress, it's purpose is to show a progress of the IO operation.

Instead of creating a separate window, this is only a widget that can be easily embedded in a statusbar.

Usage of StatusbarProgress is little different. This dialog will be a part of some application.

 // create a dialog
 StatusbarProgress *statusProgress;
 statusProgress = new StatusbarProgress( statusBar() );
 statusBar()->insertWidget( statusProgress, statusProgress->width() , 0 );
 ...
 // create job and connect it to the progress
 CopyJob* job = KIO::copy(...);
 statusProgress->setJob( job );
 ...

Author:
Matej Koss <koss@miesto.sk>

Definition at line 60 of file statusbarprogress.h.


Constructor & Destructor Documentation

KIO::StatusbarProgress::StatusbarProgress QWidget   parent,
bool    button = true
 

Creates a new StatusbarProgress.

Parameters:
parent  the parent of this widget
button  true to add an abort button. The button will be connected to ProgressBase::slotStop()

Definition at line 35 of file statusbarprogress.cpp.

References QWidgetStack::addWidget(), QBoxLayout::addWidget(), QWidget::fontMetrics(), QLabel::setAlignment(), QWidget::setMinimumSize(), KIO::ProgressBase::setOnlyClean(), QWidget::sizeHint(), and KIO::ProgressBase::slotStop().


Member Function Documentation

void KIO::StatusbarProgress::setJob KIO::Job   job
 

Sets the job to monitor.

Parameters:
job  the job to monitor

Reimplemented from KIO::ProgressBase.

Definition at line 74 of file statusbarprogress.cpp.

void KIO::StatusbarProgress::slotClean   [virtual, slot]
 

This method is called when the widget should be cleaned (after job is finished).

redefine this for custom behavior.

Reimplemented from KIO::ProgressBase.

Definition at line 111 of file statusbarprogress.cpp.

References QLabel::clear(), and KProgress::setValue().

void KIO::StatusbarProgress::slotTotalSize KIO::Job  ,
KIO::filesize_t    size
[virtual, slot]
 

Called to set the total size.

Parameters:
job  the KIO::Job
bytes  the total size in bytes

Reimplemented from KIO::ProgressBase.

Definition at line 121 of file statusbarprogress.cpp.

References QWidget::size().

void KIO::StatusbarProgress::slotPercent KIO::Job  ,
unsigned long    percent
[virtual, slot]
 

Called to set the percentage.

Parameters:
job  the KIO::Job
percent  the percentage

Reimplemented from KIO::ProgressBase.

Definition at line 125 of file statusbarprogress.cpp.

References KProgress::setValue().

void KIO::StatusbarProgress::slotSpeed KIO::Job  ,
unsigned long    bytes_per_second
[virtual, slot]
 

Called to set the speed.

Parameters:
job  the KIO::Job
speed  the speed in bytes/second

Reimplemented from KIO::ProgressBase.

Definition at line 130 of file statusbarprogress.cpp.

References QLabel::setText().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kio Library Version 3.2.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Feb 4 12:35:17 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003